{ "info": { "_postman_id": "23826387-7080-4c4e-a199-b6f8497072e9", "name": "OpenApply API with Postman (v3)", "description": "This API set orchestrates the OpenApply School Administration Management System.
Requests are limited to one request per second. Each IP address is allowed up to 5k requests per day.\n\nContact Support:\n Name: Faria Education Group Limited.\n Email: hello@openapply.com", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "_exporter_id": "25179203" }, "item": [ { "name": "Student", "item": [ { "name": "Retrieve all students", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/students", "host": [ "{{baseUrl}}" ], "path": [ "students" ], "query": [ { "key": "modified_since", "value": "YYYY/mm/dd", "description": "Returns results updated since the specified date or date/time, e.g. 2013-09-23 or 2013-09-25 02:10:39.", "disabled": true }, { "key": "status", "value": "enrolled", "description": "One of enrolled, withdrawn, graduated", "disabled": true }, { "key": "deleted_since", "value": "YYYY/mm/dd", "description": "A timestamp to filter the deletion date of results.", "disabled": true }, { "key": "page", "value": "", "description": "The page to return (pagination)", "disabled": true }, { "key": "since_id", "value": "", "description": "Specifies the number of students to retrieve, up to a maximum of 1000.", "disabled": true }, { "key": "per_page", "value": "", "disabled": true } ] }, "description": "This endpoint returns up to 1000 student records sorted by ID (default, 100 records). The response includes the list of parent/guardians associated with each student. A query with no matches returns an empty JSON array." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/students?count=&since_id=&since_date=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "students" ], "query": [ { "key": "count", "value": "" }, { "key": "since_id", "value": "" }, { "key": "since_date", "value": "" } ], "variable": [ { "key": "subdomain", "value": "{{subdomain}}" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"students\": [\n {\n \"id\": \"\",\n \"serial_number\": \"\",\n \"custom_id\": \"\",\n \"applicant_id\": \"\",\n \"email\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"name\": \"\",\n \"other_name\": \"\",\n \"preferred_name\": \"\",\n \"birth_date\": \"\",\n \"gender\": \"\",\n \"enrollment_year\": \"\",\n \"full_address\": \"\",\n \"address\": \"\",\n \"address_ii\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\",\n \"grade\": \"\",\n \"campus\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"status\": \"\",\n \"status_level\": \"\",\n \"status_changed_at\": \"\",\n \"managebac_student_id\": \"\",\n \"applied_at\": \"\",\n \"enrolled_at\": \"\",\n \"inquired_at\": \"\",\n \"sibling_ids\": [\n \"\",\n \"\"\n ],\n \"updated_at\": \"\",\n \"nationality\": \"\",\n \"student_id\": \"\",\n \"passport_id\": \"\",\n \"profile_photo\": \"\",\n \"profile_photo_updated_at\": \"\",\n \"checklist_state\": \"\",\n \"inquired_date\": \"\",\n \"applied_date\": \"\",\n \"admitted_date\": \"\",\n \"wait_listed_date\": \"\",\n \"declined_date\": \"\",\n \"enrolled_date\": \"\",\n \"withdrawn_date\": \"\",\n \"graduated_date\": \"\",\n \"representative\": \"\",\n \"custom_fields\": {\n \"any\": \"\"\n },\n \"parent_ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"id\": \"\",\n \"serial_number\": \"\",\n \"custom_id\": \"\",\n \"applicant_id\": \"\",\n \"email\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"name\": \"\",\n \"other_name\": \"\",\n \"preferred_name\": \"\",\n \"birth_date\": \"\",\n \"gender\": \"\",\n \"enrollment_year\": \"\",\n \"full_address\": \"\",\n \"address\": \"\",\n \"address_ii\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\",\n \"grade\": \"\",\n \"campus\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"status\": \"\",\n \"status_level\": \"\",\n \"status_changed_at\": \"\",\n \"managebac_student_id\": \"\",\n \"applied_at\": \"\",\n \"enrolled_at\": \"\",\n \"inquired_at\": \"\",\n \"sibling_ids\": [\n \"\",\n \"\"\n ],\n \"updated_at\": \"\",\n \"nationality\": \"\",\n \"student_id\": \"\",\n \"passport_id\": \"\",\n \"profile_photo\": \"\",\n \"profile_photo_updated_at\": \"\",\n \"checklist_state\": \"\",\n \"inquired_date\": \"\",\n \"applied_date\": \"\",\n \"admitted_date\": \"\",\n \"wait_listed_date\": \"\",\n \"declined_date\": \"\",\n \"enrolled_date\": \"\",\n \"withdrawn_date\": \"\",\n \"graduated_date\": \"\",\n \"representative\": \"\",\n \"custom_fields\": {\n \"any\": \"\"\n },\n \"parent_ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"linked\": {\n \"parents\": {\n \"id\": \"\",\n \"email\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"other_name\": \"\",\n \"preferred_name\": \"\",\n \"parent_id\": \"\",\n \"phone\": \"\",\n \"mobile_phone\": \"\",\n \"address\": \"\",\n \"address_ii\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\"\n }\n },\n \"meta\": {\n \"pages\": \"\",\n \"per_page\": \"\"\n }\n}" }, { "name": "Not authorized", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/students?count=&since_id=&since_date=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "students" ], "query": [ { "key": "count", "value": "" }, { "key": "since_id", "value": "" }, { "key": "since_date", "value": "" } ], "variable": [ { "key": "subdomain", "value": "{{subdomain}}" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": \"\"\n}" } ] }, { "name": "Retrieve student by ID", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/students/:id", "host": [ "{{baseUrl}}" ], "path": [ "students", ":id" ], "variable": [ { "key": "id", "value": "", "description": "(Required) The unique ID of the required student." } ] }, "description": "This endpoint returns a single student as specified by ID with any custom fields defined." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/students/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "students", ":id" ], "variable": [ { "key": "subdomain", "value": "{{subdomain}}" }, { "key": "id", "value": "", "description": "(Required) The unique ID of the required student." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"student\": {\n \"id\": \"\",\n \"serial_number\": \"\",\n \"custom_id\": \"\",\n \"applicant_id\": \"\",\n \"email\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"name\": \"\",\n \"other_name\": \"\",\n \"preferred_name\": \"\",\n \"birth_date\": \"\",\n \"gender\": \"\",\n \"enrollment_year\": \"\",\n \"full_address\": \"\",\n \"address\": \"\",\n \"address_ii\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\",\n \"grade\": \"\",\n \"campus\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"status\": \"\",\n \"status_level\": \"\",\n \"status_changed_at\": \"\",\n \"managebac_student_id\": \"\",\n \"applied_at\": \"\",\n \"enrolled_at\": \"\",\n \"inquired_at\": \"\",\n \"sibling_ids\": [\n \"\",\n \"\"\n ],\n \"updated_at\": \"\",\n \"nationality\": \"\",\n \"student_id\": \"\",\n \"passport_id\": \"\",\n \"profile_photo\": \"\",\n \"profile_photo_updated_at\": \"\",\n \"checklist_state\": \"\",\n \"inquired_date\": \"\",\n \"applied_date\": \"\",\n \"admitted_date\": \"\",\n \"wait_listed_date\": \"\",\n \"declined_date\": \"\",\n \"enrolled_date\": \"\",\n \"withdrawn_date\": \"\",\n \"graduated_date\": \"\",\n \"representative\": \"\",\n \"custom_fields\": {\n \"any\": \"\"\n },\n \"parent_ids\": [\n \"\",\n \"\"\n ]\n }\n}" }, { "name": "Not authorized", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/students/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "students", ":id" ], "variable": [ { "key": "subdomain", "value": "{{subdomain}}" }, { "key": "id", "value": "", "description": "(Required) The unique ID of the required student." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": \"\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/students/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "students", ":id" ], "variable": [ { "key": "subdomain", "value": "{{subdomain}}" }, { "key": "id", "value": "", "description": "(Required) The unique ID of the required student." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": \"\"\n}" } ] }, { "name": "Update a student", "request": { "method": "PATCH", "header": [], "body": { "mode": "raw", "raw": "{\n \"student\": {\n \"status\": \"withdrawn\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/students/:id?student[first_name]=Jameson", "host": [ "{{baseUrl}}" ], "path": [ "students", ":id" ], "query": [ { "key": "student[email]", "value": "", "disabled": true }, { "key": "student[first_name]", "value": "Jameson" }, { "key": "student[last_name]", "value": "", "disabled": true }, { "key": "student[other_name]", "value": "", "disabled": true }, { "key": "student[preferred_name]", "value": "", "disabled": true }, { "key": "student[birth_date]", "value": "", "disabled": true }, { "key": "student[student_id]", "value": "", "disabled": true }, { "key": "student[enrollment_year]", "value": "", "disabled": true }, { "key": "student[address]", "value": "", "disabled": true }, { "key": "student[address_ii]", "value": "", "disabled": true }, { "key": "student[city]", "value": "", "disabled": true }, { "key": "student[state]", "value": "", "disabled": true }, { "key": "student[postal_code]", "value": "", "disabled": true } ], "variable": [ { "key": "id", "value": "83570", "description": "(Required) The unique ID of the required student." } ] }, "description": "This endpoint updates a student’s records as specified by ID. As this is a PATCH request, only the fields provided will be updated, and others will not be modified. Note that the id required here is OpenApply's internal ID.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "PATCH", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/students/:id?student[email]=&student[first_name]=&student[last_name]=&student[other_name]=&student[preferred_name]=&student[birth_date]=&student[student_id]=&student[enrollment_year]=&student[address]=&student[address_ii]=&student[city]=&student[state]=&student[postal_code]=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "students", ":id" ], "query": [ { "key": "student[email]", "value": "" }, { "key": "student[first_name]", "value": "" }, { "key": "student[last_name]", "value": "" }, { "key": "student[other_name]", "value": "" }, { "key": "student[preferred_name]", "value": "" }, { "key": "student[birth_date]", "value": "" }, { "key": "student[student_id]", "value": "" }, { "key": "student[enrollment_year]", "value": "" }, { "key": "student[address]", "value": "" }, { "key": "student[address_ii]", "value": "" }, { "key": "student[city]", "value": "" }, { "key": "student[state]", "value": "" }, { "key": "student[postal_code]", "value": "" } ], "variable": [ { "key": "subdomain", "value": "{{subdomain}}" }, { "key": "id", "value": "", "description": "(Required) The unique ID of the required student." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"student\": {\n \"id\": \"\",\n \"serial_number\": \"\",\n \"custom_id\": \"\",\n \"applicant_id\": \"\",\n \"email\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"name\": \"\",\n \"other_name\": \"\",\n \"preferred_name\": \"\",\n \"birth_date\": \"\",\n \"gender\": \"\",\n \"enrollment_year\": \"\",\n \"full_address\": \"\",\n \"address\": \"\",\n \"address_ii\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\",\n \"grade\": \"\",\n \"campus\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"status\": \"\",\n \"status_level\": \"\",\n \"status_changed_at\": \"\",\n \"managebac_student_id\": \"\",\n \"applied_at\": \"\",\n \"enrolled_at\": \"\",\n \"inquired_at\": \"\",\n \"sibling_ids\": [\n \"\",\n \"\"\n ],\n \"updated_at\": \"\",\n \"nationality\": \"\",\n \"student_id\": \"\",\n \"passport_id\": \"\",\n \"profile_photo\": \"\",\n \"profile_photo_updated_at\": \"\",\n \"checklist_state\": \"\",\n \"inquired_date\": \"\",\n \"applied_date\": \"\",\n \"admitted_date\": \"\",\n \"wait_listed_date\": \"\",\n \"declined_date\": \"\",\n \"enrolled_date\": \"\",\n \"withdrawn_date\": \"\",\n \"graduated_date\": \"\",\n \"representative\": \"\",\n \"custom_fields\": {\n \"any\": \"\"\n },\n \"parent_ids\": [\n \"\",\n \"\"\n ]\n }\n}" }, { "name": "Bad request", "originalRequest": { "method": "PATCH", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/students/:id?student[email]=&student[first_name]=&student[last_name]=&student[other_name]=&student[preferred_name]=&student[birth_date]=&student[student_id]=&student[enrollment_year]=&student[address]=&student[address_ii]=&student[city]=&student[state]=&student[postal_code]=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "students", ":id" ], "query": [ { "key": "student[email]", "value": "" }, { "key": "student[first_name]", "value": "" }, { "key": "student[last_name]", "value": "" }, { "key": "student[other_name]", "value": "" }, { "key": "student[preferred_name]", "value": "" }, { "key": "student[birth_date]", "value": "" }, { "key": "student[student_id]", "value": "" }, { "key": "student[enrollment_year]", "value": "" }, { "key": "student[address]", "value": "" }, { "key": "student[address_ii]", "value": "" }, { "key": "student[city]", "value": "" }, { "key": "student[state]", "value": "" }, { "key": "student[postal_code]", "value": "" } ], "variable": [ { "key": "subdomain", "value": "{{subdomain}}" }, { "key": "id", "value": "", "description": "(Required) The unique ID of the required student." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": \"\"\n}" }, { "name": "Not authorized", "originalRequest": { "method": "PATCH", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/students/:id?student[email]=&student[first_name]=&student[last_name]=&student[other_name]=&student[preferred_name]=&student[birth_date]=&student[student_id]=&student[enrollment_year]=&student[address]=&student[address_ii]=&student[city]=&student[state]=&student[postal_code]=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "students", ":id" ], "query": [ { "key": "student[email]", "value": "" }, { "key": "student[first_name]", "value": "" }, { "key": "student[last_name]", "value": "" }, { "key": "student[other_name]", "value": "" }, { "key": "student[preferred_name]", "value": "" }, { "key": "student[birth_date]", "value": "" }, { "key": "student[student_id]", "value": "" }, { "key": "student[enrollment_year]", "value": "" }, { "key": "student[address]", "value": "" }, { "key": "student[address_ii]", "value": "" }, { "key": "student[city]", "value": "" }, { "key": "student[state]", "value": "" }, { "key": "student[postal_code]", "value": "" } ], "variable": [ { "key": "subdomain", "value": "{{subdomain}}" }, { "key": "id", "value": "", "description": "(Required) The unique ID of the required student." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": \"\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "PATCH", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/students/:id?student[email]=&student[first_name]=&student[last_name]=&student[other_name]=&student[preferred_name]=&student[birth_date]=&student[student_id]=&student[enrollment_year]=&student[address]=&student[address_ii]=&student[city]=&student[state]=&student[postal_code]=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "students", ":id" ], "query": [ { "key": "student[email]", "value": "" }, { "key": "student[first_name]", "value": "" }, { "key": "student[last_name]", "value": "" }, { "key": "student[other_name]", "value": "" }, { "key": "student[preferred_name]", "value": "" }, { "key": "student[birth_date]", "value": "" }, { "key": "student[student_id]", "value": "" }, { "key": "student[enrollment_year]", "value": "" }, { "key": "student[address]", "value": "" }, { "key": "student[address_ii]", "value": "" }, { "key": "student[city]", "value": "" }, { "key": "student[state]", "value": "" }, { "key": "student[postal_code]", "value": "" } ], "variable": [ { "key": "subdomain", "value": "{{subdomain}}" }, { "key": "id", "value": "", "description": "(Required) The unique ID of the required student." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": \"\"\n}" }, { "name": "Unprocessable Entity", "originalRequest": { "method": "PATCH", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/students/:id?student[email]=&student[first_name]=&student[last_name]=&student[other_name]=&student[preferred_name]=&student[birth_date]=&student[student_id]=&student[enrollment_year]=&student[address]=&student[address_ii]=&student[city]=&student[state]=&student[postal_code]=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "students", ":id" ], "query": [ { "key": "student[email]", "value": "" }, { "key": "student[first_name]", "value": "" }, { "key": "student[last_name]", "value": "" }, { "key": "student[other_name]", "value": "" }, { "key": "student[preferred_name]", "value": "" }, { "key": "student[birth_date]", "value": "" }, { "key": "student[student_id]", "value": "" }, { "key": "student[enrollment_year]", "value": "" }, { "key": "student[address]", "value": "" }, { "key": "student[address_ii]", "value": "" }, { "key": "student[city]", "value": "" }, { "key": "student[state]", "value": "" }, { "key": "student[postal_code]", "value": "" } ], "variable": [ { "key": "subdomain", "value": "{{subdomain}}" }, { "key": "id", "value": "", "description": "(Required) The unique ID of the required student." } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": [\n \"\",\n \"\"\n ]\n}" } ] } ], "description": "This documentation describes all the APIs relating to student application management." }, { "name": "Parent", "item": [ { "name": "Retrieve all parents", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/parents", "host": [ "{{baseUrl}}" ], "path": [ "parents" ], "query": [ { "key": "count", "value": "", "description": "Specifies the number of parents to retrieve, up to a maximum of 1000.", "disabled": true }, { "key": "since_id", "value": "", "description": "Returns results with an ID greater than the specified ID.", "disabled": true }, { "key": "since_date", "value": "", "description": "Returns results updated since the specified date or date/time, e.g. 2013-09-23 or 2013-09-25 02:10:39.", "disabled": true } ] }, "description": "This endpoint returns up to 1000 parent records sorted by ID (default, 100 records). A query with no matches returns an empty JSON array." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/parents?count=&since_id=&since_date=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "parents" ], "query": [ { "key": "count", "value": "" }, { "key": "since_id", "value": "" }, { "key": "since_date", "value": "" } ], "variable": [ { "key": "subdomain", "value": "{{subdomain}}" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"parent\": [\n {\n \"id\": \"\",\n \"email\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"other_name\": \"\",\n \"preferred_name\": \"\",\n \"parent_id\": \"\",\n \"phone\": \"\",\n \"mobile_phone\": \"\",\n \"address\": \"\",\n \"address_ii\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\"\n },\n {\n \"id\": \"\",\n \"email\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"other_name\": \"\",\n \"preferred_name\": \"\",\n \"parent_id\": \"\",\n \"phone\": \"\",\n \"mobile_phone\": \"\",\n \"address\": \"\",\n \"address_ii\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\"\n }\n ],\n \"meta\": {\n \"pages\": \"\",\n \"per_page\": \"\"\n }\n}" }, { "name": "Not authorized", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/parents?count=&since_id=&since_date=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "parents" ], "query": [ { "key": "count", "value": "" }, { "key": "since_id", "value": "" }, { "key": "since_date", "value": "" } ], "variable": [ { "key": "subdomain", "value": "{{subdomain}}" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": \"\"\n}" } ] }, { "name": "Retrieve parent by ID", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/parents/:id", "host": [ "{{baseUrl}}" ], "path": [ "parents", ":id" ], "variable": [ { "key": "id", "value": "", "description": "(Required) The unique ID of the required parent." } ] }, "description": "This endpoint returns a single parent specified by ID with any custom fields defined." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/parents/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "parents", ":id" ], "variable": [ { "key": "subdomain", "value": "{{subdomain}}" }, { "key": "id", "value": "", "description": "(Required) The unique ID of the required parent." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": \"\",\n \"email\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"other_name\": \"\",\n \"preferred_name\": \"\",\n \"parent_id\": \"\",\n \"phone\": \"\",\n \"mobile_phone\": \"\",\n \"address\": \"\",\n \"address_ii\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\"\n}" }, { "name": "Not authorized", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/parents/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "parents", ":id" ], "variable": [ { "key": "subdomain", "value": "{{subdomain}}" }, { "key": "id", "value": "", "description": "(Required) The unique ID of the required parent." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": \"\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/parents/:id", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "parents", ":id" ], "variable": [ { "key": "subdomain", "value": "{{subdomain}}" }, { "key": "id", "value": "", "description": "(Required) The unique ID of the required parent." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": \"\"\n}" } ] }, { "name": "Update a parent", "request": { "method": "PATCH", "header": [], "url": { "raw": "{{baseUrl}}/parents/:id", "host": [ "{{baseUrl}}" ], "path": [ "parents", ":id" ], "query": [ { "key": "parent[phone]", "value": "", "disabled": true }, { "key": "parent[mobile_phone]", "value": "", "disabled": true }, { "key": "parent[first_name]", "value": "", "disabled": true }, { "key": "parent[last_name]", "value": "", "disabled": true }, { "key": "parent[other_name]", "value": "", "disabled": true }, { "key": "parent[preferred_name]", "value": "", "disabled": true }, { "key": "parent[parent_id]", "value": "", "disabled": true }, { "key": "parent[address]", "value": "", "disabled": true }, { "key": "parent[address_ii]", "value": "", "disabled": true }, { "key": "parent[city]", "value": "", "disabled": true }, { "key": "parent[state]", "value": "", "disabled": true }, { "key": "parent[postal_code]", "value": "", "disabled": true } ], "variable": [ { "key": "id", "value": "", "description": "(Required) The unique ID of the required parent." } ] }, "description": "This endpoint updates a parent’s records as specified by ID, with a PATCH request, i.e., only the fields provided will be updated." }, "response": [ { "name": "Success", "originalRequest": { "method": "PATCH", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/parents/:id?parent[phone]=&parent[mobile_phone]=&parent[first_name]=&parent[last_name]=&parent[other_name]=&parent[preferred_name]=&parent[parent_id]=&parent[address]=&parent[address_ii]=&parent[city]=&parent[state]=&parent[postal_code]=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "parents", ":id" ], "query": [ { "key": "parent[phone]", "value": "" }, { "key": "parent[mobile_phone]", "value": "" }, { "key": "parent[first_name]", "value": "" }, { "key": "parent[last_name]", "value": "" }, { "key": "parent[other_name]", "value": "" }, { "key": "parent[preferred_name]", "value": "" }, { "key": "parent[parent_id]", "value": "" }, { "key": "parent[address]", "value": "" }, { "key": "parent[address_ii]", "value": "" }, { "key": "parent[city]", "value": "" }, { "key": "parent[state]", "value": "" }, { "key": "parent[postal_code]", "value": "" } ], "variable": [ { "key": "subdomain", "value": "{{subdomain}}" }, { "key": "id", "value": "", "description": "(Required) The unique ID of the required parent." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": \"\",\n \"email\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"other_name\": \"\",\n \"preferred_name\": \"\",\n \"parent_id\": \"\",\n \"phone\": \"\",\n \"mobile_phone\": \"\",\n \"address\": \"\",\n \"address_ii\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\"\n}" }, { "name": "Bad request", "originalRequest": { "method": "PATCH", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/parents/:id?parent[phone]=&parent[mobile_phone]=&parent[first_name]=&parent[last_name]=&parent[other_name]=&parent[preferred_name]=&parent[parent_id]=&parent[address]=&parent[address_ii]=&parent[city]=&parent[state]=&parent[postal_code]=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "parents", ":id" ], "query": [ { "key": "parent[phone]", "value": "" }, { "key": "parent[mobile_phone]", "value": "" }, { "key": "parent[first_name]", "value": "" }, { "key": "parent[last_name]", "value": "" }, { "key": "parent[other_name]", "value": "" }, { "key": "parent[preferred_name]", "value": "" }, { "key": "parent[parent_id]", "value": "" }, { "key": "parent[address]", "value": "" }, { "key": "parent[address_ii]", "value": "" }, { "key": "parent[city]", "value": "" }, { "key": "parent[state]", "value": "" }, { "key": "parent[postal_code]", "value": "" } ], "variable": [ { "key": "subdomain", "value": "{{subdomain}}" }, { "key": "id", "value": "", "description": "(Required) The unique ID of the required parent." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": \"\"\n}" }, { "name": "Not authorized", "originalRequest": { "method": "PATCH", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/parents/:id?parent[phone]=&parent[mobile_phone]=&parent[first_name]=&parent[last_name]=&parent[other_name]=&parent[preferred_name]=&parent[parent_id]=&parent[address]=&parent[address_ii]=&parent[city]=&parent[state]=&parent[postal_code]=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "parents", ":id" ], "query": [ { "key": "parent[phone]", "value": "" }, { "key": "parent[mobile_phone]", "value": "" }, { "key": "parent[first_name]", "value": "" }, { "key": "parent[last_name]", "value": "" }, { "key": "parent[other_name]", "value": "" }, { "key": "parent[preferred_name]", "value": "" }, { "key": "parent[parent_id]", "value": "" }, { "key": "parent[address]", "value": "" }, { "key": "parent[address_ii]", "value": "" }, { "key": "parent[city]", "value": "" }, { "key": "parent[state]", "value": "" }, { "key": "parent[postal_code]", "value": "" } ], "variable": [ { "key": "subdomain", "value": "{{subdomain}}" }, { "key": "id", "value": "", "description": "(Required) The unique ID of the required parent." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": \"\"\n}" }, { "name": "Not Found", "originalRequest": { "method": "PATCH", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/parents/:id?parent[phone]=&parent[mobile_phone]=&parent[first_name]=&parent[last_name]=&parent[other_name]=&parent[preferred_name]=&parent[parent_id]=&parent[address]=&parent[address_ii]=&parent[city]=&parent[state]=&parent[postal_code]=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "parents", ":id" ], "query": [ { "key": "parent[phone]", "value": "" }, { "key": "parent[mobile_phone]", "value": "" }, { "key": "parent[first_name]", "value": "" }, { "key": "parent[last_name]", "value": "" }, { "key": "parent[other_name]", "value": "" }, { "key": "parent[preferred_name]", "value": "" }, { "key": "parent[parent_id]", "value": "" }, { "key": "parent[address]", "value": "" }, { "key": "parent[address_ii]", "value": "" }, { "key": "parent[city]", "value": "" }, { "key": "parent[state]", "value": "" }, { "key": "parent[postal_code]", "value": "" } ], "variable": [ { "key": "subdomain", "value": "{{subdomain}}" }, { "key": "id", "value": "", "description": "(Required) The unique ID of the required parent." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": \"\"\n}" }, { "name": "Unprocessable Entity", "originalRequest": { "method": "PATCH", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/parents/:id?parent[phone]=&parent[mobile_phone]=&parent[first_name]=&parent[last_name]=&parent[other_name]=&parent[preferred_name]=&parent[parent_id]=&parent[address]=&parent[address_ii]=&parent[city]=&parent[state]=&parent[postal_code]=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "parents", ":id" ], "query": [ { "key": "parent[phone]", "value": "" }, { "key": "parent[mobile_phone]", "value": "" }, { "key": "parent[first_name]", "value": "" }, { "key": "parent[last_name]", "value": "" }, { "key": "parent[other_name]", "value": "" }, { "key": "parent[preferred_name]", "value": "" }, { "key": "parent[parent_id]", "value": "" }, { "key": "parent[address]", "value": "" }, { "key": "parent[address_ii]", "value": "" }, { "key": "parent[city]", "value": "" }, { "key": "parent[state]", "value": "" }, { "key": "parent[postal_code]", "value": "" } ], "variable": [ { "key": "subdomain", "value": "{{subdomain}}" }, { "key": "id", "value": "", "description": "(Required) The unique ID of the required parent." } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": [\n \"\",\n \"\"\n ]\n}" } ] } ], "description": "This documentation describes all the APIs relating to the parent/guardians of applicants." }, { "name": "Payments", "item": [ { "name": "Student payment information", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/students/:id/payments", "host": [ "{{baseUrl}}" ], "path": [ "students", ":id", "payments" ], "variable": [ { "key": "id", "value": "", "description": "(Required) The unique ID of the required student." } ] }, "description": "Returns the payment information of a student as specified by ID." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/students/:id/payments", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "students", ":id", "payments" ], "variable": [ { "key": "subdomain", "value": "{{subdomain}}" }, { "key": "id", "value": "", "description": "(Required) The unique ID of the required student." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"payments\": [\n {\n \"invoice_status\": \"\",\n \"type\": \"\",\n \"invoice_number\": \"\",\n \"amount\": \"\",\n \"issue_date\": \"\",\n \"due_date\": \"\",\n \"payment_method\": \"\",\n \"payment_date\": \"\"\n },\n {\n \"invoice_status\": \"\",\n \"type\": \"\",\n \"invoice_number\": \"\",\n \"amount\": \"\",\n \"issue_date\": \"\",\n \"due_date\": \"\",\n \"payment_method\": \"\",\n \"payment_date\": \"\"\n }\n ]\n}" }, { "name": "Not authorized", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/students/:id/payments", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "students", ":id", "payments" ], "variable": [ { "key": "subdomain", "value": "{{subdomain}}" }, { "key": "id", "value": "", "description": "(Required) The unique ID of the required student." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": \"\"\n}" } ] } ], "description": "This documentation describes all the APIs relating to payments." }, { "name": "Search", "item": [ { "name": "Retrieve parent searchable keys", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/parents/searchable_keys", "host": [ "{{baseUrl}}" ], "path": [ "parents", "searchable_keys" ] }, "description": "This endpoint retrieves all searchable keys. Each School may generate custom fields; therefore, it is necessary to fetch searchable_keys before running a query. The endpoint returns a set of keys with any custom fields defined." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/parents/searchable_keys", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "parents", "searchable_keys" ], "variable": [ { "key": "subdomain", "value": "{{subdomain}}" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"parent_slug\": [\n \"\",\n \"\"\n ]\n}" }, { "name": "Not authorized", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/parents/searchable_keys", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "parents", "searchable_keys" ], "variable": [ { "key": "subdomain", "value": "{{subdomain}}" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": \"\"\n}" } ] }, { "name": "Retrieve searchable student keys", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/students/searchable_keys", "host": [ "{{baseUrl}}" ], "path": [ "students", "searchable_keys" ] }, "description": "This endpoint retrieves all searchable keys. Each School may generate custom fields; therefore, it is necessary to fetch searchable_keys before running a query. The endpoint returns a set of keys with any custom fields defined." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/students/searchable_keys", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "students", "searchable_keys" ], "variable": [ { "key": "subdomain", "value": "{{subdomain}}" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"tag_slug\": [\n \"\",\n \"\"\n ],\n \"student_slug\": [\n \"\",\n \"\"\n ],\n \"form_slug\": [\n {\n \"id\": \"\",\n \"label\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"wildcard\": \"\"\n },\n {\n \"id\": \"\",\n \"label\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"wildcard\": \"\"\n }\n ],\n \"questionnaire_slug\": [\n {\n \"id\": \"\",\n \"label\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"wildcard\": \"\"\n },\n {\n \"id\": \"\",\n \"label\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"wildcard\": \"\"\n }\n ]\n}" }, { "name": "Not authorized", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/students/searchable_keys", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "students", "searchable_keys" ], "variable": [ { "key": "subdomain", "value": "{{subdomain}}" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": \"\"\n}" } ] }, { "name": "Search parent by searchable keys", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/parents/search", "host": [ "{{baseUrl}}" ], "path": [ "parents", "search" ], "query": [ { "key": "parent[last_name]", "value": "", "disabled": true }, { "key": "parent[first_name]", "value": "", "disabled": true }, { "key": "parent[gender]", "value": "", "disabled": true }, { "key": "parent[email]", "value": "", "disabled": true }, { "key": "parent[preferred_name]", "value": "", "disabled": true }, { "key": "parent[mobile_phone]", "value": "", "disabled": true }, { "key": "parent[nationality]", "value": "", "disabled": true } ] }, "description": "This endpoint returns query results as per the keys retrieved by endpoint listParentSearchableKeys." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/parents/search?parent[last_name]=&parent[first_name]=&parent[gender]=&parent[email]=&parent[preferred_name]=&parent[mobile_phone]=&parent[nationality]=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "parents", "search" ], "query": [ { "key": "parent[last_name]", "value": "" }, { "key": "parent[first_name]", "value": "" }, { "key": "parent[gender]", "value": "" }, { "key": "parent[email]", "value": "" }, { "key": "parent[preferred_name]", "value": "" }, { "key": "parent[mobile_phone]", "value": "" }, { "key": "parent[nationality]", "value": "" } ], "variable": [ { "key": "subdomain", "value": "{{subdomain}}" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"parent\": [\n {\n \"id\": \"\",\n \"email\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"other_name\": \"\",\n \"preferred_name\": \"\",\n \"parent_id\": \"\",\n \"phone\": \"\",\n \"mobile_phone\": \"\",\n \"address\": \"\",\n \"address_ii\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\"\n },\n {\n \"id\": \"\",\n \"email\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"other_name\": \"\",\n \"preferred_name\": \"\",\n \"parent_id\": \"\",\n \"phone\": \"\",\n \"mobile_phone\": \"\",\n \"address\": \"\",\n \"address_ii\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\"\n }\n ],\n \"meta\": {\n \"pages\": \"\",\n \"per_page\": \"\"\n }\n}" }, { "name": "Not authorized", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/parents/search?parent[last_name]=&parent[first_name]=&parent[gender]=&parent[email]=&parent[preferred_name]=&parent[mobile_phone]=&parent[nationality]=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "parents", "search" ], "query": [ { "key": "parent[last_name]", "value": "" }, { "key": "parent[first_name]", "value": "" }, { "key": "parent[gender]", "value": "" }, { "key": "parent[email]", "value": "" }, { "key": "parent[preferred_name]", "value": "" }, { "key": "parent[mobile_phone]", "value": "" }, { "key": "parent[nationality]", "value": "" } ], "variable": [ { "key": "subdomain", "value": "{{subdomain}}" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": \"\"\n}" } ] }, { "name": "Search student by searchable keys", "event": [ { "listen": "prerequest", "script": { "exec": [ "" ], "type": "text/javascript" } }, { "listen": "test", "script": { "exec": [ "console.log(pm)", "pm.visualizer.set(\"{{students.length}}\", {response: pm.response.json()})" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/students/search?student[student_id]=3&per_page=100", "host": [ "{{baseUrl}}" ], "path": [ "students", "search" ], "query": [ { "key": "tag[title]", "value": "", "description": "Return results of students whose `tag` title is equal to the value passed", "disabled": true }, { "key": "student[last_name]", "value": "", "description": "Return results of students whose `last_name` is equal to the value passed", "disabled": true }, { "key": "student[first_name]", "value": "James", "description": "Return results of students whose `first_name` is equal to the value passed", "disabled": true }, { "key": "student[enrollment_year]", "value": "", "description": "Return results of students whose `enrollment_year` is equal to the value passed", "disabled": true }, { "key": "student[campus]", "value": "", "description": "Return results of students whose `campus` is equal to the value passed", "disabled": true }, { "key": "student[id]", "value": "", "description": "Return results of students whose `internal` id is equal to the value passed", "disabled": true }, { "key": "student[student_id]", "value": "3", "description": "Return results of students whose `student_id` is equal to the value passed" }, { "key": "field[language]", "value": "", "description": "TODO", "disabled": true }, { "key": "field[swimming_medical_insurance]", "value": "acknowledge", "disabled": true }, { "key": "per_page", "value": "100" } ] }, "description": "This endpoint returns query results as per the keys retrieved by endpoint \"Retrieve searchable student keys\". It is possible to search students by tag(s), application value(s), and form field’s value." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/students/search?tag[title]=&student[last_name]=&student[first_name]=&student[enrollment_year]=&student[campus]=&student[id]=&student[student_id]=&field[language]=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "students", "search" ], "query": [ { "key": "tag[title]", "value": "" }, { "key": "student[last_name]", "value": "" }, { "key": "student[first_name]", "value": "" }, { "key": "student[enrollment_year]", "value": "" }, { "key": "student[campus]", "value": "" }, { "key": "student[id]", "value": "" }, { "key": "student[student_id]", "value": "" }, { "key": "field[language]", "value": "" } ], "variable": [ { "key": "subdomain", "value": "{{subdomain}}" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"students\": [\n {\n \"id\": \"\",\n \"serial_number\": \"\",\n \"custom_id\": \"\",\n \"applicant_id\": \"\",\n \"email\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"name\": \"\",\n \"other_name\": \"\",\n \"preferred_name\": \"\",\n \"birth_date\": \"\",\n \"gender\": \"\",\n \"enrollment_year\": \"\",\n \"full_address\": \"\",\n \"address\": \"\",\n \"address_ii\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\",\n \"grade\": \"\",\n \"campus\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"status\": \"\",\n \"status_level\": \"\",\n \"status_changed_at\": \"\",\n \"managebac_student_id\": \"\",\n \"applied_at\": \"\",\n \"enrolled_at\": \"\",\n \"inquired_at\": \"\",\n \"sibling_ids\": [\n \"\",\n \"\"\n ],\n \"updated_at\": \"\",\n \"nationality\": \"\",\n \"student_id\": \"\",\n \"passport_id\": \"\",\n \"profile_photo\": \"\",\n \"profile_photo_updated_at\": \"\",\n \"checklist_state\": \"\",\n \"inquired_date\": \"\",\n \"applied_date\": \"\",\n \"admitted_date\": \"\",\n \"wait_listed_date\": \"\",\n \"declined_date\": \"\",\n \"enrolled_date\": \"\",\n \"withdrawn_date\": \"\",\n \"graduated_date\": \"\",\n \"representative\": \"\",\n \"custom_fields\": {\n \"any\": \"\"\n },\n \"parent_ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"id\": \"\",\n \"serial_number\": \"\",\n \"custom_id\": \"\",\n \"applicant_id\": \"\",\n \"email\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"name\": \"\",\n \"other_name\": \"\",\n \"preferred_name\": \"\",\n \"birth_date\": \"\",\n \"gender\": \"\",\n \"enrollment_year\": \"\",\n \"full_address\": \"\",\n \"address\": \"\",\n \"address_ii\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\",\n \"grade\": \"\",\n \"campus\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"status\": \"\",\n \"status_level\": \"\",\n \"status_changed_at\": \"\",\n \"managebac_student_id\": \"\",\n \"applied_at\": \"\",\n \"enrolled_at\": \"\",\n \"inquired_at\": \"\",\n \"sibling_ids\": [\n \"\",\n \"\"\n ],\n \"updated_at\": \"\",\n \"nationality\": \"\",\n \"student_id\": \"\",\n \"passport_id\": \"\",\n \"profile_photo\": \"\",\n \"profile_photo_updated_at\": \"\",\n \"checklist_state\": \"\",\n \"inquired_date\": \"\",\n \"applied_date\": \"\",\n \"admitted_date\": \"\",\n \"wait_listed_date\": \"\",\n \"declined_date\": \"\",\n \"enrolled_date\": \"\",\n \"withdrawn_date\": \"\",\n \"graduated_date\": \"\",\n \"representative\": \"\",\n \"custom_fields\": {\n \"any\": \"\"\n },\n \"parent_ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"linked\": {\n \"parents\": {\n \"id\": \"\",\n \"email\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"other_name\": \"\",\n \"preferred_name\": \"\",\n \"parent_id\": \"\",\n \"phone\": \"\",\n \"mobile_phone\": \"\",\n \"address\": \"\",\n \"address_ii\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"postal_code\": \"\",\n \"country\": \"\"\n }\n },\n \"meta\": {\n \"pages\": \"\",\n \"per_page\": \"\"\n }\n}" }, { "name": "Not authorized", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v3/students/search?tag[title]=&student[last_name]=&student[first_name]=&student[enrollment_year]=&student[campus]=&student[id]=&student[student_id]=&field[language]=", "host": [ "{{baseUrl}}" ], "path": [ "api", "v3", "students", "search" ], "query": [ { "key": "tag[title]", "value": "" }, { "key": "student[last_name]", "value": "" }, { "key": "student[first_name]", "value": "" }, { "key": "student[enrollment_year]", "value": "" }, { "key": "student[campus]", "value": "" }, { "key": "student[id]", "value": "" }, { "key": "student[student_id]", "value": "" }, { "key": "field[language]", "value": "" } ], "variable": [ { "key": "subdomain", "value": "{{subdomain}}" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": \"\"\n}" } ] } ], "description": "This documentation describes all the APIs relating to searching." }, { "name": "Contacts", "item": [ { "name": "Get all Contacts", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/contacts", "host": [ "{{baseUrl}}" ], "path": [ "contacts" ], "query": [ { "key": "per_page", "value": null, "disabled": true }, { "key": "page", "value": null, "disabled": true } ] } }, "response": [] }, { "name": "Get Contact by ID", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/contacts/:id", "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":id" ], "variable": [ { "key": "id", "value": null } ] } }, "response": [] }, { "name": "Create a Contact", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"contact\": {\n \"first_name\": \"First Name\",\n \"last_name\": \"Last Name\",\n \"email\": \"someone@example.com\",\n \"phone_number\": \"+1 123 345 567\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/contacts", "host": [ "{{baseUrl}}" ], "path": [ "contacts" ] } }, "response": [] }, { "name": "Update a Contact", "request": { "method": "PATCH", "header": [], "body": { "mode": "raw", "raw": "{\n \"contact\": {\n \"first_name\": \"Johnny\",\n \"last_name\": \"Doe\",\n \"phone_number\": \"+1 123 345 567\",\n \"email\": \"johnny.doe@mail.com\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/contacts/:id", "host": [ "{{baseUrl}}" ], "path": [ "contacts", ":id" ], "variable": [ { "key": "id", "value": null } ] } }, "response": [] } ] } ], "auth": { "type": "oauth2", "oauth2": [ { "key": "tokenName", "value": "The Name", "type": "string" }, { "key": "accessTokenUrl", "value": "https://{{subdomain}}.openapply.{{tld}}/oauth/token", "type": "string" }, { "key": "client_authentication", "value": "body", "type": "string" }, { "key": "tokenType", "value": "Bearer", "type": "string" }, { "key": "accessToken", "value": "Cick_New_Access_Token_Below", "type": "string" }, { "key": "clientSecret", "value": "{{clientSecret}}", "type": "string" }, { "key": "clientId", "value": "{{clientId}}", "type": "string" }, { "key": "challengeAlgorithm", "value": "S256", "type": "string" }, { "key": "grant_type", "value": "client_credentials", "type": "string" }, { "key": "addTokenTo", "value": "header", "type": "string" } ] }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ], "variable": [ { "key": "baseUrl", "value": "https://{{subdomain}}.openapply.{{tld}}/api/{{version}}", "type": "string" } ] }