{"info":{"_postman_id":"a097b00d-aa1e-4a34-a7ff-dec2cf223144","name":"ScholarX platfrom API documentation","description":"<html><head></head><body><h1 id=\"introduction\">Introduction</h1>\n<p>These are the endpoints that available for ScholarX platfrom</p>\n<h1 id=\"overview\">Overview</h1>\n<p>All the APIs are categorized under five main rolse.</p>\n<ul>\n<li>Admin</li>\n<li>Common</li>\n<li>User</li>\n<li>Mentor</li>\n<li>Mentee</li>\n</ul>\n<h1 id=\"authentication\">Authentication</h1>\n<p>What is the preferred way of using the API?</p>\n<h1 id=\"error-codes\">Error Codes</h1>\n<ul>\n<li>200 - OK</li>\n<li>201 - Created</li>\n<li>400 - Bad Request</li>\n<li>404 - Not Found</li>\n<li>500 - Internal Server Error</li>\n</ul>\n<h1 id=\"rate-limit\">Rate limit</h1>\n<p>Is there a limit to the number of requests an user can send?</p>\n</body></html>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Introduction","slug":"introduction"},{"content":"Overview","slug":"overview"},{"content":"Authentication","slug":"authentication"},{"content":"Error Codes","slug":"error-codes"},{"content":"Rate limit","slug":"rate-limit"}],"owner":"8545501","collectionId":"a097b00d-aa1e-4a34-a7ff-dec2cf223144","publishedId":"T1LLFTrx","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2020-08-11T15:24:12.000Z"},"item":[{"name":"Admin","item":[{"name":"Delete a program","id":"18508655-0b56-497e-95b5-d60d906b7db9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"/admin/programs/{id}\n","description":"<p>The purpose of this endpoint is to delete a given program using it's id</p>\n","urlObject":{"path":["admin","programs","{id}\n"],"query":[],"variable":[]}},"response":[],"_postman_id":"18508655-0b56-497e-95b5-d60d906b7db9"},{"name":"Change lifecycle status of a program","id":"3de97ca7-a97f-48d7-955c-f9ca86ca67d0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"/admin/programs/{id}/status","description":"<p>The purpose of this endpoint is to change the lifecycle status of a given program</p>\n","urlObject":{"path":["admin","programs","{id}","status"],"query":[],"variable":[]}},"response":[],"_postman_id":"3de97ca7-a97f-48d7-955c-f9ca86ca67d0"},{"name":"Change mentor status","id":"c62ff4a1-ce92-4b46-b7e3-de2ae77595d8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"/admin/mentors/{id}/status","description":"<p>The purpose of this endpoint to change the status of a given mentor (APPROVED, REJECTED, REMOVED)</p>\n","urlObject":{"path":["admin","mentors","{id}","status"],"query":[],"variable":[]}},"response":[],"_postman_id":"c62ff4a1-ce92-4b46-b7e3-de2ae77595d8"},{"name":"Get all the mentors for a given program","id":"045b12ed-9936-40c0-8c5c-86d0b88425a7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/admin/programs/{id}/mentees","description":"<p>The purpose of this endpoint it to get all the mentors for a given program</p>\n","urlObject":{"path":["admin","programs","{id}","mentees"],"query":[],"variable":[]}},"response":[],"_postman_id":"045b12ed-9936-40c0-8c5c-86d0b88425a7"},{"name":"Remove a mentee","id":"cccd353a-2fc1-433b-b20a-166e603207b4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"/admin/mentees/{id} ","description":"<p>The purpose of this endpoint is to remove a mentee</p>\n","urlObject":{"path":["admin","mentees","{id} "],"query":[],"variable":[]}},"response":[],"_postman_id":"cccd353a-2fc1-433b-b20a-166e603207b4"},{"name":"Add a program","id":"83244ed3-c34e-48f1-b81e-22c24910a351","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"/admin/program","urlObject":{"path":["admin","program"],"query":[],"variable":[]}},"response":[],"_postman_id":"83244ed3-c34e-48f1-b81e-22c24910a351"}],"id":"1e661fe3-cc21-4b7c-a804-f28072a64271","description":"<p>These are the APIs that available for the admin.</p>\n","event":[{"listen":"prerequest","script":{"id":"c1998506-b89e-4b46-95eb-22d8fd93ef65","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ffabf115-3115-4b4c-a8b1-e74a69800950","type":"text/javascript","exec":[""]}}],"_postman_id":"1e661fe3-cc21-4b7c-a804-f28072a64271"},{"name":"Common","item":[{"name":"Get programs","id":"4c904811-0a86-468c-b844-09266d9c373d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/programs","urlObject":{"path":["programs"],"query":[],"variable":[]}},"response":[],"_postman_id":"4c904811-0a86-468c-b844-09266d9c373d"},{"name":"Get a specific program","id":"667d4e91-0c20-43b9-a86b-620ae8999000","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/programs/{id}","urlObject":{"path":["programs","{id}"],"query":[],"variable":[]}},"response":[],"_postman_id":"667d4e91-0c20-43b9-a86b-620ae8999000"},{"name":"Get all the mentors for a given program","id":"150365fe-de33-4e24-9ef1-f797cc18fb10","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/programs/{id}/mentors","description":"<p>The purpose of this endpoint is to get all the mentors that available for a given program</p>\n","urlObject":{"path":["programs","{id}","mentors"],"query":[],"variable":[]}},"response":[],"_postman_id":"150365fe-de33-4e24-9ef1-f797cc18fb10"}],"id":"69a87b66-f065-4296-b895-2b1f6bc8dceb","_postman_id":"69a87b66-f065-4296-b895-2b1f6bc8dceb","description":""},{"name":"User","item":[{"name":"Apply as a mentor","id":"21a17d15-2193-4fcc-8748-94ae5869c372","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n    \"submissionUrl\": \"submissionUrl\"\n}","options":{"raw":{"language":"json"}}},"url":"/program/{id}/mentor","description":"<p>Using this endpoint a user can apply as a mentor for a given program</p>\n","urlObject":{"path":["program","{id}","mentor"],"query":[],"variable":[]}},"response":[],"_postman_id":"21a17d15-2193-4fcc-8748-94ae5869c372"},{"name":"Apply as a mentee","id":"574343a4-8d10-4876-8dfd-bf656efe37ff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"/mentor/{id}/mentee","description":"<p>Using this endpoint a user can apply as a mentee for a given program</p>\n","urlObject":{"path":["mentor","{id}","mentee"],"query":[],"variable":[]}},"response":[],"_postman_id":"574343a4-8d10-4876-8dfd-bf656efe37ff"}],"id":"b533ab25-e390-4d9e-a4c4-d17047ec0d59","_postman_id":"b533ab25-e390-4d9e-a4c4-d17047ec0d59","description":""},{"name":"Mentor","item":[{"name":"Get all the mentees applied under the mentor","id":"f9ff3fa7-8a66-4fc4-8f26-d88e889837f6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"program/{programId}/mentor/mentees","urlObject":{"path":["{programId}","mentor","mentees"],"host":["program"],"query":[],"variable":[]}},"response":[],"_postman_id":"f9ff3fa7-8a66-4fc4-8f26-d88e889837f6"},{"name":"Edit mentor application","id":"bfcbbb87-cc91-4d19-b743-693371f905c2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"program/{programId}/mentor/questionnaire","urlObject":{"path":["{programId}","mentor","questionnaire"],"host":["program"],"query":[],"variable":[]}},"response":[],"_postman_id":"bfcbbb87-cc91-4d19-b743-693371f905c2"},{"name":"Approve/ Reject mentee","id":"377e9e2f-1e6f-4ab2-b95e-1035b653573d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"program/{programId}/mentees/{menteeId}/status","urlObject":{"path":["{programId}","mentees","{menteeId}","status"],"host":["program"],"query":[],"variable":[]}},"response":[],"_postman_id":"377e9e2f-1e6f-4ab2-b95e-1035b653573d"}],"id":"10606c9d-d168-4354-92db-f0da417c859d","description":"<p>These are the API endpoints that available for a mentor</p>\n","event":[{"listen":"prerequest","script":{"id":"30f909cb-94c1-42d9-9e7b-cb56c2523503","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"5f55e922-5ec9-4d04-a71a-6b71c00c0cd0","type":"text/javascript","exec":[""]}}],"_postman_id":"10606c9d-d168-4354-92db-f0da417c859d"},{"name":"Mentee","item":[{"name":"Get applied mentors","id":"e116ce69-5fa2-47c5-a33e-28ffc8f3bf63","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/me/program/{id}/mentors","urlObject":{"path":["me","program","{id}","mentors"],"query":[],"variable":[]}},"response":[],"_postman_id":"e116ce69-5fa2-47c5-a33e-28ffc8f3bf63"},{"name":"Apply for mentors","id":"fcb3d7df-7d88-4e4c-8a13-d5ed8ace591f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"/mentee/mentors","urlObject":{"path":["mentee","mentors"],"query":[],"variable":[]}},"response":[],"_postman_id":"fcb3d7df-7d88-4e4c-8a13-d5ed8ace591f"},{"name":"Edit mentee application","id":"dec99bfb-5ed0-46fe-a961-35a24a783b20","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"/mentee/{id}/application","urlObject":{"path":["mentee","{id}","application"],"query":[],"variable":[]}},"response":[],"_postman_id":"dec99bfb-5ed0-46fe-a961-35a24a783b20"},{"name":"Get the selected mentor for the mentee","id":"28a47500-90df-49ee-a761-d368a59ebedf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/mentee/mentor","urlObject":{"path":["mentee","mentor"],"query":[],"variable":[]}},"response":[],"_postman_id":"28a47500-90df-49ee-a761-d368a59ebedf"}],"id":"b2a5a86d-1b25-4d92-a16e-dad5469363f9","description":"<p>These are the API endpoints that available for a mentee.</p>\n","event":[{"listen":"prerequest","script":{"id":"e13c593c-dd76-4ec0-9e86-54ca89234a76","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"1408af35-28d7-4bb2-9a77-2a199439e1c6","type":"text/javascript","exec":[""]}}],"_postman_id":"b2a5a86d-1b25-4d92-a16e-dad5469363f9"}],"event":[{"listen":"prerequest","script":{"id":"6311c5b1-6d45-460d-9af8-591738bb5289","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"477a04e8-2a6c-4d9e-a394-f639f650b30a","type":"text/javascript","exec":[""]}}]}