{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"a5dc7594-5281-4589-ab9c-59386613cef3","name":"Schofinity API Documentation","description":"Schofinity is a platform that provides scholarship information and assists users in preparing to apply for scholarships through various programs such as Bootcamp, Workshops, and Mentoring.\n\nThe Schofinity platform provides many API products, tools, and resources that enable you to:\n\n- Get comprehensive scholarship information\n- Adding scholarships to favorites\n- Offering scholarships Timeline + Reminder features\n- Displaying scholarships based on categories\n- Filtering scholarships to be displayed when searched\n- Assisting in preparing for scholarships (Bootcamp, Workshops, Mentoring)\n    \n\n## **Getting started guide**\n\nTo start using this API you need to register as user first, then you need to activate your account using otp that sent to your email. After registering, you need to authenticate yourself using your username and password. You will receive a bearer token which you must include in every request in your request header.\n\n- You must use a valid bearer token to send requests to this API.\n- The API returns request responses in JSON format. When an API request returns an error, it is sent in the JSON response as an error.\n    \n\n## Authentication\n\nThe Schofinity API uses JWT bearer token for authentication.\n\nYou can get your JWT bearer token by authenticate your account using username and password in Auth section.\n\n### Authentication error response\n\nIf an API key is missing, malformed, or invalid, you will receive an HTTP 401 Unauthorized response code.\n\n## Request Query\n\nYou can include **limit**, **page**, and **sort** for every get request in this API. Limit is used to limit the data shown in response. Page is used with limit for pagination purposes. Sort is used to sort the response in specific column order.\n\ne.g., `/endpoints?limit=10` will only show 10 data in the response. `/endpoints?limit=10&page=2` will show next 10 data in the response. `/endpoints?sort=createdAt` will sort by column createdAt in ascending order. If you want to sort in descending order, you need to add dash before the column (`/endpoints?sort=-createdAt`).\n\nAll **request query** are **optional**.\n\n## Request Params\n\nRequest params is used to access specific data, mostly used when make a request to a user, scholarship, class, resources, or comment by its id. All **request params** are **mandatory**, otherwise it may call other endpoint.\n\ne.g., `/endpoints/:id`, if request params aren't inserted properly, it may trigger another regular endpoints, like `/endpoints`.\n\n## Request Body\n\nAll request field in body are using string. All mandatory fields are explained in the endpoints description. **Most of the** post **field** provided in the body **are mandatory**.\n\n**Image field** are not included in this API documentations. You may include image field when using post or patch request to `/users`, `/scholarships`, `/classes`, and `/classes/:id/resources`. Only .jpeg or .jpg file is accepted. You can only upload **one image** file. This field is **not mandatory**.\n\n## Foreign Key References\n\nThere are few foreign key you can use to post or filter scholarships, online classes, class resources, users, etc. Pay attention to each of these categories descriptions.\n\n### Categories\n\nThere are 6 categories available you can use to search or upload a scholarship. If you You need to **specify its id** based on the list below.\n\n1. Unggulan\n2. Prestasi Akademik\n3. Prestasi Non-Akademik\n4. Mahasiswa Kurang Mampu\n5. Mahasiswa Difabel\n6. Putra-putri Daerah\n    \n\n### Funding Types\n\nThere are 2 available funding types you can use to represent a scholarship. You need to **specify its id** based on the list below.\n\n1. Pemerintah\n2. Swasta\n    \n\n### Locations\n\nThere are 3 available locations you can use to represent a scholarship. You need to **specify its id** based on the list below.\n\n1. Dalam Negeri\n2. Luar Negeri\n    \n\n### Class Types\n\nThere are 2 types of class available to use. You need to **specify its id** based on the list below.\n\n1. Workshop\n2. Bootcamp\n    \n\n### Subjects\n\nThere are 3 subjects available you can use to search or upload a class (workshop or bootcamp). You need to **specify its id** based on the list below.\n\n1. Toefl\n2. Wawancara\n3. Essay\n    \n\n### Roles\n\nThere are 3 roles available for user to use. You need to **specify its id** based on the list below. To create an user with administrator privilege, you need to configure roleId manually in the database. If you already have user with administrator privilege, you can also promote regular user using `/users/:userId/admin` endpoint.\n\n1. User\n2. Mentor\n3. Admin\n    \n\n### Genders\n\nThere are 3 gender available for user to use. This list is using enum and case sensitive. You need to **use its gender**, not its id.\n\n1. male\n2. female\n3. else\n    \n\n### Statuses\n\nThere are 3 statuses to represent scholarship status, user status, and payment status. This list of **statuses isn't accessible** for patch or post request.\n\n1. Pending\n2. Success\n3. Failed","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"32730747","team":6104171,"collectionId":"a5dc7594-5281-4589-ab9c-59386613cef3","publishedId":"2sA35A8RHC","public":true,"publicUrl":"https://documenter-api.postman.tech/view/32730747/2sA35A8RHC","privateUrl":"https://go.postman.co/documentation/32730747-a5dc7594-5281-4589-ab9c-59386613cef3","customColor":{"top-bar":"ece2ff","right-sidebar":"B989FF","highlight":"5825bb"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"Schofinity is a platform that provides scholarship information and assists users in preparing to apply for scholarships through various programs such as Bootcamp, Workshops, and Mentoring."},{"name":"title","value":"Schofinity API Documentations"}],"appearance":{"default":"system_default","themes":[{"name":"dark","logo":"https://content.pstmn.io/43232f60-f869-4b41-a871-24fee9f403af/U2NyZWVuc2hvdF8yMDI0LTAzLTIyXzE5MDQwMy1yZW1vdmViZy1wcmV2aWV3LnBuZw==","colors":{"top-bar":"5825BB","right-sidebar":"303030","highlight":"B989FF"}},{"name":"light","logo":"https://content.pstmn.io/17935419-c488-4970-a6ce-b3c8726d87cd/U2NyZWVuc2hvdF8yMDI0LTAzLTIyXzE5MDQwMy1yZW1vdmViZy1wcmV2aWV3LnBuZw==","colors":{"top-bar":"ece2ff","right-sidebar":"B989FF","highlight":"5825bb"}}]}},"version":"8.10.0","publishDate":"2024-03-22T13:08:01.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"Schofinity API Documentations","description":"Schofinity is a platform that provides scholarship information and assists users in preparing to apply for scholarships through various programs such as Bootcamp, Workshops, and Mentoring."},"logos":{"logoLight":"https://content.pstmn.io/17935419-c488-4970-a6ce-b3c8726d87cd/U2NyZWVuc2hvdF8yMDI0LTAzLTIyXzE5MDQwMy1yZW1vdmViZy1wcmV2aWV3LnBuZw==","logoDark":"https://content.pstmn.io/43232f60-f869-4b41-a871-24fee9f403af/U2NyZWVuc2hvdF8yMDI0LTAzLTIyXzE5MDQwMy1yZW1vdmViZy1wcmV2aWV3LnBuZw=="}},"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/0c615a3201078f8ff6b435c7c36a2bc662c08fdfd5bd1b7f4fc933c022c13d51","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/2sA35A8RHC"}