{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"2debd32c-26c3-43fe-a709-f049433a126f","name":"Sersow","description":"\n\n

Sersow API Documentation

\n\nThe API documentation for Sersow application serves as a private resource exclusively accessible to developers and mentors, offering detailed insights and instructions on integrating and leveraging the application's features and functionalities.\n\n## NOTES\n\n### Error Condition\n\n- **Middlewares**\n \n\nThis Middlewares error condition applies to all requests\n\n1\\. If a request does not match the API version provided\n\nError Type: api-version\n\n``` json\n{\n \"status\": 410,\n \"message\": \"Gone, Something wrong with the version of API\",\n \"err\": {\n \"type\": \"api-version\",\n \"data\": {\n \"code\": -1\n }\n }\n}\n\n```\n\n- **Token Authorization**\n \n\nThis Token Authorization error condition is intended for every request that is required to use the Authorization header. \nError Type: token\n\n1\\. It checks the presence of an authorization token in the request headers. If the token is missing, it returns a 401 Unauthorized response with the message \"Request Unauthorized\" and an error code of -1.\n\n``` json\n{\n \"status\": 401,\n \"message\": \"Request Unauthorized\",\n \"err\": {\n \"type\": \"token\",\n \"data\": {\n \"code\": -1\n }\n }\n}\n\n```\n\n2\\. If the token is present, it verifies the token using a JWT library. If there is an error during verification, it returns a 401 Unauthorized response with the message \"Token Unauthorized\" and an error code of -2.\n\n``` json\n{\n \"status\": 401,\n \"message\": \"Token Unauthorized\",\n \"err\": {\n \"type\": \"token\",\n \"data\": {\n \"code\": -2\n }\n }\n}\n\n```\n\n3\\. If the token is Expired it returns a 401 Unauthorized response with the message \"Token Expired\" and an error code of -3.\n\n``` json\n{\n \"status\": 401,\n \"message\": \"Token Expired\",\n \"err\": {\n \"type\": \"token\",\n \"data\": {\n \"code\": -3\n }\n }\n}\n\n```\n\n4\\. If the URL ends with \"valid-code\" or \"resend-code,\" it checks if the \"notVerified\" property in the token's data is not true. If it is not true, it returns a 401 Unauthorized response with the message \"User in Token is Already Verified\" and an error code of -4.\n\n``` json\n{\n \"status\": 401,\n \"message\": \"User in Token is Already Verified\",\n \"err\": {\n \"type\": \"token\",\n \"data\": {\n \"code\": -4\n }\n }\n}\n\n```\n\n5\\. If the URL does not end with \"valid-code\" or \"resend-code,\" it checks if the \"notVerified\" property in the token's data is true. If it is true, it returns a 401 Unauthorized response with the message \"User in Token is Not Verified\" and an error code of -5.\n\n``` json\n{\n \"status\": 401,\n \"message\": \"User in Token is Not Verified\",\n \"err\": {\n \"type\": \"token\",\n \"data\": {\n \"code\": -5\n }\n }\n}\n\n```\n\n- **Validator**\n \n\nThis Validator error condition applies to every request that contains a json body.\n\nError Type: validator\n\n``` json\n{\n \"status\": 400,\n \"message\": \"{Message of AJV Error}\",\n \"err\": {\n \"type\": \"validator\",\n \"data\": {\n \"instancePath\": \"/{}\",\n \"schemaPath\": \"#/{}/{}/{}\",\n \"keyword\": \"{}\",\n \"params\": {\n \"pattern\": \"^{}$\"\n },\n \"message\": \"must match pattern \\\"{}$\\\"\"\n }\n }\n}\n\n```","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"23736615","team":5181078,"collectionId":"2debd32c-26c3-43fe-a709-f049433a126f","publishedId":"2s93XsX6GE","public":true,"publicUrl":"https://documenter-api.postman.tech/view/23736615/2s93XsX6GE","privateUrl":"https://go.postman.co/documentation/23736615-2debd32c-26c3-43fe-a709-f049433a126f","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"The API documentation for Sersow application serves as a private resource exclusively accessible to developers and mentors, offering detailed insights and instructions on integrating and leveraging the application's features and functionalities."},{"name":"title","value":"Sersow API Documentation v1.0"}],"appearance":{"default":"dark","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2023-05-26T10:40:12.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"Sersow API Documentation v1.0","description":"The API documentation for Sersow application serves as a private resource exclusively accessible to developers and mentors, offering detailed insights and instructions on integrating and leveraging the application's features and functionalities."},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/c14e6343b44009780914d167f60f53ce08f7946876b1d71149fa94c67eec75e6","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2s93XsX6GE"}