{ "info": { "_postman_id": "06d555fd-bc24-42f7-8e6c-bec30953352f", "name": "ManageBac API with Postman (v2)", "description": "This collection is made available to improve effectiveness and understanding of the use of Faria's APIs.\n\nContact Support:\n Name: Faria Education Group\n Email: api@managebac.com", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "_exporter_id": "25179203" }, "item": [ { "name": "School", "item": [ { "name": "Get School Details", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/school", "host": [ "{{baseUrl}}" ], "path": [ "school" ] }, "description": "This endpoint retrieves School details and its enabled programs." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/school", "host": [ "{{baseUrl}}" ], "path": [ "v2", "school" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"school\": {\n \"subdomain\": \"faria\",\n \"name\": \"Faria International School\",\n \"country\": \"US\",\n \"language\": \"en\",\n \"programs\": [\n \"IB Diploma\",\n \"IB Middle Years\",\n \"IB Primary Years\",\n \"High School\",\n \"Middle School\",\n \"Primary School\"\n ],\n \"kbl_id\": 5\n }\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/school", "host": [ "{{baseUrl}}" ], "path": [ "v2", "school" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": \"Access Denied\"\n}" } ] }, { "name": "Get Academic Years", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/school/academic-years", "host": [ "{{baseUrl}}" ], "path": [ "school", "academic-years" ] }, "description": "This endpoint retrieves a list of academic years and terms as defined for each program enabled for the School." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/school/academic-years", "host": [ "{{baseUrl}}" ], "path": [ "v2", "school", "academic-years" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"academic_years\": {\n \"diploma\": {\n \"academic_years\": [\n {\n \"id\": 26278,\n \"name\": \"August 2018 – July 2019\",\n \"starts_on\": \"2018-08-15\",\n \"ends_on\": \"2019-07-30\",\n \"updated_at\": \"2017-12-21T16:50:47.000+08:00\",\n \"academic_terms\": [\n {\n \"id\": 62755,\n \"name\": \"Term 1\",\n \"starts_on\": \"2018-08-15\",\n \"ends_on\": \"2018-12-31\",\n \"updated_at\": \"2018-04-21T16:50:47.000+08:00\",\n \"exam_grade\": false\n },\n {\n \"id\": 62756,\n \"name\": \"Term 2\",\n \"starts_on\": \"2019-01-03\",\n \"ends_on\": \"2019-07-30\",\n \"updated_at\": \"2018-04-14T17:37:35.000+08:00\",\n \"exam_grade\": false\n }\n ]\n }\n ]\n },\n \"myp\": {\n \"academic_years\": [\n {\n \"id\": 24648,\n \"name\": \"August 2018 – July 2019\",\n \"starts_on\": \"2018-08-19\",\n \"ends_on\": \"2019-07-01\",\n \"updated_at\": \"2018-04-09T05:09:12.000+08:00\",\n \"academic_terms\": [\n {\n \"id\": 58813,\n \"name\": \"Term 1\",\n \"starts_on\": \"2018-08-19\",\n \"ends_on\": \"2019-01-29\",\n \"updated_at\": \"2018-04-09T05:09:12.000+08:00\",\n \"exam_grade\": false\n },\n {\n \"id\": 58814,\n \"name\": \"Term 2\",\n \"starts_on\": \"2019-02-01\",\n \"ends_on\": \"2019-07-01\",\n \"updated_at\": \"2016-04-09T05:09:12.000+08:00\",\n \"exam_grade\": false\n }\n ]\n }\n ]\n },\n \"ib_pyp\": {\n \"academic_years\": [\n {\n \"id\": 31796,\n \"name\": \"August 2018 – June 2019\",\n \"starts_on\": \"2018-08-10\",\n \"ends_on\": \"2019-06-03\",\n \"updated_at\": \"2018-04-28T23:54:16.000+08:00\",\n \"academic_terms\": [\n {\n \"id\": 76082,\n \"name\": \"Term One\",\n \"starts_on\": \"2018-08-10\",\n \"ends_on\": \"2019-01-01\",\n \"updated_at\": \"2018-05-28T23:54:16.000+08:00\",\n \"exam_grade\": false\n },\n {\n \"id\": 76083,\n \"name\": \"Quarter 1\",\n \"starts_on\": \"2019-01-04\",\n \"ends_on\": \"2019-06-03\",\n \"updated_at\": \"2018-05-28T23:54:16.000+08:00\",\n \"exam_grade\": false\n }\n ]\n }\n ]\n }\n }\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/school/academic-years", "host": [ "{{baseUrl}}" ], "path": [ "v2", "school", "academic-years" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": \"Access Denied\"\n}" } ] }, { "name": "Get School Grades", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/school/grades", "host": [ "{{baseUrl}}" ], "path": [ "school", "grades" ] }, "description": "This endpoint retrieves the grade details defined for each program that a School runs. It returns grades grouped by each program." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/school/grades", "host": [ "{{baseUrl}}" ], "path": [ "v2", "school", "grades" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"school\": {\n \"programs\": [\n {\n \"name\": \"\",\n \"short_name\": \"\",\n \"uid\": \"\",\n \"code\": \"\",\n \"grades\": [\n {\n \"grade_number\": \"\",\n \"uid\": \"\",\n \"name\": \"\",\n \"enabled\": \"\",\n \"program\": \"\"\n },\n {\n \"grade_number\": \"\",\n \"uid\": \"\",\n \"name\": \"\",\n \"enabled\": \"\",\n \"program\": \"\"\n }\n ]\n },\n {\n \"name\": \"\",\n \"short_name\": \"\",\n \"uid\": \"\",\n \"code\": \"\",\n \"grades\": [\n {\n \"grade_number\": \"\",\n \"uid\": \"\",\n \"name\": \"\",\n \"enabled\": \"\",\n \"program\": \"\"\n },\n {\n \"grade_number\": \"\",\n \"uid\": \"\",\n \"name\": \"\",\n \"enabled\": \"\",\n \"program\": \"\"\n }\n ]\n }\n ]\n }\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/school/grades", "host": [ "{{baseUrl}}" ], "path": [ "v2", "school", "grades" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": \"Access Denied\"\n}" } ] }, { "name": "Get School Subjects", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/school/subjects", "host": [ "{{baseUrl}}" ], "path": [ "school", "subjects" ] }, "description": "This endpoint retrieves subject details for programs enabled at the School." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/school/subjects", "host": [ "{{baseUrl}}" ], "path": [ "v2", "school", "subjects" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"subjects\": {\n \"diploma\": [\n {\n \"id\": 1,\n \"name\": \"Mathematical Studies\",\n \"group\": \"Mathematics\",\n \"hl\": true,\n \"sl\": true\n },\n {\n \"id\": 16,\n \"name\": \"Chinese\",\n \"group\": \"Language acquisition\",\n \"hl\": true,\n \"sl\": true,\n \"self_taught\": false,\n \"levels\": [\n \"B\",\n \"ab initio\"\n ]\n },\n {\n \"id\": 27,\n \"name\": \"French\",\n \"group\": \"Language acquisition\",\n \"hl\": true,\n \"sl\": true,\n \"self_taught\": false,\n \"levels\": [\n \"B\",\n \"ab initio\"\n ]\n }\n ],\n \"myp\": [\n {\n \"id\": 348,\n \"name\": \"Physical and health education\",\n \"group\": \"Physical and health education\"\n },\n {\n \"id\": 350,\n \"name\": \"Arts\",\n \"group\": \"Arts\"\n }\n ]\n }\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/school/subjects", "host": [ "{{baseUrl}}" ], "path": [ "v2", "school", "subjects" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": \"Access Denied\"\n}" } ] }, { "name": "Get Year Groups", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/year-groups", "host": [ "{{baseUrl}}" ], "path": [ "year-groups" ] } }, "response": [] } ], "description": "This section describes all the APIs relating to administation settings at the school-level." }, { "name": "Students", "item": [ { "name": "Get all Students", "event": [ { "listen": "test", "script": { "exec": [ "/**", " * Get an overview table of all items returned from the endpoint, useful for when there lists of objects are returned.", " * See comments below for screenshots.", " * ", " * https://gist.github.com/brainysmurf/e45f608b68609f8a0b222ac99b8905d8", " *", " * To use, copy the below code into the \"Tests\" tab of the endpoint", " * Click blue \"Send\" button", " * Click on \"Visualize\" in the Body tile", " * Note that it only displays the returned objects, there's nothing magical that's getting \"all\" objects via pagination", " */", "", " // change to whatever the root property is \"students\" \"year-groups\" whatever", "const entity = \"students\"; ", "", " // change to the fields you want displayed at first, you can add others interactively", "const columns = ['id', 'email']; ", "", "/**", " * Below not intended for modification (although you can, for version bumps etc)", " */", "const template = `", "", "", "", "
", "", " ", "", "", "", "", "", "", "", " `;", "", "// Set visualizer with template defined below (via hoisting)", "const json = pm.response.json();", "pm.visualizer.set(template, pm.response.json());" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/students", "host": [ "{{baseUrl}}" ], "path": [ "students" ], "query": [ { "key": "archived", "value": "", "description": "Return only archived (1) or only active (0) students. If value is not specified, all students are returned.", "disabled": true }, { "key": "status", "value": "", "description": "Return students by status. Available statuses: enrolled, withdrawn, graduated. If value is not specified, all students are returned.", "disabled": true }, { "key": "modified_since", "value": "", "description": "A timestamp to filter the modification date of results.", "disabled": true }, { "key": "page", "value": "", "description": "An integer defining which page to display.", "disabled": true }, { "key": "per_page", "value": "", "description": "An integer defining the number of records to display per page.", "disabled": true }, { "key": "deleted_since", "value": "", "description": "A timestamp to filter the deletion date of results.", "disabled": true }, { "key": "q", "value": "", "description": "A string to search across the following fields: first_name, last_name, middle_name, nickname, other_name, email, student_id.", "disabled": true } ] }, "description": "This endpoint retrieves all students. It returns personal details and program as well as any School-defined values." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/students?archived=&status=&modified_since=&page=&per_page=&deleted_since=&q=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "students" ], "query": [ { "key": "archived", "value": "" }, { "key": "status", "value": "" }, { "key": "modified_since", "value": "" }, { "key": "page", "value": "" }, { "key": "per_page", "value": "" }, { "key": "deleted_since", "value": "" }, { "key": "q", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"students\": [\n {\n \"email\": \"\",\n \"first_name\": \"\",\n \"middle_name\": \"\",\n \"password\": \"\",\n \"last_name\": \"\",\n \"nickname\": \"\",\n \"other_name\": \"\",\n \"gender\": \"\",\n \"birthday\": \"\",\n \"phone_number\": \"\",\n \"mobile_phone_number\": \"\",\n \"street_address\": \"\",\n \"street_address_ii\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipcode\": \"\",\n \"country\": \"\",\n \"nationalities\": [\n \"\",\n \"\"\n ],\n \"languages\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"graduated_on\": \"\",\n \"withdrawn_on\": \"\",\n \"student_id\": \"\",\n \"homeroom_advisor_id\": \"\",\n \"year_group_id\": \"\",\n \"graduating_year\": \"\",\n \"parent_ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"email\": \"\",\n \"first_name\": \"\",\n \"middle_name\": \"\",\n \"password\": \"\",\n \"last_name\": \"\",\n \"nickname\": \"\",\n \"other_name\": \"\",\n \"gender\": \"\",\n \"birthday\": \"\",\n \"phone_number\": \"\",\n \"mobile_phone_number\": \"\",\n \"street_address\": \"\",\n \"street_address_ii\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipcode\": \"\",\n \"country\": \"\",\n \"nationalities\": [\n \"\",\n \"\"\n ],\n \"languages\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"graduated_on\": \"\",\n \"withdrawn_on\": \"\",\n \"student_id\": \"\",\n \"homeroom_advisor_id\": \"\",\n \"year_group_id\": \"\",\n \"graduating_year\": \"\",\n \"parent_ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"meta\": {\n \"current_page\": \"\",\n \"total_pages\": \"\",\n \"total_count\": \"\",\n \"per_page\": \"\"\n }\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/students?archived=&status=&modified_since=&page=&per_page=&deleted_since=&q=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "students" ], "query": [ { "key": "archived", "value": "" }, { "key": "status", "value": "" }, { "key": "modified_since", "value": "" }, { "key": "page", "value": "" }, { "key": "per_page", "value": "" }, { "key": "deleted_since", "value": "" }, { "key": "q", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": \"Access Denied\"\n}" } ] }, { "name": "Create New Student", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"student\": {\n \"email\": \"\",\n \"first_name\": \"\",\n \"middle_name\": \"\",\n \"password\": \"\",\n \"last_name\": \"\",\n \"nickname\": \"\",\n \"other_name\": \"\",\n \"gender\": \"\",\n \"birthday\": \"\",\n \"phone_number\": \"\",\n \"mobile_phone_number\": \"\",\n \"street_address\": \"\",\n \"street_address_ii\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipcode\": \"\",\n \"country\": \"\",\n \"nationalities\": [\n \"\",\n \"\"\n ],\n \"languages\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"graduated_on\": \"\",\n \"withdrawn_on\": \"\",\n \"student_id\": \"\",\n \"homeroom_advisor_id\": \"\",\n \"year_group_id\": \"\",\n \"graduating_year\": \"\",\n \"parent_ids\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/students", "host": [ "{{baseUrl}}" ], "path": [ "students" ] }, "description": "This endpoint creates a new student record. The Content-Type header must be set to application/json,\nand the request body should contain the field structure as a JSON payload. Only users with admin role\nare able to create new student records.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"student\": {\n \"email\": \"\",\n \"first_name\": \"\",\n \"middle_name\": \"\",\n \"password\": \"\",\n \"last_name\": \"\",\n \"nickname\": \"\",\n \"other_name\": \"\",\n \"gender\": \"\",\n \"birthday\": \"\",\n \"phone_number\": \"\",\n \"mobile_phone_number\": \"\",\n \"street_address\": \"\",\n \"street_address_ii\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipcode\": \"\",\n \"country\": \"\",\n \"nationalities\": [\n \"\",\n \"\"\n ],\n \"languages\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"graduated_on\": \"\",\n \"withdrawn_on\": \"\",\n \"student_id\": \"\",\n \"homeroom_advisor_id\": \"\",\n \"year_group_id\": \"\",\n \"graduating_year\": \"\",\n \"parent_ids\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/students", "host": [ "{{baseUrl}}" ], "path": [ "v2", "students" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"student\": {\n \"email\": \"\",\n \"first_name\": \"\",\n \"middle_name\": \"\",\n \"password\": \"\",\n \"last_name\": \"\",\n \"nickname\": \"\",\n \"other_name\": \"\",\n \"gender\": \"\",\n \"birthday\": \"\",\n \"phone_number\": \"\",\n \"mobile_phone_number\": \"\",\n \"street_address\": \"\",\n \"street_address_ii\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipcode\": \"\",\n \"country\": \"\",\n \"nationalities\": [\n \"\",\n \"\"\n ],\n \"languages\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"graduated_on\": \"\",\n \"withdrawn_on\": \"\",\n \"student_id\": \"\",\n \"homeroom_advisor_id\": \"\",\n \"year_group_id\": \"\",\n \"graduating_year\": \"\",\n \"parent_ids\": [\n \"\",\n \"\"\n ]\n }\n}" } ] }, { "name": "Get a Student", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/students/:id", "host": [ "{{baseUrl}}" ], "path": [ "students", ":id" ], "variable": [ { "key": "id", "value": "{{studentId}}", "description": "(Required) Unique identifier for a student." } ] }, "description": "This endpoint retrieves a single student as specified by ID. It returns personal details, including the IDs of parents. Depending on the value of the status field (withdrawn or graduated), the related date field will have a different name." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/students/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "students", ":id" ], "variable": [ { "key": "id", "value": "", "description": "(Required) Unique identifier for a student." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"student\": {\n \"email\": \"\",\n \"first_name\": \"\",\n \"middle_name\": \"\",\n \"password\": \"\",\n \"last_name\": \"\",\n \"nickname\": \"\",\n \"other_name\": \"\",\n \"gender\": \"\",\n \"birthday\": \"\",\n \"phone_number\": \"\",\n \"mobile_phone_number\": \"\",\n \"street_address\": \"\",\n \"street_address_ii\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipcode\": \"\",\n \"country\": \"\",\n \"nationalities\": [\n \"\",\n \"\"\n ],\n \"languages\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"graduated_on\": \"\",\n \"withdrawn_on\": \"\",\n \"student_id\": \"\",\n \"homeroom_advisor_id\": \"\",\n \"year_group_id\": \"\",\n \"graduating_year\": \"\",\n \"parent_ids\": [\n \"\",\n \"\"\n ]\n }\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/students/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "students", ":id" ], "variable": [ { "key": "id", "value": "", "description": "(Required) Unique identifier for a student." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": \"Access Denied\"\n}" }, { "name": "Not found.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/students/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "students", ":id" ], "variable": [ { "key": "id", "value": "", "description": "(Required) Unique identifier for a student." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": \"Couldn't find User with 'id'=12345\"\n}" } ] }, { "name": "Get a Student Memberships", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/students/:id/memberships", "host": [ "{{baseUrl}}" ], "path": [ "students", ":id", "memberships" ], "variable": [ { "key": "id", "value": "{{studentId}}", "description": "(Required) Unique identifier for a student." } ] }, "description": "This endpoint retrieves a single student as specified by ID. It returns personal details, including the IDs of parents. Depending on the value of the status field (withdrawn or graduated), the related date field will have a different name." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/students/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "students", ":id" ], "variable": [ { "key": "id", "value": "", "description": "(Required) Unique identifier for a student." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"student\": {\n \"email\": \"\",\n \"first_name\": \"\",\n \"middle_name\": \"\",\n \"password\": \"\",\n \"last_name\": \"\",\n \"nickname\": \"\",\n \"other_name\": \"\",\n \"gender\": \"\",\n \"birthday\": \"\",\n \"phone_number\": \"\",\n \"mobile_phone_number\": \"\",\n \"street_address\": \"\",\n \"street_address_ii\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipcode\": \"\",\n \"country\": \"\",\n \"nationalities\": [\n \"\",\n \"\"\n ],\n \"languages\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"graduated_on\": \"\",\n \"withdrawn_on\": \"\",\n \"student_id\": \"\",\n \"homeroom_advisor_id\": \"\",\n \"year_group_id\": \"\",\n \"graduating_year\": \"\",\n \"parent_ids\": [\n \"\",\n \"\"\n ]\n }\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/students/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "students", ":id" ], "variable": [ { "key": "id", "value": "", "description": "(Required) Unique identifier for a student." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": \"Access Denied\"\n}" }, { "name": "Not found.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/students/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "students", ":id" ], "variable": [ { "key": "id", "value": "", "description": "(Required) Unique identifier for a student." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": \"Couldn't find User with 'id'=12345\"\n}" } ] }, { "name": "Update a Student", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"student\": {\n \"birthday\": \"1900-01-01\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/students/:id", "host": [ "{{baseUrl}}" ], "path": [ "students", ":id" ], "variable": [ { "key": "id", "value": "", "description": "(Required) Unique identifier for a student." } ] }, "description": "This endpoint updates a student record as specified by student ID. The Content-Type header must\nbe set to application/json, and the request body should contain the fields you want to update as\na JSON payload. Only users with admin role are able to update students.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "PATCH", "header": [], "body": { "mode": "raw", "raw": "{\n \"student\": {\n \"email\": \"\",\n \"first_name\": \"\",\n \"middle_name\": \"\",\n \"password\": \"\",\n \"last_name\": \"\",\n \"nickname\": \"\",\n \"other_name\": \"\",\n \"gender\": \"\",\n \"birthday\": \"\",\n \"phone_number\": \"\",\n \"mobile_phone_number\": \"\",\n \"street_address\": \"\",\n \"street_address_ii\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipcode\": \"\",\n \"country\": \"\",\n \"nationalities\": [\n \"\",\n \"\"\n ],\n \"languages\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"graduated_on\": \"\",\n \"withdrawn_on\": \"\",\n \"student_id\": \"\",\n \"homeroom_advisor_id\": \"\",\n \"year_group_id\": \"\",\n \"graduating_year\": \"\",\n \"parent_ids\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/students/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "students", ":id" ], "variable": [ { "key": "id", "value": "", "description": "(Required) Unique identifier for a student." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"student\": {\n \"email\": \"\",\n \"first_name\": \"\",\n \"middle_name\": \"\",\n \"password\": \"\",\n \"last_name\": \"\",\n \"nickname\": \"\",\n \"other_name\": \"\",\n \"gender\": \"\",\n \"birthday\": \"\",\n \"phone_number\": \"\",\n \"mobile_phone_number\": \"\",\n \"street_address\": \"\",\n \"street_address_ii\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipcode\": \"\",\n \"country\": \"\",\n \"nationalities\": [\n \"\",\n \"\"\n ],\n \"languages\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"graduated_on\": \"\",\n \"withdrawn_on\": \"\",\n \"student_id\": \"\",\n \"homeroom_advisor_id\": \"\",\n \"year_group_id\": \"\",\n \"graduating_year\": \"\",\n \"parent_ids\": [\n \"\",\n \"\"\n ]\n }\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "PATCH", "header": [], "body": { "mode": "raw", "raw": "{\n \"student\": {\n \"email\": \"\",\n \"first_name\": \"\",\n \"middle_name\": \"\",\n \"password\": \"\",\n \"last_name\": \"\",\n \"nickname\": \"\",\n \"other_name\": \"\",\n \"gender\": \"\",\n \"birthday\": \"\",\n \"phone_number\": \"\",\n \"mobile_phone_number\": \"\",\n \"street_address\": \"\",\n \"street_address_ii\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipcode\": \"\",\n \"country\": \"\",\n \"nationalities\": [\n \"\",\n \"\"\n ],\n \"languages\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"graduated_on\": \"\",\n \"withdrawn_on\": \"\",\n \"student_id\": \"\",\n \"homeroom_advisor_id\": \"\",\n \"year_group_id\": \"\",\n \"graduating_year\": \"\",\n \"parent_ids\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/students/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "students", ":id" ], "variable": [ { "key": "id", "value": "", "description": "(Required) Unique identifier for a student." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": \"Access Denied\"\n}" } ] }, { "name": "Archive a Student", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"withdrawn_on\": \"2020/3/27>\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/students/:id/archive", "host": [ "{{baseUrl}}" ], "path": [ "students", ":id", "archive" ], "variable": [ { "key": "id", "value": "", "description": "(Required) Unique identifier for a student." } ] }, "description": "This endpoint archives the student record as specified by student ID. This effectively removes the record from classes, groups, etc. Either the withdrawl date or graduation date must be supplied to provide a reason for the archiving." }, "response": [ { "name": "Success", "originalRequest": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\n \"withdrawn_on\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/students/:id/archive", "host": [ "{{baseUrl}}" ], "path": [ "v2", "students", ":id", "archive" ], "variable": [ { "key": "id", "value": "", "description": "(Required) Unique identifier for a student." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"ok\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\n \"withdrawn_on\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/students/:id/archive", "host": [ "{{baseUrl}}" ], "path": [ "v2", "students", ":id", "archive" ], "variable": [ { "key": "id", "value": "", "description": "(Required) Unique identifier for a student." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": \"Access Denied\"\n}" } ] }, { "name": "Unarchive a Student", "request": { "method": "PUT", "header": [], "url": { "raw": "{{baseUrl}}/students/:id/unarchive", "host": [ "{{baseUrl}}" ], "path": [ "students", ":id", "unarchive" ], "variable": [ { "key": "id", "value": "", "description": "(Required) Unique identifier for a student." } ] }, "description": "This endpoint reverses the archive operation on a student record as specified by ID. This effectively restores the student in classes, groups, etc." }, "response": [ { "name": "Success", "originalRequest": { "method": "PUT", "header": [], "url": { "raw": "{{baseUrl}}/v2/students/:id/unarchive", "host": [ "{{baseUrl}}" ], "path": [ "v2", "students", ":id", "unarchive" ], "variable": [ { "key": "id", "value": "", "description": "(Required) Unique identifier for a student." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"ok\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [], "url": { "raw": "{{baseUrl}}/v2/students/:id/unarchive", "host": [ "{{baseUrl}}" ], "path": [ "v2", "students", ":id", "unarchive" ], "variable": [ { "key": "id", "value": "", "description": "(Required) Unique identifier for a student." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": \"Access Denied\"\n}" } ] } ], "description": "This section describes all the APIs relating to student accounts." }, { "name": "Parents", "item": [ { "name": "Relationships", "item": [ { "name": "Get all Relationships for a Parent", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/parents/:parent_id/children", "host": [ "{{baseUrl}}" ], "path": [ "parents", ":parent_id", "children" ], "query": [ { "key": null, "value": "", "disabled": true } ], "variable": [ { "key": "parent_id", "value": "{{parentId}}" } ] } }, "response": [] }, { "name": "Bulk Update all Relationships for a Parent", "request": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\n \"children\": [\n {\n \"id\": 10948067,\n \"relationship\": \"Mother\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/parents/:parent_id/children/", "host": [ "{{baseUrl}}" ], "path": [ "parents", ":parent_id", "children", "" ], "query": [ { "key": null, "value": "", "disabled": true } ], "variable": [ { "key": "parent_id", "value": "{{parentId}}" } ] } }, "response": [] }, { "name": "Create New Parent-Child relationship", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"child\": [\n {\n \"id\": 10948017,\n \"relationship\": \"Mother\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/parents/:parent_id/children/", "host": [ "{{baseUrl}}" ], "path": [ "parents", ":parent_id", "children", "" ], "query": [ { "key": null, "value": "", "disabled": true } ], "variable": [ { "key": "parent_id", "value": "{{parentId}}" } ] } }, "response": [] }, { "name": "Update a Parent-Child relation", "request": { "method": "PATCH", "header": [], "body": { "mode": "raw", "raw": "{\n \"child\": [\n {\n \"relationship\": \"sdklfjdklf\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/parents/:parent_id/children/:child_id", "host": [ "{{baseUrl}}" ], "path": [ "parents", ":parent_id", "children", ":child_id" ], "query": [ { "key": null, "value": "", "disabled": true } ], "variable": [ { "key": "parent_id", "value": "{{parentId}}" }, { "key": "child_id", "value": "10947632" } ] } }, "response": [] }, { "name": "Delete a Parent-Child relation", "request": { "method": "DELETE", "header": [], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/parents/:parent_id/children/:child_id", "host": [ "{{baseUrl}}" ], "path": [ "parents", ":parent_id", "children", ":child_id" ], "query": [ { "key": null, "value": "", "disabled": true } ], "variable": [ { "key": "parent_id", "value": "{{parentId}}" }, { "key": "child_id", "value": "10947632" } ] } }, "response": [] } ] }, { "name": "Get all Parents", "event": [ { "listen": "test", "script": { "exec": [ "/**", " * Get an overview table of all items returned from the endpoint, useful for when there lists of objects are returned.", " * See comments below for screenshots.", " * ", " * https://gist.github.com/brainysmurf/e45f608b68609f8a0b222ac99b8905d8", " *", " * To use, copy the below code into the \"Tests\" tab of the endpoint", " * Click blue \"Send\" button", " * Click on \"Visualize\" in the Body tile", " * Note that it only displays the returned objects, there's nothing magical that's getting \"all\" objects via pagination", " */", "", " // change to whatever the root property is \"students\" \"year-groups\" whatever", "const entity = \"parents\"; ", "", " // change to the fields you want displayed at first, you can add others interactively", "const columns = ['id', 'email']; ", "", "/**", " * Below not intended for modification (although you can, for version bumps etc)", " */", "const template = `", "", "", "", "
", "", " ", "", "", "", "", "", "", "", " `;", "", "// Set visualizer with template defined below (via hoisting)", "const json = pm.response.json();", "pm.visualizer.set(template, pm.response.json());" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/parents", "host": [ "{{baseUrl}}" ], "path": [ "parents" ], "query": [ { "key": "modified_since", "value": "", "description": "A timestamp to filter the modification date of results.", "disabled": true }, { "key": "page", "value": "", "description": "An integer defining which page to display.", "disabled": true }, { "key": "per_page", "value": "", "description": "An integer defining the number of records to display per page.", "disabled": true }, { "key": "deleted_since", "value": "", "description": "A timestamp to filter the deletion date of results.", "disabled": true }, { "key": "q", "value": "", "description": "A string to search across all fields for.", "disabled": true }, { "key": "", "value": "", "disabled": true } ] }, "description": "This endpoint retrieves all parents. Returns an ID, personal details and the IDs of their associated students." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/parents?modified_since=&page=&per_page=&deleted_since=&q=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "parents" ], "query": [ { "key": "modified_since", "value": "" }, { "key": "page", "value": "" }, { "key": "per_page", "value": "" }, { "key": "deleted_since", "value": "" }, { "key": "q", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"parents\": [\n {\n \"email\": \"\",\n \"first_name\": \"\",\n \"middle_name\": \"\",\n \"password\": \"\",\n \"last_name\": \"\",\n \"nickname\": \"\",\n \"other_name\": \"\",\n \"gender\": \"\",\n \"birthday\": \"\",\n \"phone_number\": \"\",\n \"mobile_phone_number\": \"\",\n \"street_address\": \"\",\n \"street_address_ii\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipcode\": \"\",\n \"country\": \"\",\n \"nationalities\": [\n \"\",\n \"\"\n ],\n \"languages\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"salutation\": \"\",\n \"title\": \"\",\n \"employer\": \"\",\n \"work_email\": \"\",\n \"work_phone\": \"\",\n \"work_address\": \"\",\n \"work_address_ii\": \"\",\n \"work_fax\": \"\",\n \"work_city\": \"\",\n \"work_state\": \"\",\n \"work_postal_code\": \"\",\n \"work_country\": \"\",\n \"child_ids\": [\n \"\",\n \"\"\n ]\n },\n {\n \"email\": \"\",\n \"first_name\": \"\",\n \"middle_name\": \"\",\n \"password\": \"\",\n \"last_name\": \"\",\n \"nickname\": \"\",\n \"other_name\": \"\",\n \"gender\": \"\",\n \"birthday\": \"\",\n \"phone_number\": \"\",\n \"mobile_phone_number\": \"\",\n \"street_address\": \"\",\n \"street_address_ii\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipcode\": \"\",\n \"country\": \"\",\n \"nationalities\": [\n \"\",\n \"\"\n ],\n \"languages\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"salutation\": \"\",\n \"title\": \"\",\n \"employer\": \"\",\n \"work_email\": \"\",\n \"work_phone\": \"\",\n \"work_address\": \"\",\n \"work_address_ii\": \"\",\n \"work_fax\": \"\",\n \"work_city\": \"\",\n \"work_state\": \"\",\n \"work_postal_code\": \"\",\n \"work_country\": \"\",\n \"child_ids\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"meta\": {\n \"current_page\": \"\",\n \"total_pages\": \"\",\n \"total_count\": \"\",\n \"per_page\": \"\"\n }\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/parents?modified_since=&page=&per_page=&deleted_since=&q=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "parents" ], "query": [ { "key": "modified_since", "value": "" }, { "key": "page", "value": "" }, { "key": "per_page", "value": "" }, { "key": "deleted_since", "value": "" }, { "key": "q", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": \"Access Denied\"\n}" } ] }, { "name": "Create New Parent", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"parent\": {\n \"email\": \"\",\n \"first_name\": \"\",\n \"middle_name\": \"\",\n \"password\": \"\",\n \"last_name\": \"\",\n \"nickname\": \"\",\n \"other_name\": \"\",\n \"gender\": \"\",\n \"birthday\": \"\",\n \"phone_number\": \"\",\n \"mobile_phone_number\": \"\",\n \"street_address\": \"\",\n \"street_address_ii\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipcode\": \"\",\n \"country\": \"\",\n \"nationalities\": [\n \"\",\n \"\"\n ],\n \"languages\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"salutation\": \"\",\n \"title\": \"\",\n \"employer\": \"\",\n \"work_email\": \"\",\n \"work_phone\": \"\",\n \"work_address\": \"\",\n \"work_address_ii\": \"\",\n \"work_fax\": \"\",\n \"work_city\": \"\",\n \"work_state\": \"\",\n \"work_postal_code\": \"\",\n \"work_country\": \"\",\n \"child_ids\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/parents", "host": [ "{{baseUrl}}" ], "path": [ "parents" ] }, "description": "This endpoint creates a new parent record. The Content-Type header must be set to application/json, and the request body should contain the field structure as a JSON payload. Note only users with the admin role are able to create users." }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"parent\": {\n \"email\": \"\",\n \"first_name\": \"\",\n \"middle_name\": \"\",\n \"password\": \"\",\n \"last_name\": \"\",\n \"nickname\": \"\",\n \"other_name\": \"\",\n \"gender\": \"\",\n \"birthday\": \"\",\n \"phone_number\": \"\",\n \"mobile_phone_number\": \"\",\n \"street_address\": \"\",\n \"street_address_ii\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipcode\": \"\",\n \"country\": \"\",\n \"nationalities\": [\n \"\",\n \"\"\n ],\n \"languages\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"salutation\": \"\",\n \"title\": \"\",\n \"employer\": \"\",\n \"work_email\": \"\",\n \"work_phone\": \"\",\n \"work_address\": \"\",\n \"work_address_ii\": \"\",\n \"work_fax\": \"\",\n \"work_city\": \"\",\n \"work_state\": \"\",\n \"work_postal_code\": \"\",\n \"work_country\": \"\",\n \"child_ids\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/parents", "host": [ "{{baseUrl}}" ], "path": [ "v2", "parents" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"parent\": {\n \"email\": \"\",\n \"first_name\": \"\",\n \"middle_name\": \"\",\n \"password\": \"\",\n \"last_name\": \"\",\n \"nickname\": \"\",\n \"other_name\": \"\",\n \"gender\": \"\",\n \"birthday\": \"\",\n \"phone_number\": \"\",\n \"mobile_phone_number\": \"\",\n \"street_address\": \"\",\n \"street_address_ii\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipcode\": \"\",\n \"country\": \"\",\n \"nationalities\": [\n \"\",\n \"\"\n ],\n \"languages\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"salutation\": \"\",\n \"title\": \"\",\n \"employer\": \"\",\n \"work_email\": \"\",\n \"work_phone\": \"\",\n \"work_address\": \"\",\n \"work_address_ii\": \"\",\n \"work_fax\": \"\",\n \"work_city\": \"\",\n \"work_state\": \"\",\n \"work_postal_code\": \"\",\n \"work_country\": \"\",\n \"child_ids\": [\n \"\",\n \"\"\n ]\n }\n}" } ] }, { "name": "Get a Parent", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/parents/:id", "host": [ "{{baseUrl}}" ], "path": [ "parents", ":id" ], "variable": [ { "key": "id", "value": "{{parentId}}", "description": "(Required) Unique identifier for a parent." } ] }, "description": "This endpoint retrieves a single parent as specified by ID. It returns personal details and the IDs of their associated students." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/parents/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "parents", ":id" ], "variable": [ { "key": "id", "value": "", "description": "(Required) Unique identifier for a parent." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"parent\": {\n \"email\": \"\",\n \"first_name\": \"\",\n \"middle_name\": \"\",\n \"password\": \"\",\n \"last_name\": \"\",\n \"nickname\": \"\",\n \"other_name\": \"\",\n \"gender\": \"\",\n \"birthday\": \"\",\n \"phone_number\": \"\",\n \"mobile_phone_number\": \"\",\n \"street_address\": \"\",\n \"street_address_ii\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipcode\": \"\",\n \"country\": \"\",\n \"nationalities\": [\n \"\",\n \"\"\n ],\n \"languages\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"salutation\": \"\",\n \"title\": \"\",\n \"employer\": \"\",\n \"work_email\": \"\",\n \"work_phone\": \"\",\n \"work_address\": \"\",\n \"work_address_ii\": \"\",\n \"work_fax\": \"\",\n \"work_city\": \"\",\n \"work_state\": \"\",\n \"work_postal_code\": \"\",\n \"work_country\": \"\",\n \"child_ids\": [\n \"\",\n \"\"\n ]\n }\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/parents/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "parents", ":id" ], "variable": [ { "key": "id", "value": "", "description": "(Required) Unique identifier for a parent." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": \"Access Denied\"\n}" }, { "name": "Not found.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/parents/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "parents", ":id" ], "variable": [ { "key": "id", "value": "", "description": "(Required) Unique identifier for a parent." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": \"Couldn't find User with 'id'=12345\"\n}" } ] }, { "name": "Update a Parent", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"parent\": {\n \"email\": \"\",\n \"first_name\": \"\",\n \"middle_name\": \"\",\n \"password\": \"\",\n \"last_name\": \"\",\n \"nickname\": \"\",\n \"other_name\": \"\",\n \"gender\": \"\",\n \"birthday\": \"\",\n \"phone_number\": \"\",\n \"mobile_phone_number\": \"\",\n \"street_address\": \"\",\n \"street_address_ii\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipcode\": \"\",\n \"country\": \"\",\n \"nationalities\": [\n \"\",\n \"\"\n ],\n \"languages\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"salutation\": \"\",\n \"title\": \"\",\n \"employer\": \"\",\n \"work_email\": \"\",\n \"work_phone\": \"\",\n \"work_address\": \"\",\n \"work_address_ii\": \"\",\n \"work_fax\": \"\",\n \"work_city\": \"\",\n \"work_state\": \"\",\n \"work_postal_code\": \"\",\n \"work_country\": \"\",\n \"child_ids\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/parents/:id", "host": [ "{{baseUrl}}" ], "path": [ "parents", ":id" ], "variable": [ { "key": "id", "value": "{{parentId}}", "description": "(Required) Unique identifier for a parent." } ] }, "description": "This endpoint updates a parent record as specified by ID. The Content-Type header must be set to application/json, and the request body should contain the fields you want to update as a JSON payload.
Only users with the admin role are able to update users." }, "response": [ { "name": "Success", "originalRequest": { "method": "PATCH", "header": [], "body": { "mode": "raw", "raw": "{\n \"parent\": {\n \"email\": \"\",\n \"first_name\": \"\",\n \"middle_name\": \"\",\n \"password\": \"\",\n \"last_name\": \"\",\n \"nickname\": \"\",\n \"other_name\": \"\",\n \"gender\": \"\",\n \"birthday\": \"\",\n \"phone_number\": \"\",\n \"mobile_phone_number\": \"\",\n \"street_address\": \"\",\n \"street_address_ii\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipcode\": \"\",\n \"country\": \"\",\n \"nationalities\": [\n \"\",\n \"\"\n ],\n \"languages\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"salutation\": \"\",\n \"title\": \"\",\n \"employer\": \"\",\n \"work_email\": \"\",\n \"work_phone\": \"\",\n \"work_address\": \"\",\n \"work_address_ii\": \"\",\n \"work_fax\": \"\",\n \"work_city\": \"\",\n \"work_state\": \"\",\n \"work_postal_code\": \"\",\n \"work_country\": \"\",\n \"child_ids\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/parents/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "parents", ":id" ], "variable": [ { "key": "id", "value": "", "description": "(Required) Unique identifier for a parent." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"parent\": {\n \"email\": \"\",\n \"first_name\": \"\",\n \"middle_name\": \"\",\n \"password\": \"\",\n \"last_name\": \"\",\n \"nickname\": \"\",\n \"other_name\": \"\",\n \"gender\": \"\",\n \"birthday\": \"\",\n \"phone_number\": \"\",\n \"mobile_phone_number\": \"\",\n \"street_address\": \"\",\n \"street_address_ii\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipcode\": \"\",\n \"country\": \"\",\n \"nationalities\": [\n \"\",\n \"\"\n ],\n \"languages\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"salutation\": \"\",\n \"title\": \"\",\n \"employer\": \"\",\n \"work_email\": \"\",\n \"work_phone\": \"\",\n \"work_address\": \"\",\n \"work_address_ii\": \"\",\n \"work_fax\": \"\",\n \"work_city\": \"\",\n \"work_state\": \"\",\n \"work_postal_code\": \"\",\n \"work_country\": \"\",\n \"child_ids\": [\n \"\",\n \"\"\n ]\n }\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "PATCH", "header": [], "body": { "mode": "raw", "raw": "{\n \"parent\": {\n \"email\": \"\",\n \"first_name\": \"\",\n \"middle_name\": \"\",\n \"password\": \"\",\n \"last_name\": \"\",\n \"nickname\": \"\",\n \"other_name\": \"\",\n \"gender\": \"\",\n \"birthday\": \"\",\n \"phone_number\": \"\",\n \"mobile_phone_number\": \"\",\n \"street_address\": \"\",\n \"street_address_ii\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipcode\": \"\",\n \"country\": \"\",\n \"nationalities\": [\n \"\",\n \"\"\n ],\n \"languages\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"salutation\": \"\",\n \"title\": \"\",\n \"employer\": \"\",\n \"work_email\": \"\",\n \"work_phone\": \"\",\n \"work_address\": \"\",\n \"work_address_ii\": \"\",\n \"work_fax\": \"\",\n \"work_city\": \"\",\n \"work_state\": \"\",\n \"work_postal_code\": \"\",\n \"work_country\": \"\",\n \"child_ids\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/parents/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "parents", ":id" ], "variable": [ { "key": "id", "value": "", "description": "(Required) Unique identifier for a parent." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": \"Access Denied\"\n}" } ] }, { "name": "Archive a Parent", "request": { "method": "PUT", "header": [], "url": { "raw": "{{baseUrl}}/parents/:id/archive", "host": [ "{{baseUrl}}" ], "path": [ "parents", ":id", "archive" ], "variable": [ { "key": "id", "value": "", "description": "(Required) Unique identifier for a parent." } ] }, "description": "This endpoint archives a parent record as specified by ID. This effectively removes the parent from groups they are members of." }, "response": [ { "name": "Success", "originalRequest": { "method": "PUT", "header": [], "url": { "raw": "{{baseUrl}}/v2/parents/:id/archive", "host": [ "{{baseUrl}}" ], "path": [ "v2", "parents", ":id", "archive" ], "variable": [ { "key": "id", "value": "", "description": "(Required) Unique identifier for a parent." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"ok\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [], "url": { "raw": "{{baseUrl}}/v2/parents/:id/archive", "host": [ "{{baseUrl}}" ], "path": [ "v2", "parents", ":id", "archive" ], "variable": [ { "key": "id", "value": "", "description": "(Required) Unique identifier for a parent." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": \"Access Denied\"\n}" } ] }, { "name": "Unarchive a Parent", "request": { "method": "PUT", "header": [], "url": { "raw": "{{baseUrl}}/parents/:id/unarchive", "host": [ "{{baseUrl}}" ], "path": [ "parents", ":id", "unarchive" ], "variable": [ { "key": "id", "value": "", "description": "(Required) Unique identifier for a parent." } ] }, "description": "This endpoint reverses the archive operation on the parent record as specified by ID. This effectively restores the parent’s group memberships." }, "response": [ { "name": "Success", "originalRequest": { "method": "PUT", "header": [], "url": { "raw": "{{baseUrl}}/v2/parents/:id/unarchive", "host": [ "{{baseUrl}}" ], "path": [ "v2", "parents", ":id", "unarchive" ], "variable": [ { "key": "id", "value": "", "description": "(Required) Unique identifier for a parent." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"ok\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "PUT", "header": [], "url": { "raw": "{{baseUrl}}/v2/parents/:id/unarchive", "host": [ "{{baseUrl}}" ], "path": [ "v2", "parents", ":id", "unarchive" ], "variable": [ { "key": "id", "value": "", "description": "(Required) Unique identifier for a parent." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": \"Access Denied\"\n}" } ] } ], "description": "This section describes all the APIs relating to parent accounts." }, { "name": "Teachers", "item": [ { "name": "Get all Teachers", "event": [ { "listen": "test", "script": { "exec": [ "/**", " * Get an overview table of all items returned from the endpoint, useful for when there lists of objects are returned.", " * See comments below for screenshots.", " * ", " * https://gist.github.com/brainysmurf/e45f608b68609f8a0b222ac99b8905d8", " *", " * To use, copy the below code into the \"Tests\" tab of the endpoint", " * Click blue \"Send\" button", " * Click on \"Visualize\" in the Body tile", " * Note that it only displays the returned objects, there's nothing magical that's getting \"all\" objects via pagination", " */", "", " // change to whatever the root property is \"students\" \"year-groups\" whatever", "const entity = \"teachers\"; ", "", " // change to the fields you want displayed at first, you can add others interactively", "const columns = ['id', 'email']; ", "", "/**", " * Below not intended for modification (although you can, for version bumps etc)", " */", "const template = `", "", "", "", "
", "", " ", "", "", "", "", "", "", "", " `;", "", "// Set visualizer with template defined below (via hoisting)", "const json = pm.response.json();", "pm.visualizer.set(template, pm.response.json());" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teachers", "host": [ "{{baseUrl}}" ], "path": [ "teachers" ], "query": [ { "key": "modified_since", "value": "", "description": "A timestamp to filter results by modification date.", "disabled": true }, { "key": "page", "value": "", "description": "An integer defining which page to display.", "disabled": true }, { "key": "per_page", "value": "", "description": "An integer defining the number of records to display per page.", "disabled": true }, { "key": "deleted_since", "value": "", "description": "A timestamp to filter results by deletion date of records.", "disabled": true }, { "key": "q", "value": "", "description": "A string to search across all fields for.", "disabled": true } ] }, "description": "This endpoint retrieves all teachers it returns teacher ID and personal details." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/teachers?modified_since=&page=&per_page=&deleted_since=&q=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "teachers" ], "query": [ { "key": "modified_since", "value": "" }, { "key": "page", "value": "" }, { "key": "per_page", "value": "" }, { "key": "deleted_since", "value": "" }, { "key": "q", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"teachers\": [\n {\n \"email\": \"\",\n \"first_name\": \"\",\n \"middle_name\": \"\",\n \"password\": \"\",\n \"last_name\": \"\",\n \"nickname\": \"\",\n \"other_name\": \"\",\n \"gender\": \"\",\n \"birthday\": \"\",\n \"phone_number\": \"\",\n \"mobile_phone_number\": \"\",\n \"street_address\": \"\",\n \"street_address_ii\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipcode\": \"\",\n \"country\": \"\",\n \"nationalities\": [\n \"\",\n \"\"\n ],\n \"languages\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"role\": \"\",\n \"programs\": [\n \"\",\n \"\"\n ]\n },\n {\n \"email\": \"\",\n \"first_name\": \"\",\n \"middle_name\": \"\",\n \"password\": \"\",\n \"last_name\": \"\",\n \"nickname\": \"\",\n \"other_name\": \"\",\n \"gender\": \"\",\n \"birthday\": \"\",\n \"phone_number\": \"\",\n \"mobile_phone_number\": \"\",\n \"street_address\": \"\",\n \"street_address_ii\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipcode\": \"\",\n \"country\": \"\",\n \"nationalities\": [\n \"\",\n \"\"\n ],\n \"languages\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"role\": \"\",\n \"programs\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"meta\": {\n \"current_page\": \"\",\n \"total_pages\": \"\",\n \"total_count\": \"\",\n \"per_page\": \"\"\n }\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/teachers?modified_since=&page=&per_page=&deleted_since=&q=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "teachers" ], "query": [ { "key": "modified_since", "value": "" }, { "key": "page", "value": "" }, { "key": "per_page", "value": "" }, { "key": "deleted_since", "value": "" }, { "key": "q", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": \"Access Denied\"\n}" } ] }, { "name": "Create New Teacher", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"teacher\": {\n \"email\": \"\",\n \"first_name\": \"\",\n \"middle_name\": \"\",\n \"password\": \"\",\n \"last_name\": \"\",\n \"nickname\": \"\",\n \"other_name\": \"\",\n \"gender\": \"\",\n \"birthday\": \"\",\n \"phone_number\": \"\",\n \"mobile_phone_number\": \"\",\n \"street_address\": \"\",\n \"street_address_ii\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipcode\": \"\",\n \"country\": \"\",\n \"nationalities\": [\n \"\",\n \"\"\n ],\n \"languages\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"role\": \"\",\n \"programs\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/teachers", "host": [ "{{baseUrl}}" ], "path": [ "teachers" ] }, "description": "This endpoint creates a new teacher record. Note, the Content-Type header must be set to application/json,\nand the request body should contain the field structure as a JSON payload. Only users with admin role\nare able to update users.\n" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"teacher\": {\n \"email\": \"\",\n \"first_name\": \"\",\n \"middle_name\": \"\",\n \"password\": \"\",\n \"last_name\": \"\",\n \"nickname\": \"\",\n \"other_name\": \"\",\n \"gender\": \"\",\n \"birthday\": \"\",\n \"phone_number\": \"\",\n \"mobile_phone_number\": \"\",\n \"street_address\": \"\",\n \"street_address_ii\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipcode\": \"\",\n \"country\": \"\",\n \"nationalities\": [\n \"\",\n \"\"\n ],\n \"languages\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"role\": \"\",\n \"programs\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/teachers", "host": [ "{{baseUrl}}" ], "path": [ "v2", "teachers" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"teacher\": {\n \"email\": \"\",\n \"first_name\": \"\",\n \"middle_name\": \"\",\n \"password\": \"\",\n \"last_name\": \"\",\n \"nickname\": \"\",\n \"other_name\": \"\",\n \"gender\": \"\",\n \"birthday\": \"\",\n \"phone_number\": \"\",\n \"mobile_phone_number\": \"\",\n \"street_address\": \"\",\n \"street_address_ii\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipcode\": \"\",\n \"country\": \"\",\n \"nationalities\": [\n \"\",\n \"\"\n ],\n \"languages\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"role\": \"\",\n \"programs\": [\n \"\",\n \"\"\n ]\n }\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"teacher\": {\n \"email\": \"\",\n \"first_name\": \"\",\n \"middle_name\": \"\",\n \"password\": \"\",\n \"last_name\": \"\",\n \"nickname\": \"\",\n \"other_name\": \"\",\n \"gender\": \"\",\n \"birthday\": \"\",\n \"phone_number\": \"\",\n \"mobile_phone_number\": \"\",\n \"street_address\": \"\",\n \"street_address_ii\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipcode\": \"\",\n \"country\": \"\",\n \"nationalities\": [\n \"\",\n \"\"\n ],\n \"languages\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"role\": \"\",\n \"programs\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/teachers", "host": [ "{{baseUrl}}" ], "path": [ "v2", "teachers" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": \"Access Denied\"\n}" } ] }, { "name": "Get a Teacher", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teachers/:id", "host": [ "{{baseUrl}}" ], "path": [ "teachers", ":id" ], "variable": [ { "key": "id", "value": "{{teacherId}}", "description": "(Required) Unique identifier for a teacher." } ] }, "description": "This endpoint retrieves a teacher as specified by teacher ID. It returns the ID and contact details." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/teachers/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "teachers", ":id" ], "variable": [ { "key": "id", "value": "", "description": "(Required) Unique identifier for a teacher." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"teacher\": {\n \"email\": \"\",\n \"first_name\": \"\",\n \"middle_name\": \"\",\n \"password\": \"\",\n \"last_name\": \"\",\n \"nickname\": \"\",\n \"other_name\": \"\",\n \"gender\": \"\",\n \"birthday\": \"\",\n \"phone_number\": \"\",\n \"mobile_phone_number\": \"\",\n \"street_address\": \"\",\n \"street_address_ii\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipcode\": \"\",\n \"country\": \"\",\n \"nationalities\": [\n \"\",\n \"\"\n ],\n \"languages\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"role\": \"\",\n \"programs\": [\n \"\",\n \"\"\n ]\n }\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/teachers/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "teachers", ":id" ], "variable": [ { "key": "id", "value": "", "description": "(Required) Unique identifier for a teacher." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": \"Access Denied\"\n}" }, { "name": "Not found.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/teachers/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "teachers", ":id" ], "variable": [ { "key": "id", "value": "", "description": "(Required) Unique identifier for a teacher." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": \"Couldn't find User with 'id'=12345\"\n}" } ] }, { "name": "Get Teacher Classes", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teachers/:id/classes", "host": [ "{{baseUrl}}" ], "path": [ "teachers", ":id", "classes" ], "variable": [ { "key": "id", "value": "{{teacherId}}", "description": "The ID of the teacher" } ] } }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "v2/teachers/:id/classes", "host": [ "v2" ], "path": [ "teachers", ":id", "classes" ], "variable": [ { "key": "id", "value": "", "description": "The ID of the teacher" } ] } }, "_postman_previewlanguage": "json", "header": null, "cookie": [], "body": "{\n \"classes\": [\n {\n \"show_on_reports\": true,\n \"id\": 11706009,\n \"name\": \"IB PYP English (Grade 1) AM\",\n \"uniq_id\": \"G1-AM\",\n \"archived\": false,\n \"start_term_id\": 169995,\n \"end_term_id\": 169996\n },\n {\n \"show_on_reports\": true,\n \"id\": 11745901,\n \"name\": \"IB PYP Homeroom (Grade 4)\",\n \"uniq_id\": \"\",\n \"archived\": false,\n \"start_term_id\": 169995,\n \"end_term_id\": 169996\n },\n {\n \"show_on_reports\": true,\n \"id\": 11900539,\n \"name\": \"IB DP dsdf HL (Grade 11) sdfsd\",\n \"uniq_id\": \"sdf\",\n \"archived\": false,\n \"start_term_id\": 170001,\n \"end_term_id\": 170002\n },\n {\n \"show_on_reports\": true,\n \"id\": 11912573,\n \"name\": \"IB PYP Adam PYP Response Test (Grade 1) test\",\n \"uniq_id\": \"test\",\n \"archived\": false,\n \"start_term_id\": 169995,\n \"end_term_id\": 169996\n }\n ]\n}" } ] }, { "name": "Get Teacher Groups", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teachers/:id/classes", "host": [ "{{baseUrl}}" ], "path": [ "teachers", ":id", "classes" ], "variable": [ { "key": "id", "value": "{{teacherId}}", "description": "The ID of the teacher" } ] } }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "v2/teachers/:id/classes", "host": [ "v2" ], "path": [ "teachers", ":id", "classes" ], "variable": [ { "key": "id", "value": "", "description": "The ID of the teacher" } ] } }, "_postman_previewlanguage": "json", "header": null, "cookie": [], "body": "{\n \"groups\": [\n {\n \"id\": 11922903,\n \"name\": \"Group\",\n \"archived\": false,\n \"group_advisor\": true,\n \"primary_group_advisor\": false\n }\n ]\n}" } ] }, { "name": "Update a Teacher", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"teacher\": {\n \"email\": \"\",\n \"first_name\": \"\",\n \"middle_name\": \"\",\n \"password\": \"\",\n \"last_name\": \"\",\n \"nickname\": \"\",\n \"other_name\": \"\",\n \"gender\": \"\",\n \"birthday\": \"\",\n \"phone_number\": \"\",\n \"mobile_phone_number\": \"\",\n \"street_address\": \"\",\n \"street_address_ii\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipcode\": \"\",\n \"country\": \"\",\n \"nationalities\": [\n \"\",\n \"\"\n ],\n \"languages\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"role\": \"\",\n \"programs\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/teachers/:id", "host": [ "{{baseUrl}}" ], "path": [ "teachers", ":id" ], "variable": [ { "key": "id", "value": "{{teacherId}}", "description": "(Required) A numeric value that specifies a Teacher id." } ] }, "description": "This endpoint updates a teacher record, as specified by the teacher ID. Note, the Content-Type header must be set to application/json, and the request body should contain the fields you want to update as a JSON payload. Only users with admin role are able to update users." }, "response": [ { "name": "Success", "originalRequest": { "method": "PATCH", "header": [], "body": { "mode": "raw", "raw": "{\n \"teacher\": {\n \"email\": \"\",\n \"first_name\": \"\",\n \"middle_name\": \"\",\n \"password\": \"\",\n \"last_name\": \"\",\n \"nickname\": \"\",\n \"other_name\": \"\",\n \"gender\": \"\",\n \"birthday\": \"\",\n \"phone_number\": \"\",\n \"mobile_phone_number\": \"\",\n \"street_address\": \"\",\n \"street_address_ii\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipcode\": \"\",\n \"country\": \"\",\n \"nationalities\": [\n \"\",\n \"\"\n ],\n \"languages\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"role\": \"\",\n \"programs\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/teachers/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "teachers", ":id" ], "variable": [ { "key": "id", "value": "", "description": "(Required) A numeric value that specifies a Teacher id." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"teacher\": {\n \"id\": 2147,\n \"email\": \"s.banderad@eduvo.com\",\n \"first_name\": \"Sharon\",\n \"last_name\": \"Arese\",\n \"archived\": false,\n \"gender\": \"Male\",\n \"street_address\": \"9 Lindbergh Center\",\n \"city\": \"Hawthorne\",\n \"state\": \"86249\",\n \"zipcode\": \"55539\",\n \"country\": \"NR\",\n \"programs\": [],\n \"nationalities\": [],\n \"languages\": [],\n \"role\": \"Advisor\"\n }\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "PATCH", "header": [], "body": { "mode": "raw", "raw": "{\n \"teacher\": {\n \"email\": \"\",\n \"first_name\": \"\",\n \"middle_name\": \"\",\n \"password\": \"\",\n \"last_name\": \"\",\n \"nickname\": \"\",\n \"other_name\": \"\",\n \"gender\": \"\",\n \"birthday\": \"\",\n \"phone_number\": \"\",\n \"mobile_phone_number\": \"\",\n \"street_address\": \"\",\n \"street_address_ii\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipcode\": \"\",\n \"country\": \"\",\n \"nationalities\": [\n \"\",\n \"\"\n ],\n \"languages\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"role\": \"\",\n \"programs\": [\n \"\",\n \"\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/teachers/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "teachers", ":id" ], "variable": [ { "key": "id", "value": "", "description": "(Required) A numeric value that specifies a Teacher id." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": \"Access Denied\"\n}" } ] } ], "description": "This section describes all the APIs relating to teacher accounts." }, { "name": "Classes", "item": [ { "name": "Get all Classes", "event": [ { "listen": "test", "script": { "exec": [ "/**", " * Get an overview table of all items returned from the endpoint, useful for when there lists of objects are returned.", " * See comments below for screenshots.", " * ", " * https://gist.github.com/brainysmurf/e45f608b68609f8a0b222ac99b8905d8", " *", " * To use, copy the below code into the \"Tests\" tab of the endpoint", " * Click blue \"Send\" button", " * Click on \"Visualize\" in the Body tile", " * Note that it only displays the returned objects, there's nothing magical that's getting \"all\" objects via pagination", " */", "", " // change to whatever the root property is \"students\" \"year-groups\" whatever", "const entity = \"teachers\"; ", "", " // change to the fields you want displayed at first, you can add others interactively", "const columns = ['id', 'email']; ", "", "/**", " * Below not intended for modification (although you can, for version bumps etc)", " */", "const template = `", "", "", "", "
", "", " ", "", "", "", "", "", "", "", " `;", "", "// Set visualizer with template defined below (via hoisting)", "const json = pm.response.json();", "pm.visualizer.set(template, pm.response.json());" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/classes", "host": [ "{{baseUrl}}" ], "path": [ "classes" ], "query": [ { "key": "modified_since", "value": "", "description": "A timestamp to filter results by modification date.", "disabled": true }, { "key": "page", "value": "", "description": "An integer defining which page to display.", "disabled": true }, { "key": "per_page", "value": "", "description": "An integer defining the number of records to display per page.", "disabled": true }, { "key": "deleted_since", "value": "", "description": "A timestamp to filter results by deletion date of records.", "disabled": true }, { "key": "q", "value": "", "description": "A string to search across all fields for.", "disabled": true } ] }, "description": "This endpoint retrieves all classes. It returns class name, class ID, grade, program, and any School-defined values." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/classes", "host": [ "{{baseUrl}}" ], "path": [ "v2", "classes" ], "query": [ { "key": "modified_since", "value": "", "disabled": true }, { "key": "page", "value": "", "disabled": true }, { "key": "per_page", "value": "", "disabled": true }, { "key": "archived", "value": "", "disabled": true } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"classes\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"uniq_id\": \"\",\n \"class_section\": \"\",\n \"start_term_id\": \"\",\n \"end_term_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"grade\": \"\",\n \"grade_number\": \"\",\n \"applicable_levels\": [\n \"\",\n \"\"\n ],\n \"program\": \"\",\n \"program_code\": \"\",\n \"subject_id\": \"\",\n \"subject_name\": \"\",\n \"subject_group\": \"\",\n \"subject_option\": \"\",\n \"teachers\": [\n {\n \"email\": \"\",\n \"first_name\": \"\",\n \"middle_name\": \"\",\n \"password\": \"\",\n \"last_name\": \"\",\n \"nickname\": \"\",\n \"other_name\": \"\",\n \"gender\": \"\",\n \"birthday\": \"\",\n \"phone_number\": \"\",\n \"mobile_phone_number\": \"\",\n \"street_address\": \"\",\n \"street_address_ii\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipcode\": \"\",\n \"country\": \"\",\n \"nationalities\": [\n \"\",\n \"\"\n ],\n \"languages\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"role\": \"\",\n \"programs\": [\n \"\",\n \"\"\n ]\n },\n {\n \"email\": \"\",\n \"first_name\": \"\",\n \"middle_name\": \"\",\n \"password\": \"\",\n \"last_name\": \"\",\n \"nickname\": \"\",\n \"other_name\": \"\",\n \"gender\": \"\",\n \"birthday\": \"\",\n \"phone_number\": \"\",\n \"mobile_phone_number\": \"\",\n \"street_address\": \"\",\n \"street_address_ii\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipcode\": \"\",\n \"country\": \"\",\n \"nationalities\": [\n \"\",\n \"\"\n ],\n \"languages\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"role\": \"\",\n \"programs\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"uniq_id\": \"\",\n \"class_section\": \"\",\n \"start_term_id\": \"\",\n \"end_term_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"grade\": \"\",\n \"grade_number\": \"\",\n \"applicable_levels\": [\n \"\",\n \"\"\n ],\n \"program\": \"\",\n \"program_code\": \"\",\n \"subject_id\": \"\",\n \"subject_name\": \"\",\n \"subject_group\": \"\",\n \"subject_option\": \"\",\n \"teachers\": [\n {\n \"email\": \"\",\n \"first_name\": \"\",\n \"middle_name\": \"\",\n \"password\": \"\",\n \"last_name\": \"\",\n \"nickname\": \"\",\n \"other_name\": \"\",\n \"gender\": \"\",\n \"birthday\": \"\",\n \"phone_number\": \"\",\n \"mobile_phone_number\": \"\",\n \"street_address\": \"\",\n \"street_address_ii\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipcode\": \"\",\n \"country\": \"\",\n \"nationalities\": [\n \"\",\n \"\"\n ],\n \"languages\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"role\": \"\",\n \"programs\": [\n \"\",\n \"\"\n ]\n },\n {\n \"email\": \"\",\n \"first_name\": \"\",\n \"middle_name\": \"\",\n \"password\": \"\",\n \"last_name\": \"\",\n \"nickname\": \"\",\n \"other_name\": \"\",\n \"gender\": \"\",\n \"birthday\": \"\",\n \"phone_number\": \"\",\n \"mobile_phone_number\": \"\",\n \"street_address\": \"\",\n \"street_address_ii\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipcode\": \"\",\n \"country\": \"\",\n \"nationalities\": [\n \"\",\n \"\"\n ],\n \"languages\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"role\": \"\",\n \"programs\": [\n \"\",\n \"\"\n ]\n }\n ]\n }\n ],\n \"meta\": {\n \"current_page\": \"\",\n \"total_pages\": \"\",\n \"total_count\": \"\",\n \"per_page\": \"\"\n }\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/classes?modified_since=&page=&per_page=&archived=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "classes" ], "query": [ { "key": "modified_since", "value": "" }, { "key": "page", "value": "" }, { "key": "per_page", "value": "" }, { "key": "archived", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": \"Access Denied\"\n}" } ] }, { "name": "Get all Grades for a Class during an Academic Term", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/classes/:class_id/assessments/term/:term_id/grades", "host": [ "{{baseUrl}}" ], "path": [ "classes", ":class_id", "assessments", "term", ":term_id", "grades" ], "query": [ { "key": "include_archived_students", "value": "", "description": "Include archived students in the response.", "disabled": true } ], "variable": [ { "key": "class_id", "value": "{{classId}}", "description": "(Required) Unique identifier for class." }, { "key": "term_id", "value": "{{termId}}", "description": "(Required) Unique identifier for term." } ] }, "description": "This endpoint retrieves all gradebook grades belonging to a class for a term, as specified by term ID and class ID. The returned fields for each task can include:\n - `group_mark`\n > The percentage achieved on the task is converted using the grade scale set for the program, and the result is returned as group_mark.\n - `score`\n > The number of points a student achieved on the task.\n - `max_points`\n > The available number of points for the task." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/classes/:class_id/assessments/term/:term_id/grades?include_archived_students=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "classes", ":class_id", "assessments", "term", ":term_id", "grades" ], "query": [ { "key": "include_archived_students", "value": "" } ], "variable": [ { "key": "class_id", "value": "", "description": "(Required) Unique identifier for class." }, { "key": "term_id", "value": "", "description": "(Required) Unique identifier for term." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"students\": [\n {\n \"id\": 12068821,\n \"name\": \"Epelbaum, Chloe\",\n \"assignments\": [\n {\n \"id\": 18376636,\n \"name\": \"Short Story Analysis Quiz\",\n \"group_mark\": 5,\n \"comment\": null,\n \"score\": 22,\n \"max_points\": 32\n },\n {\n \"id\": 18376694,\n \"name\": \"Write a Short Story Themed on Katharine Mansfield\",\n \"group_mark\": 7,\n \"comment\": null,\n \"score\": 5,\n \"max_points\": 5\n },\n {\n \"id\": 18376845,\n \"name\": \"Read a Selected Short Story by Anton Chekhov\",\n \"group_mark\": 7,\n \"comment\": \"Great analysis, the improvement is noticeable\",\n \"score\": 11,\n \"max_points\": 12\n },\n {\n \"id\": 18376852,\n \"name\": \"Gwendolyn Brooks Seminar\",\n \"group_mark\": 7,\n \"comment\": \"Your presentation included insightful analysis of The Near-Johannesburg Boy\",\n \"score\": 19,\n \"max_points\": 20\n },\n {\n \"id\": 18376858,\n \"name\": \"Practice Commentary\",\n \"group_mark\": 4,\n \"comment\": \"Your commentary shows a lack of understanding about how form is used to convey the message of the extract\",\n \"score\": 14,\n \"max_points\": 21\n }\n ]\n },\n {\n \"id\": 12068757,\n \"name\": \"Evans, Raymond\",\n \"assignments\": [\n {\n \"id\": 18376636,\n \"name\": \"Short Story Analysis Quiz\",\n \"group_mark\": 7,\n \"comment\": \"Impressive analysis.\",\n \"score\": 29,\n \"max_points\": 32\n },\n {\n \"id\": 18376694,\n \"name\": \"Write a Short Story Themed on Katharine Mansfield\",\n \"group_mark\": 7,\n \"comment\": null,\n \"score\": 5,\n \"max_points\": 5\n },\n {\n \"id\": 18376845,\n \"name\": \"Read a Selected Short Story by Anton Chekhov\",\n \"group_mark\": 5,\n \"comment\": null,\n \"score\": 9,\n \"max_points\": 12\n },\n {\n \"id\": 18376852,\n \"name\": \"Gwendolyn Brooks Seminar\",\n \"group_mark\": 5,\n \"comment\": null,\n \"score\": 16,\n \"max_points\": 21\n }\n ]\n }\n ],\n \"meta\": {\n \"current_page\": 1,\n \"total_pages\": 1,\n \"total_count\": 2,\n \"per_page\": 100\n }\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/classes/:class_id/assessments/term/:term_id/grades?include_archived_students=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "classes", ":class_id", "assessments", "term", ":term_id", "grades" ], "query": [ { "key": "include_archived_students", "value": "" } ], "variable": [ { "key": "class_id", "value": "", "description": "(Required) Unique identifier for class." }, { "key": "term_id", "value": "", "description": "(Required) Unique identifier for term." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": \"Access Denied\"\n}" }, { "name": "DP Class Example", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/classes/:class_id/assessments/term/:term_id/grades", "host": [ "{{baseUrl}}" ], "path": [ "v2", "classes", ":class_id", "assessments", "term", ":term_id", "grades" ], "query": [ { "key": "include_archived_students", "value": "", "description": "Include archived students in the response.", "disabled": true } ], "variable": [ { "key": "class_id", "value": "{{classId}}", "description": "(Required) Unique identifier for class." }, { "key": "term_id", "value": "{{termId}}", "description": "(Required) Unique identifier for term." } ] } }, "_postman_previewlanguage": null, "header": null, "cookie": [], "body": null }, { "name": "MYP Example", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/classes/:class_id/assessments/term/:term_id/grades", "host": [ "{{baseUrl}}" ], "path": [ "v2", "classes", ":class_id", "assessments", "term", ":term_id", "grades" ], "query": [ { "key": "include_archived_students", "value": "", "description": "Include archived students in the response.", "disabled": true } ], "variable": [ { "key": "class_id", "value": "{{classId}}", "description": "(Required) Unique identifier for class." }, { "key": "term_id", "value": "{{termId}}", "description": "(Required) Unique identifier for term." } ] } }, "_postman_previewlanguage": "json", "header": null, "cookie": [], "body": "{\n \"meta\": {\n \"current_page\": 1,\n \"total_pages\": 1,\n \"total_count\": 4,\n \"per_page\": 100\n },\n \"students\": [\n {\n \"student\": {\n \"id\": 10752658,\n \"name\": \"Beger, 晹Max\"\n },\n \"assignment_grades\": [\n {\n \"task_id\": 11866019,\n \"task_name\": \"Hidden task\",\n \"score\": 5,\n \"max_score\": 10,\n \"criterion_grades\": [\n {\n \"label\": \"A\",\n \"criterion\": \"Analysing\",\n \"score\": 4\n }\n ],\n \"comment\": null\n },\n {\n \"task_id\": 11866020,\n \"task_name\": \"Task assessment is shown\",\n \"score\": 2,\n \"max_score\": 10,\n \"criterion_grades\": [\n {\n \"label\": \"A\",\n \"criterion\": \"Analysing\",\n \"score\": 2\n }\n ],\n \"comment\": null\n },\n {\n \"task_id\": 11866306,\n \"task_name\": \"New Task 4 criteria\",\n \"criterion_grades\": [\n {\n \"label\": \"A\",\n \"criterion\": \"Analysing\",\n \"score\": null\n },\n {\n \"label\": \"B\",\n \"criterion\": \"Organizing\",\n \"score\": null\n },\n {\n \"label\": \"C\",\n \"criterion\": \"Producing text\",\n \"score\": null\n },\n {\n \"label\": \"D\",\n \"criterion\": \"Using language\",\n \"score\": null\n }\n ],\n \"comment\": null\n },\n {\n \"task_id\": 11864295,\n \"task_name\": \"test 1\",\n \"score\": null,\n \"max_score\": 100,\n \"criterion_grades\": [\n {\n \"label\": \"A\",\n \"criterion\": \"Analysing\",\n \"score\": null\n },\n {\n \"label\": \"B\",\n \"criterion\": \"Organizing\",\n \"score\": null\n },\n {\n \"label\": \"C\",\n \"criterion\": \"Producing text\",\n \"score\": null\n },\n {\n \"label\": \"D\",\n \"criterion\": \"Using language\",\n \"score\": null\n }\n ],\n \"comment\": null\n },\n {\n \"task_id\": 11864296,\n \"task_name\": \"test with task-specific clarification\",\n \"criterion_grades\": [\n {\n \"label\": \"A\",\n \"criterion\": \"Analysing\",\n \"score\": null\n }\n ],\n \"comment\": null\n },\n {\n \"task_id\": 11865585,\n \"task_name\": \"Homework for Students to read\",\n \"score\": null,\n \"max_score\": 25,\n \"comment\": null\n },\n {\n \"task_id\": 11865584,\n \"task_name\": \"Test task for Gradebook view\",\n \"criterion_grades\": [\n {\n \"label\": \"A\",\n \"criterion\": \"Analysing\",\n \"score\": null\n },\n {\n \"label\": \"B\",\n \"criterion\": \"Organizing\",\n \"score\": null\n }\n ],\n \"comment\": null\n },\n {\n \"task_id\": 11865586,\n \"task_name\": \"New task for following week\",\n \"score\": null,\n \"max_score\": 5,\n \"criterion_grades\": [\n {\n \"label\": \"B\",\n \"criterion\": \"Organizing\",\n \"score\": null\n },\n {\n \"label\": \"C\",\n \"criterion\": \"Producing text\",\n \"score\": null\n }\n ],\n \"comment\": null\n }\n ]\n },\n {\n \"student\": {\n \"id\": 10752619,\n \"name\": \"Bowen, James\"\n },\n \"assignment_grades\": [\n {\n \"task_id\": 11866019,\n \"task_name\": \"Hidden task\",\n \"score\": null,\n \"max_score\": 10,\n \"criterion_grades\": [\n {\n \"label\": \"A\",\n \"criterion\": \"Analysing\",\n \"score\": null\n }\n ],\n \"comment\": null\n },\n {\n \"task_id\": 11866020,\n \"task_name\": \"Task assessment is shown\",\n \"score\": null,\n \"max_score\": 10,\n \"criterion_grades\": [\n {\n \"label\": \"A\",\n \"criterion\": \"Analysing\",\n \"score\": null\n }\n ],\n \"comment\": null\n },\n {\n \"task_id\": 11866306,\n \"task_name\": \"New Task 4 criteria\",\n \"criterion_grades\": [\n {\n \"label\": \"A\",\n \"criterion\": \"Analysing\",\n \"score\": null\n },\n {\n \"label\": \"B\",\n \"criterion\": \"Organizing\",\n \"score\": null\n },\n {\n \"label\": \"C\",\n \"criterion\": \"Producing text\",\n \"score\": null\n },\n {\n \"label\": \"D\",\n \"criterion\": \"Using language\",\n \"score\": null\n }\n ],\n \"comment\": null\n },\n {\n \"task_id\": 11864295,\n \"task_name\": \"test 1\",\n \"score\": null,\n \"max_score\": 100,\n \"criterion_grades\": [\n {\n \"label\": \"A\",\n \"criterion\": \"Analysing\",\n \"score\": null\n },\n {\n \"label\": \"B\",\n \"criterion\": \"Organizing\",\n \"score\": null\n },\n {\n \"label\": \"C\",\n \"criterion\": \"Producing text\",\n \"score\": null\n },\n {\n \"label\": \"D\",\n \"criterion\": \"Using language\",\n \"score\": null\n }\n ],\n \"comment\": null\n },\n {\n \"task_id\": 11864296,\n \"task_name\": \"test with task-specific clarification\",\n \"criterion_grades\": [\n {\n \"label\": \"A\",\n \"criterion\": \"Analysing\",\n \"score\": null\n }\n ],\n \"comment\": null\n },\n {\n \"task_id\": 11865585,\n \"task_name\": \"Homework for Students to read\",\n \"score\": null,\n \"max_score\": 25,\n \"comment\": null\n },\n {\n \"task_id\": 11865584,\n \"task_name\": \"Test task for Gradebook view\",\n \"criterion_grades\": [\n {\n \"label\": \"A\",\n \"criterion\": \"Analysing\",\n \"score\": null\n },\n {\n \"label\": \"B\",\n \"criterion\": \"Organizing\",\n \"score\": null\n }\n ],\n \"comment\": null\n },\n {\n \"task_id\": 11865586,\n \"task_name\": \"New task for following week\",\n \"score\": null,\n \"max_score\": 5,\n \"criterion_grades\": [\n {\n \"label\": \"B\",\n \"criterion\": \"Organizing\",\n \"score\": null\n },\n {\n \"label\": \"C\",\n \"criterion\": \"Producing text\",\n \"score\": null\n }\n ],\n \"comment\": null\n }\n ]\n }\n ]\n}" } ] }, { "name": "Get Term Grades for a Class", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/classes/:class_id/assessments/term/:term_id/term-grades?per_page=1&page=1&include_archived_students=1", "host": [ "{{baseUrl}}" ], "path": [ "classes", ":class_id", "assessments", "term", ":term_id", "term-grades" ], "query": [ { "key": "per_page", "value": "1", "description": "Include archived students in the response." }, { "key": "page", "value": "1" }, { "key": "include_archived_students", "value": "1" } ], "variable": [ { "key": "class_id", "value": "11722965", "description": "(Required) Unique identifier for class." }, { "key": "term_id", "value": "169109", "description": "(Required) Unique identifier for term." } ] }, "description": "This endpoint retrieves all term grades for a class, as specified by term ID and class ID." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/classes/:class_id/assessments/term/:term_id/term-grades?include_archived_students=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "classes", ":class_id", "assessments", "term", ":term_id", "term-grades" ], "query": [ { "key": "include_archived_students", "value": "" } ], "variable": [ { "key": "class_id", "value": "", "description": "(Required) Unique identifier for class." }, { "key": "term_id", "value": "", "description": "(Required) Unique identifier for term." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"students\": [\n {\n \"id\": 12068821,\n \"name\": \"Epelbaum, Chloe\",\n \"term_grade\": {\n \"grade\": 6,\n \"average\": {\n \"percent\": 85,\n \"grade\": 6\n },\n \"comments\": \"Your class participation and determination to help your peers is remarkable.\",\n \"rubrics\": [\n {\n \"id\": 11181,\n \"title\": \"Class Participation\",\n \"grade\": \"Excellent\"\n }\n ]\n }\n },\n {\n \"id\": 12068757,\n \"name\": \"Evans, Raymond\",\n \"term_grade\": {\n \"grade\": 5,\n \"average\": {\n \"percent\": 86.5,\n \"grade\": \"5\"\n },\n \"comments\": \"You've managed to meet expectations.\",\n \"rubrics\": [\n {\n \"id\": 11181,\n \"title\": \"Class Participation\",\n \"grade\": \"Satisfactory\"\n }\n ]\n }\n }\n ],\n \"meta\": {\n \"current_page\": 1,\n \"total_pages\": 1,\n \"total_count\": 2,\n \"per_page\": 100\n }\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/classes/:class_id/assessments/term/:term_id/term-grades?include_archived_students=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "classes", ":class_id", "assessments", "term", ":term_id", "term-grades" ], "query": [ { "key": "include_archived_students", "value": "" } ], "variable": [ { "key": "class_id", "value": "", "description": "(Required) Unique identifier for class." }, { "key": "term_id", "value": "", "description": "(Required) Unique identifier for term." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": \"Access Denied\"\n}" }, { "name": "DP Example", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/classes/:class_id/assessments/term/:term_id/term-grades", "host": [ "{{baseUrl}}" ], "path": [ "v2", "classes", ":class_id", "assessments", "term", ":term_id", "term-grades" ], "query": [ { "key": "include_archived_students", "value": "", "description": "Include archived students in the response.", "disabled": true } ], "variable": [ { "key": "class_id", "value": "10286393", "description": "(Required) Unique identifier for class." }, { "key": "term_id", "value": "32069", "description": "(Required) Unique identifier for term." } ] } }, "_postman_previewlanguage": "json", "header": null, "cookie": [], "body": "{\n \"meta\": {\n \"current_page\": 1,\n \"total_pages\": 1,\n \"total_count\": 5,\n \"per_page\": 100\n },\n \"students\": [\n {\n \"id\": 11057119,\n \"name\": \"Student DP 2, QA\",\n \"term_grade\": {\n \"grade\": null,\n \"average\": {\n \"percent\": null,\n \"grade\": null\n },\n \"comments\": null,\n \"rubrics\": [\n {\n \"id\": 4353,\n \"title\": \"Effort\",\n \"grade\": null\n },\n {\n \"id\": 5876,\n \"title\": \"Participation\",\n \"grade\": null\n },\n {\n \"id\": 5906,\n \"title\": \"D\",\n \"grade\": null\n },\n {\n \"id\": 5907,\n \"title\": \"E\",\n \"grade\": null\n },\n {\n \"id\": 5908,\n \"title\": \"Homework\",\n \"grade\": null\n },\n {\n \"id\": 5909,\n \"title\": \"Academic Year Total\",\n \"grade\": null\n },\n {\n \"id\": 5931,\n \"title\": \"Bryan Test\",\n \"grade\": null\n },\n {\n \"id\": 5962,\n \"title\": \"Kris test 2\",\n \"grade\": null\n },\n {\n \"id\": 6001,\n \"title\": \"Custom Field\",\n \"grade\": null\n },\n {\n \"id\": 6002,\n \"title\": \"Formula SUM\",\n \"grade\": null\n },\n {\n \"id\": 6003,\n \"title\": \"Formula AVG\",\n \"grade\": null\n },\n {\n \"id\": 6021,\n \"title\": \"Class Participation\",\n \"grade\": null\n }\n ]\n }\n },\n {\n \"id\": 11047512,\n \"name\": \"Preza, Bryan\",\n \"term_grade\": {\n \"grade\": null,\n \"average\": {\n \"percent\": null,\n \"grade\": null\n },\n \"comments\": null,\n \"rubrics\": [\n {\n \"id\": 4353,\n \"title\": \"Effort\",\n \"grade\": null\n },\n {\n \"id\": 5876,\n \"title\": \"Participation\",\n \"grade\": null\n },\n {\n \"id\": 5906,\n \"title\": \"D\",\n \"grade\": null\n },\n {\n \"id\": 5907,\n \"title\": \"E\",\n \"grade\": null\n },\n {\n \"id\": 5908,\n \"title\": \"Homework\",\n \"grade\": null\n },\n {\n \"id\": 5909,\n \"title\": \"Academic Year Total\",\n \"grade\": null\n },\n {\n \"id\": 5931,\n \"title\": \"Bryan Test\",\n \"grade\": null\n },\n {\n \"id\": 5962,\n \"title\": \"Kris test 2\",\n \"grade\": null\n },\n {\n \"id\": 6001,\n \"title\": \"Custom Field\",\n \"grade\": null\n },\n {\n \"id\": 6002,\n \"title\": \"Formula SUM\",\n \"grade\": null\n },\n {\n \"id\": 6003,\n \"title\": \"Formula AVG\",\n \"grade\": null\n },\n {\n \"id\": 6021,\n \"title\": \"Class Participation\",\n \"grade\": null\n }\n ]\n }\n },\n {\n \"id\": 11058051,\n \"name\": \"Mannix, Florida\",\n \"term_grade\": {\n \"grade\": null,\n \"average\": {\n \"percent\": null,\n \"grade\": null\n },\n \"comments\": null,\n \"rubrics\": [\n {\n \"id\": 4353,\n \"title\": \"Effort\",\n \"grade\": null\n },\n {\n \"id\": 5876,\n \"title\": \"Participation\",\n \"grade\": null\n },\n {\n \"id\": 5906,\n \"title\": \"D\",\n \"grade\": null\n },\n {\n \"id\": 5907,\n \"title\": \"E\",\n \"grade\": null\n },\n {\n \"id\": 5908,\n \"title\": \"Homework\",\n \"grade\": null\n },\n {\n \"id\": 5909,\n \"title\": \"Academic Year Total\",\n \"grade\": null\n },\n {\n \"id\": 5931,\n \"title\": \"Bryan Test\",\n \"grade\": null\n },\n {\n \"id\": 5962,\n \"title\": \"Kris test 2\",\n \"grade\": null\n },\n {\n \"id\": 6001,\n \"title\": \"Custom Field\",\n \"grade\": null\n },\n {\n \"id\": 6002,\n \"title\": \"Formula SUM\",\n \"grade\": null\n },\n {\n \"id\": 6003,\n \"title\": \"Formula AVG\",\n \"grade\": null\n },\n {\n \"id\": 6021,\n \"title\": \"Class Participation\",\n \"grade\": null\n }\n ]\n }\n },\n {\n \"id\": 11058053,\n \"name\": \"Mannix, Florida\",\n \"term_grade\": {\n \"grade\": null,\n \"average\": {\n \"percent\": null,\n \"grade\": null\n },\n \"comments\": null,\n \"rubrics\": [\n {\n \"id\": 4353,\n \"title\": \"Effort\",\n \"grade\": null\n },\n {\n \"id\": 5876,\n \"title\": \"Participation\",\n \"grade\": null\n },\n {\n \"id\": 5906,\n \"title\": \"D\",\n \"grade\": null\n },\n {\n \"id\": 5907,\n \"title\": \"E\",\n \"grade\": null\n },\n {\n \"id\": 5908,\n \"title\": \"Homework\",\n \"grade\": null\n },\n {\n \"id\": 5909,\n \"title\": \"Academic Year Total\",\n \"grade\": null\n },\n {\n \"id\": 5931,\n \"title\": \"Bryan Test\",\n \"grade\": null\n },\n {\n \"id\": 5962,\n \"title\": \"Kris test 2\",\n \"grade\": null\n },\n {\n \"id\": 6001,\n \"title\": \"Custom Field\",\n \"grade\": null\n },\n {\n \"id\": 6002,\n \"title\": \"Formula SUM\",\n \"grade\": null\n },\n {\n \"id\": 6003,\n \"title\": \"Formula AVG\",\n \"grade\": null\n },\n {\n \"id\": 6021,\n \"title\": \"Class Participation\",\n \"grade\": null\n }\n ]\n }\n },\n {\n \"id\": 11058026,\n \"name\": \"Omi, QA DP QuickStart 002\",\n \"term_grade\": {\n \"grade\": null,\n \"average\": {\n \"percent\": null,\n \"grade\": null\n },\n \"comments\": null,\n \"rubrics\": [\n {\n \"id\": 4353,\n \"title\": \"Effort\",\n \"grade\": null\n },\n {\n \"id\": 5876,\n \"title\": \"Participation\",\n \"grade\": null\n },\n {\n \"id\": 5906,\n \"title\": \"D\",\n \"grade\": null\n },\n {\n \"id\": 5907,\n \"title\": \"E\",\n \"grade\": null\n },\n {\n \"id\": 5908,\n \"title\": \"Homework\",\n \"grade\": null\n },\n {\n \"id\": 5909,\n \"title\": \"Academic Year Total\",\n \"grade\": null\n },\n {\n \"id\": 5931,\n \"title\": \"Bryan Test\",\n \"grade\": null\n },\n {\n \"id\": 5962,\n \"title\": \"Kris test 2\",\n \"grade\": null\n },\n {\n \"id\": 6001,\n \"title\": \"Custom Field\",\n \"grade\": null\n },\n {\n \"id\": 6002,\n \"title\": \"Formula SUM\",\n \"grade\": null\n },\n {\n \"id\": 6003,\n \"title\": \"Formula AVG\",\n \"grade\": null\n },\n {\n \"id\": 6021,\n \"title\": \"Class Participation\",\n \"grade\": null\n }\n ]\n }\n }\n ]\n}" }, { "name": "MYP Chinese Example with Rubrics", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/classes/:class_id/assessments/term/:term_id/term-grades", "host": [ "{{baseUrl}}" ], "path": [ "v2", "classes", ":class_id", "assessments", "term", ":term_id", "term-grades" ], "query": [ { "key": "include_archived_students", "value": "", "description": "Include archived students in the response.", "disabled": true } ], "variable": [ { "key": "class_id", "value": "", "description": "(Required) Unique identifier for class." }, { "key": "term_id", "value": "", "description": "(Required) Unique identifier for term." } ] } }, "_postman_previewlanguage": "json", "header": null, "cookie": [], "body": "{\n \"meta\": {\n \"current_page\": 1,\n \"total_pages\": 1,\n \"total_count\": 4,\n \"per_page\": 100\n },\n \"students\": [\n {\n \"id\": 10752619,\n \"name\": \"Bowen, James\",\n \"term_grade\": {\n \"grade\": \"INC\",\n \"sum\": \"N/A\",\n \"grades\": {\n \"A\": 5,\n \"B\": 2,\n \"C\": 6,\n \"D\": \"N/A\"\n },\n \"atl_skills\": [],\n \"comments\": \"

Comment here

\",\n \"rubrics\": [\n {\n \"id\": 5924,\n \"title\": \"Additional Rubric\",\n \"grade\": \"1\"\n },\n {\n \"id\": 5925,\n \"title\": \"Custom Rubric\",\n \"grade\": null\n },\n {\n \"id\": 5927,\n \"title\": \"Another rubric\",\n \"grade\": \"2\"\n },\n {\n \"id\": 5928,\n \"title\": \"And one more\",\n \"grade\": \"3 A\"\n },\n {\n \"id\": 5960,\n \"title\": \"Bryan Test\",\n \"grade\": \"A\"\n },\n {\n \"id\": 5880,\n \"title\": \"New Rubric\",\n \"grade\": \"a\"\n },\n {\n \"id\": 5926,\n \"title\": \"One more rubric\",\n \"grade\": 1\n },\n {\n \"id\": 5875,\n \"title\": \"Participation\",\n \"grade\": \"G\"\n },\n {\n \"id\": 5980,\n \"title\": \"Chiseeeese ruuubrick\",\n \"grade\": null\n },\n {\n \"id\": 5990,\n \"title\": \"Subject Specific Skills\",\n \"grade\": \"A\"\n },\n {\n \"id\": 5878,\n \"title\": \"Esfuerzo\",\n \"grade\": \"S\"\n },\n {\n \"id\": 5991,\n \"title\": \"Thinking Skills\",\n \"grade\": \"A\"\n },\n {\n \"id\": 5992,\n \"title\": \"Research Skills\",\n \"grade\": \"A\"\n },\n {\n \"id\": 5993,\n \"title\": \"Communication Skills\",\n \"grade\": null\n },\n {\n \"id\": 5994,\n \"title\": \"Social Skills\",\n \"grade\": null\n },\n {\n \"id\": 5995,\n \"title\": \"Self-Management Skills\",\n \"grade\": null\n },\n {\n \"id\": 5996,\n \"title\": \"Criterion B: Developing Ideas\",\n \"grade\": null\n },\n {\n \"id\": 5997,\n \"title\": \"Criterion A: Knowing and understanding\",\n \"grade\": null\n },\n {\n \"id\": 5998,\n \"title\": \"Criterion C: Creating the solution \",\n \"grade\": null\n },\n {\n \"id\": 5999,\n \"title\": \"Criterion D: Impacts of science\",\n \"grade\": null\n }\n ]\n }\n }\n ]\n}" } ] }, { "name": "Get a Class", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/classes/:id", "host": [ "{{baseUrl}}" ], "path": [ "classes", ":id" ], "variable": [ { "key": "id", "value": "{{classId}}", "description": "(Required) Unique identifier for class." } ] }, "description": "This endpoint retrieves a single class as specified by ID. It returns class details and the IDs of teachers." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/classes/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "classes", ":id" ], "variable": [ { "key": "id", "value": "", "description": "(Required) Unique identifier for class." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"class\": {\n \"id\": \"\",\n \"name\": \"\",\n \"uniq_id\": \"\",\n \"class_section\": \"\",\n \"start_term_id\": \"\",\n \"end_term_id\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"grade\": \"\",\n \"grade_number\": \"\",\n \"applicable_levels\": [\n \"\",\n \"\"\n ],\n \"program\": \"\",\n \"program_code\": \"\",\n \"subject_id\": \"\",\n \"subject_name\": \"\",\n \"subject_group\": \"\",\n \"subject_option\": \"\",\n \"teachers\": [\n {\n \"email\": \"\",\n \"first_name\": \"\",\n \"middle_name\": \"\",\n \"password\": \"\",\n \"last_name\": \"\",\n \"nickname\": \"\",\n \"other_name\": \"\",\n \"gender\": \"\",\n \"birthday\": \"\",\n \"phone_number\": \"\",\n \"mobile_phone_number\": \"\",\n \"street_address\": \"\",\n \"street_address_ii\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipcode\": \"\",\n \"country\": \"\",\n \"nationalities\": [\n \"\",\n \"\"\n ],\n \"languages\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"role\": \"\",\n \"programs\": [\n \"\",\n \"\"\n ]\n },\n {\n \"email\": \"\",\n \"first_name\": \"\",\n \"middle_name\": \"\",\n \"password\": \"\",\n \"last_name\": \"\",\n \"nickname\": \"\",\n \"other_name\": \"\",\n \"gender\": \"\",\n \"birthday\": \"\",\n \"phone_number\": \"\",\n \"mobile_phone_number\": \"\",\n \"street_address\": \"\",\n \"street_address_ii\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"zipcode\": \"\",\n \"country\": \"\",\n \"nationalities\": [\n \"\",\n \"\"\n ],\n \"languages\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"role\": \"\",\n \"programs\": [\n \"\",\n \"\"\n ]\n }\n ]\n }\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/classes/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "classes", ":id" ], "variable": [ { "key": "id", "value": "", "description": "(Required) Unique identifier for class." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": \"Access Denied\"\n}" }, { "name": "Not found.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/classes/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "classes", ":id" ], "variable": [ { "key": "id", "value": "", "description": "(Required) Unique identifier for class." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": \"Couldn't find Class with 'id'=12345\"\n}" } ] }, { "name": "Get a Class Timetable", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/classes/:id/timetable", "host": [ "{{baseUrl}}" ], "path": [ "classes", ":id", "timetable" ], "variable": [ { "key": "id", "value": "11667839", "description": "Class ID" } ] }, "description": "This endpoint retrieves a single class as specified by ID. It returns class details and the IDs of teachers." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/classes/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "classes", ":id" ], "variable": [ { "key": "id", "value": "", "description": "(Required) Unique identifier for class." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"timetable\": {\n \"academic_years\": [\n {\n \"id\": 19,\n \"name\": \"December 2021 – July 2022\",\n \"start_date\": \"2021-12-22\",\n \"end_date\": \"2022-07-22\",\n \"slots\": [\n {\n \"day\": 2,\n \"period\": 1,\n \"location\": \"Classroom B\",\n \"enabled\": true\n },\n {\n \"day\": 3,\n \"period\": 1,\n \"location\": \"Classroom C\",\n \"enabled\": true\n }\n ]\n }\n ]\n }\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/classes/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "classes", ":id" ], "variable": [ { "key": "id", "value": "", "description": "(Required) Unique identifier for class." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": \"Access Denied\"\n}" }, { "name": "Not found.", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/classes/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "classes", ":id" ], "variable": [ { "key": "id", "value": "", "description": "(Required) Unique identifier for class." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": \"Couldn't find Class with 'id'=12345\"\n}" } ] }, { "name": "Get Students for a Class", "event": [ { "listen": "test", "script": { "exec": [ "/**", " * Get an overview table of all items returned from the endpoint, useful for when there lists of objects are returned.", " * See comments below for screenshots.", " * ", " * https://gist.github.com/brainysmurf/e45f608b68609f8a0b222ac99b8905d8", " *", " * To use, copy the below code into the \"Tests\" tab of the endpoint", " * Click blue \"Send\" button", " * Click on \"Visualize\" in the Body tile", " * Note that it only displays the returned objects, there's nothing magical that's getting \"all\" objects via pagination", " */", "", " // change to whatever the root property is \"students\" \"year-groups\" whatever", "const entity = \"classes\"; ", "", " // change to the fields you want displayed at first, you can add others interactively", "const columns = ['id', 'name', 'uniq_id', 'grade']; ", "", "/**", " * Below not intended for modification (although you can, for version bumps etc)", " */", "const template = `", "", "", "", "
", "", " ", "", "", "", "", "", "", "", " `;", "", "// Set visualizer with template defined below (via hoisting)", "const json = pm.response.json();", "pm.visualizer.set(template, pm.response.json());" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/classes/:id/students", "host": [ "{{baseUrl}}" ], "path": [ "classes", ":id", "students" ], "variable": [ { "key": "id", "value": "{{classId}}", "description": "(Required) Unique identifier for class." } ] }, "description": "This endpoint retrieves all students belonging to a class as specified by class ID." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/classes/:id/students", "host": [ "{{baseUrl}}" ], "path": [ "v2", "classes", ":id", "students" ], "variable": [ { "key": "id", "value": "", "description": "(Required) Unique identifier for class." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"student_ids\": [\n 10193652\n ],\n \"student_levels\": {\n \"6\": \"SL\"\n },\n \"meta\": {\n \"current_page\": 1,\n \"total_pages\": 1,\n \"total_count\": 1,\n \"per_page\": 100\n }\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/classes/:id/students", "host": [ "{{baseUrl}}" ], "path": [ "v2", "classes", ":id", "students" ], "variable": [ { "key": "id", "value": "", "description": "(Required) Unique identifier for class." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": \"Access Denied\"\n}" } ] }, { "name": "Add Students to a Class", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"student_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/classes/:id/add_students", "host": [ "{{baseUrl}}" ], "path": [ "classes", ":id", "add_students" ], "variable": [ { "key": "id", "value": "{{classId}}", "description": "(Required) Unique identifier for class." } ] }, "description": "This endpoint adds students, as specified by student ID/s, to a class as specified by class ID." }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"student_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/classes/:id/add_students", "host": [ "{{baseUrl}}" ], "path": [ "v2", "classes", ":id", "add_students" ], "variable": [ { "key": "id", "value": "", "description": "(Required) Unique identifier for class." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"ok\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"student_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/classes/:id/add_students", "host": [ "{{baseUrl}}" ], "path": [ "v2", "classes", ":id", "add_students" ], "variable": [ { "key": "id", "value": "", "description": "(Required) Unique identifier for class." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": \"Access Denied\"\n}" } ] }, { "name": "Remove Students from a Class", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"student_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/classes/:id/remove_students", "host": [ "{{baseUrl}}" ], "path": [ "classes", ":id", "remove_students" ], "variable": [ { "key": "id", "value": "{{classId}}", "description": "(Required) Unique identifier for class." } ] }, "description": "This endpoint removes students from a class, as specified by student ID/s and class ID.

" }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"student_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/classes/:id/remove_students", "host": [ "{{baseUrl}}" ], "path": [ "v2", "classes", ":id", "remove_students" ], "variable": [ { "key": "id", "value": "", "description": "(Required) Unique identifier for class." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"ok\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"student_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/classes/:id/remove_students", "host": [ "{{baseUrl}}" ], "path": [ "v2", "classes", ":id", "remove_students" ], "variable": [ { "key": "id", "value": "", "description": "(Required) Unique identifier for class." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": \"Access Denied\"\n}" } ] }, { "name": "Get Attendance for a Class during an Academic Term", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/classes/:id/attendance/term/:term_id", "host": [ "{{baseUrl}}" ], "path": [ "classes", ":id", "attendance", "term", ":term_id" ], "variable": [ { "key": "id", "value": "{{classId}}", "description": "(Required) Unique identifier for class." }, { "key": "term_id", "value": "{{termId}}", "description": "(Required) Unique identifier for academic term." } ] }, "description": "This endpoint retrieves summary attendance data for all students within a class as specified by class ID for an academic term as specified by term ID." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/classes/:id/attendance/term/:term_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "classes", ":id", "attendance", "term", ":term_id" ], "variable": [ { "key": "id", "value": "", "description": "(Required) Unique identifier for class." }, { "key": "term_id", "value": "", "description": "(Required) Unique identifier for academic term." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"students\": [\n {\n \"id\": 10193652,\n \"attendance\": {\n \"Present\": 91,\n \"Absent\": 3,\n \"Late\": 2\n }\n },\n {\n \"id\": 10193654,\n \"attendance\": {\n \"Present\": 96\n }\n }\n ]\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/classes/:id/attendance/term/:term_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "classes", ":id", "attendance", "term", ":term_id" ], "variable": [ { "key": "id", "value": "", "description": "(Required) Unique identifier for class." }, { "key": "term_id", "value": "", "description": "(Required) Unique identifier for academic term." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": \"Access Denied\"\n}" } ] }, { "name": "Get Class Attendance for a Date", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/classes/:id/attendance/date/:date", "host": [ "{{baseUrl}}" ], "path": [ "classes", ":id", "attendance", "date", ":date" ], "variable": [ { "key": "id", "value": "{{classId}}", "description": "(Required) Unique identifier for class." }, { "key": "date", "value": "", "description": "(Required) A date string to define required day as yyyy-mm-dd." } ] }, "description": "This endpoint retrieves summary attendance data for all students on a given date, as specified by class ID. Note, the specified date must be between the class’s start and end dates. A student’s attendance is returned as a sparse array of attendance periods. For further information, see [the help article](https://faria.managebac.com/help/articles/360018804292)." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/classes/:id/attendance/date/:date", "host": [ "{{baseUrl}}" ], "path": [ "v2", "classes", ":id", "attendance", "date", ":date" ], "variable": [ { "key": "id", "value": "", "description": "(Required) Unique identifier for class." }, { "key": "date", "value": "", "description": "(Required) A date string to define required day as yyyy-mm-dd." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"students\": [\n {\n \"id\": 10193652,\n \"attendance\": {\n \"1\": {\n \"status\": \"Present\",\n \"note\": \"\"\n },\n \"5\": {\n \"status\": \"Absent\",\n \"note\": \"Chloe left after the first period for an appointment.\"\n }\n }\n },\n {\n \"id\": 10193615,\n \"attendance\": {\n \"1\": {\n \"status\": \"Present\",\n \"note\": \"\"\n },\n \"5\": {\n \"status\": \"Present\",\n \"note\": \"\"\n }\n }\n }\n ]\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/classes/:id/attendance/date/:date", "host": [ "{{baseUrl}}" ], "path": [ "v2", "classes", ":id", "attendance", "date", ":date" ], "variable": [ { "key": "id", "value": "", "description": "(Required) Unique identifier for class." }, { "key": "date", "value": "", "description": "(Required) A date string to define required day as yyyy-mm-dd." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": \"Access Denied\"\n}" } ] }, { "name": "Get Tasks for a Class", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/classes/:id/tasks", "host": [ "{{baseUrl}}" ], "path": [ "classes", ":id", "tasks" ], "query": [ { "key": "term_id", "value": "", "description": "Unique identifier for term.", "disabled": true } ], "variable": [ { "key": "id", "value": "{{classId}}", "description": "(Required) Unique identifier for class." } ] }, "description": "This endpoint retrieves all tasks belonging to the class as specified by ID. If term ID is not specified, all tasks that the term class covers will be returned." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/classes/:id/tasks?term_id=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "classes", ":id", "tasks" ], "query": [ { "key": "term_id", "value": "" } ], "variable": [ { "key": "id", "value": "", "description": "(Required) Unique identifier for class." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"tasks\": [\n {\n \"id\": 10277631,\n \"name\": \"Accelerated Motion Lab\",\n \"notes\": \"\",\n \"draft\": false,\n \"task_type\": \"formative\",\n \"dropbox\": false,\n \"google_drive_dropbox\": true,\n \"task_work_templates\": [\n {\n \"id\": 60,\n \"name\": \"Lab Report\",\n \"details\": \"Complete the given lab report template based on the in-class lab that was held on Monday.\"\n },\n {\n \"id\": 61,\n \"name\": \"Post-Lab Reflection\",\n \"details\": \"After completing your lab report, answer the questions in the post-lab reflection.\"\n }\n ],\n \"turnitin\": false,\n \"due_date\": \"2018-04-27T04:00:00+03:00\",\n \"unit\": {\n \"id\": 67396,\n \"title\": \"Dynamics & Kinematics\"\n },\n \"hl\": true,\n \"sl\": true,\n \"category\": {\n \"id\": 11484803,\n \"name\": \"Lab Reports\",\n \"weight\": 25\n },\n \"assessment_types\": {\n \"comments\": {},\n \"points\": {\n \"max_score\": 7\n }\n }\n },\n {\n \"id\": 20018084,\n \"name\": \"Chapter 2.1 HW\",\n \"notes\": \"\",\n \"draft\": false,\n \"task_type\": \"formative\",\n \"dropbox\": false,\n \"google_drive_dropbox\": false,\n \"turnitin\": false,\n \"due_date\": \"2018-05-13T04:00:00+03:00\",\n \"unit\": {\n \"id\": 67396,\n \"title\": \"Dynamics & Kinematics\"\n },\n \"hl\": true,\n \"sl\": true,\n \"category\": {\n \"id\": 11484801,\n \"name\": \"Homework\",\n \"weight\": 10\n },\n \"assessment_types\": {\n \"comments\": {},\n \"points\": {\n \"max_score\": 10\n }\n }\n },\n {\n \"id\": 19942197,\n \"name\": \"Dynamics Unit Test\",\n \"notes\": \"Prepare for the test by completing all homework questions for Chapter 2.\",\n \"draft\": false,\n \"task_type\": \"summative\",\n \"dropbox\": false,\n \"google_drive_dropbox\": true,\n \"task_work_templates\": false,\n \"turnitin\": false,\n \"due_date\": \"2018-05-18T04:00:00+03:00\",\n \"unit\": {\n \"id\": 67396,\n \"title\": \"Test\"\n },\n \"hl\": true,\n \"sl\": true,\n \"category\": {\n \"id\": 11484802,\n \"name\": \"Unit Tests\",\n \"weight\": 20\n },\n \"assessment_types\": {\n \"comments\": {},\n \"points\": {\n \"max_score\": 7\n }\n }\n }\n ],\n \"meta\": {\n \"current_page\": 1,\n \"total_pages\": 1,\n \"total_count\": 4,\n \"per_page\": 100\n }\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/classes/:id/tasks?term_id=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "classes", ":id", "tasks" ], "query": [ { "key": "term_id", "value": "" } ], "variable": [ { "key": "id", "value": "", "description": "(Required) Unique identifier for class." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": \"Access Denied\"\n}" } ] }, { "name": "Get a Task for a Class", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/classes/:class_id/tasks/:id", "host": [ "{{baseUrl}}" ], "path": [ "classes", ":class_id", "tasks", ":id" ], "variable": [ { "key": "class_id", "value": "{{classId}}", "description": "(Required) Unique identifier for class." }, { "key": "id", "value": "{{taskId}}", "description": "(Required) Unique identifier for task." } ] }, "description": "This endpoint retrieves a task as specified by task ID and class ID." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/classes/:class_id/tasks/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "classes", ":class_id", "tasks", ":id" ], "variable": [ { "key": "id", "value": "", "description": "(Required) Unique identifier for task." }, { "key": "class_id", "value": "", "description": "(Required) Unique identifier for class." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"task\": {\n \"id\": 10277631,\n \"name\": \"Accelerated Motion Lab\",\n \"notes\": \"The lab will allow you to work in groups to create and test a hypothesis related to Newton's Laws of Motion.\",\n \"draft\": false,\n \"task_type\": \"formative\",\n \"dropbox\": false,\n \"google_drive_dropbox\": true,\n \"task_work_templates\": [\n {\n \"id\": 60,\n \"name\": \"Lab Report\",\n \"details\": \"Complete the given lab report template based on the in-class lab that was held on Monday.\"\n },\n {\n \"id\": 61,\n \"name\": \"Post-Lab Reflection\",\n \"details\": \"After completing your lab report, answer the questions in the post-lab reflection.\"\n }\n ],\n \"turnitin\": false,\n \"due_date\": \"2018-04-27T04:00:00+03:00\",\n \"unit\": {\n \"id\": 67396,\n \"title\": \"Dynamics & Kinematics\"\n },\n \"hl\": true,\n \"sl\": true,\n \"category\": {\n \"id\": 11484803,\n \"name\": \"Lab Reports\",\n \"weight\": 20\n },\n \"assessment_types\": {\n \"comments\": {},\n \"points\": {\n \"max_score\": 7\n }\n }\n }\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/classes/:class_id/tasks/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "classes", ":class_id", "tasks", ":id" ], "variable": [ { "key": "id", "value": "", "description": "(Required) Unique identifier for task." }, { "key": "class_id", "value": "", "description": "(Required) Unique identifier for class." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": \"Access Denied\"\n}" } ] }, { "name": "Get Student Assessment Results for a Task and Class", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/classes/:class_id/tasks/:id/students", "host": [ "{{baseUrl}}" ], "path": [ "classes", ":class_id", "tasks", ":id", "students" ], "variable": [ { "key": "class_id", "value": "{{classId}}", "description": "(Required) Unique identifier for class." }, { "key": "id", "value": "{{taskId}}", "description": "(Required) Unique identifier for task." } ] }, "description": "This endpoint retrieves all assessment result scores belonging to a class as specified by ID. If term ID is not specified, all assessed tasks that the term class covers will be returned." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/classes/:class_id/tasks/:id/students", "host": [ "{{baseUrl}}" ], "path": [ "v2", "classes", ":class_id", "tasks", ":id", "students" ], "variable": [ { "key": "id", "value": "", "description": "(Required) Unique identifier for task." }, { "key": "class_id", "value": "", "description": "(Required) Unique identifier for class." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"students\": [\n {\n \"id\": 10752610,\n \"name\": \"Epelbaum, Chloe\",\n \"task_works\": [\n {\n \"id\": 11861277,\n \"template_id\": 54,\n \"submission_status\": \"submitted\"\n },\n {\n \"id\": 11861277,\n \"template_id\": 55,\n \"submission_status\": \"late\"\n }\n ],\n \"assessments\": {\n \"comments\": \"Chloe has done a great job on both portions of the task\",\n \"points\": {\n \"score\": 6,\n \"max_score\": 7\n }\n }\n },\n {\n \"id\": 12068799,\n \"name\": \"Bailey, Jenna\",\n \"task_works\": [\n {\n \"id\": 11861277,\n \"template_id\": 55,\n \"submission_status\": \"waiting\"\n }\n ],\n \"assessments\": {\n \"comments\": null,\n \"points\": {\n \"score\": null,\n \"max_score\": 7\n }\n }\n },\n {\n \"id\": 10851648,\n \"name\": \"Francisco, Lewis\",\n \"task_works\": [\n {\n \"id\": 11861277,\n \"template_id\": 55,\n \"submission_status\": \"late\"\n }\n ],\n \"assessments\": {\n \"comments\": \"Lewis submitted his task late and did not meet expectations\",\n \"points\": {\n \"score\": 4,\n \"max_score\": 7\n }\n }\n },\n {\n \"id\": 10866190,\n \"name\": \"Lucy, Jasmine\",\n \"task_works\": [\n {\n \"id\": 11861277,\n \"template_id\": 54,\n \"submission_status\": \"submitted\"\n },\n {\n \"id\": 11861277,\n \"template_id\": 55,\n \"submission_status\": \"submitted\"\n }\n ],\n \"assessments\": {\n \"comments\": \"Great improvement Jasmine. Your hard work is showing.\",\n \"points\": {\n \"score\": 5,\n \"max_score\": 7\n }\n }\n },\n {\n \"id\": 10813990,\n \"name\": \"Bowen, James\",\n \"task_works\": [\n {\n \"id\": 11861277,\n \"template_id\": 54,\n \"submission_status\": \"submitted\"\n },\n {\n \"id\": 11861277,\n \"template_id\": 55,\n \"submission_status\": \"submitted\"\n }\n ],\n \"assessments\": {\n \"comments\": \"Great analysis, but your writing needs to be more concise.\",\n \"points\": {\n \"score\": 5,\n \"max_score\": 7\n }\n }\n },\n {\n \"id\": 11183705,\n \"name\": \"Howard, Jessica\",\n \"task_works\": [\n {\n \"id\": 11861277,\n \"template_id\": 54,\n \"submission_status\": \"waiting\"\n },\n {\n \"id\": 11861277,\n \"template_id\": 55,\n \"submission_status\": \"submitted\"\n }\n ],\n \"assessments\": {\n \"comments\": null,\n \"points\": {\n \"score\": null,\n \"max_score\": 7\n }\n }\n },\n {\n \"id\": 12068760,\n \"name\": \"Boyd, Keith\",\n \"task_works\": [],\n \"assessments\": {\n \"comments\": null,\n \"points\": {\n \"score\": null,\n \"max_score\": 7\n }\n }\n },\n {\n \"id\": 12472028,\n \"name\": \"McNeil, Ian\",\n \"task_works\": [],\n \"assessments\": {\n \"comments\": null,\n \"points\": {\n \"score\": null,\n \"max_score\": 7\n }\n }\n }\n ]\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/classes/:class_id/tasks/:id/students", "host": [ "{{baseUrl}}" ], "path": [ "v2", "classes", ":class_id", "tasks", ":id", "students" ], "variable": [ { "key": "id", "value": "", "description": "(Required) Unique identifier for task." }, { "key": "class_id", "value": "", "description": "(Required) Unique identifier for class." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": \"Access Denied\"\n}" } ] } ], "description": "This section describes all the APIs relating to classes." }, { "name": "Groups", "item": [ { "name": "Get all groups", "request": { "method": "GET", "header": [] }, "response": [] } ] }, { "name": "Year Groups", "item": [ { "name": "Get all Year Groups", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/year-groups", "host": [ "{{baseUrl}}" ], "path": [ "year-groups" ], "query": [ { "key": "modified_since", "value": "", "description": "A timestamp to filter results by modification date.", "disabled": true }, { "key": "page", "value": "", "description": "An integer defining which page to display.", "disabled": true }, { "key": "per_page", "value": "", "description": "An integer defining the number of records to display per page.", "disabled": true } ] }, "description": "This endpoint retrieves the basic information of all Year Groups. It returns the group name, program, grade level and student IDs for members. Note: /v2/ib-groups endpoints have been deprecated in favor of /v2/year-groups endpoints and will be removed completely by the end of 2021." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/year-groups?modified_since=&page=&per_page=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "year-groups" ], "query": [ { "key": "modified_since", "value": "" }, { "key": "page", "value": "" }, { "key": "per_page", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"year_groups\": [\n {\n \"id\": 10907398,\n \"name\": \"IB Diploma Group of 2019 (Grade 12)\",\n \"program\": \"IB Diploma\",\n \"grade\": \"Grade 12\",\n \"grade_number\": 13,\n \"student_ids\": [\n 10193652\n ]\n },\n {\n \"id\": 11076103,\n \"name\": \"IB MYP Group of 2019 (Year 4)\",\n \"program\": \"IB Middle Years\",\n \"grade\": \"Year 4\",\n \"grade_number\": 10,\n \"student_ids\": [\n 12459565,\n 11456849,\n 12068809\n ]\n }\n ],\n \"meta\": {\n \"current_page\": 1,\n \"total_pages\": 1,\n \"total_count\": 2,\n \"per_page\": 100\n }\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/year-groups?modified_since=&page=&per_page=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "year-groups" ], "query": [ { "key": "modified_since", "value": "" }, { "key": "page", "value": "" }, { "key": "per_page", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": \"Access Denied\"\n}" } ] }, { "name": "Get Students for a Year Group", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/year-groups/:id/students", "host": [ "{{baseUrl}}" ], "path": [ "year-groups", ":id", "students" ], "query": [ { "key": "page", "value": "", "description": "An integer defining which page to display.", "disabled": true }, { "key": "per_page", "value": "", "description": "An integer defining the number of records to display per page.", "disabled": true } ], "variable": [ { "key": "id", "value": "{{yearGroupId}}", "description": "(Required) Unique identifier for year group." } ] }, "description": "This endpoint retrieves all students belonging to a year group, as specified by the year group ID." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/year-groups/:id/students?page=&per_page=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "year-groups", ":id", "students" ], "query": [ { "key": "page", "value": "" }, { "key": "per_page", "value": "" } ], "variable": [ { "key": "id", "value": "", "description": "(Required) Unique identifier for year group." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"meta\": {\n \"current_page\": 1,\n \"total_pages\": 1,\n \"total_count\": 3,\n \"per_page\": 100\n },\n \"student_ids\": [\n 10193652,\n 12449380,\n 12569245\n ],\n \"students\": [\n {\n \"id\": 10193652,\n \"email\": \"cage@eduvo.com\",\n \"first_name\": \"John\",\n \"last_name\": \"Cage\",\n \"archived\": false,\n \"created_at\": \"2018-09-15T06:31:08.000-07:00\",\n \"updated_at\": \"2021-02-23T00:57:49.000-08:00\",\n \"last_accessed_at\": \"2021-02-25T08:13:03.000-08:00\",\n \"gender\": \"Male\",\n \"birthday\": \"1994-08-01\",\n \"mobile_phone_number\": \"\",\n \"student_id\": \"857906\",\n \"cas_advisor_id\": 10559037,\n \"class_grade\": \"Grade 10\",\n \"class_grade_number\": 11,\n \"program\": \"IB Diploma\",\n \"program_code\": \"diploma\",\n \"ib_group_id\": 10342694,\n \"year_group_id\": 10342694,\n \"parent_ids\": [],\n \"street_address\": \"\",\n \"city\": \"New York\",\n \"state\": \"\",\n \"zipcode\": \"\",\n \"country\": \"US\",\n \"nationalities\": [\n \"US\"\n ],\n \"languages\": [\n \"ENG\",\n \"SPA\"\n ],\n \"graduating_year\": 2023\n },\n {\n \"id\": 12449380,\n \"email\": \"blue@eduvo.com\",\n \"first_name\": \"Blue Ivy\",\n \"last_name\": \"Carter\",\n \"archived\": false,\n \"created_at\": \"2014-03-11T06:50:34.000-07:00\",\n \"updated_at\": \"2021-02-23T00:57:48.000-08:00\",\n \"student_id\": \"\",\n \"class_grade\": \"Grade 10\",\n \"class_grade_number\": 11,\n \"program\": \"IB Diploma\",\n \"program_code\": \"diploma\",\n \"ib_group_id\": 10342694,\n \"year_group_id\": 10342694,\n \"parent_ids\": [\n 10193613,\n 12425959\n ],\n \"nationalities\": [],\n \"languages\": [],\n \"graduating_year\": 2023\n },\n {\n \"id\": 12569245,\n \"email\": \"robyn@managebac.com\",\n \"first_name\": \"Robyn\",\n \"last_name\": \"Anderson\",\n \"archived\": false,\n \"created_at\": \"2014-10-23T06:12:42.000-07:00\",\n \"updated_at\": \"2021-02-23T00:57:49.000-08:00\",\n \"phone_number\": \"\",\n \"mobile_phone_number\": \"\",\n \"national_id\": \"\",\n \"student_id\": \"\",\n \"class_grade\": \"Grade 10\",\n \"class_grade_number\": 11,\n \"program\": \"IB Diploma\",\n \"program_code\": \"diploma\",\n \"ib_group_id\": 10342694,\n \"year_group_id\": 10342694,\n \"parent_ids\": [],\n \"street_address\": \"99590 Johnson Park\",\n \"street_address_ii\": \"\",\n \"city\": \"Fort Lauderdale\",\n \"state\": \"FL\",\n \"zipcode\": \"72146\",\n \"country\": \"US\",\n \"nationalities\": [],\n \"languages\": [],\n \"graduating_year\": 2023\n }\n ]\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/year-groups/:id/students?page=&per_page=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "year-groups", ":id", "students" ], "query": [ { "key": "page", "value": "" }, { "key": "per_page", "value": "" } ], "variable": [ { "key": "id", "value": "", "description": "(Required) Unique identifier for year group." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": \"Access Denied\"\n}" } ] }, { "name": "Add Students to a Year Group", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"student_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/year-groups/:id/add_students", "host": [ "{{baseUrl}}" ], "path": [ "year-groups", ":id", "add_students" ], "variable": [ { "key": "id", "value": "{{yearGroupId}}", "description": "(Required) Unique identifier for year group." } ] }, "description": "This endpoint adds a list of student IDs to a year group, as specified by the year group ID." }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"student_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/year-groups/:id/add_students", "host": [ "{{baseUrl}}" ], "path": [ "v2", "year-groups", ":id", "add_students" ], "variable": [ { "key": "id", "value": "", "description": "(Required) Unique identifier for year group." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"ok\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"student_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/year-groups/:id/add_students", "host": [ "{{baseUrl}}" ], "path": [ "v2", "year-groups", ":id", "add_students" ], "variable": [ { "key": "id", "value": "", "description": "(Required) Unique identifier for year group." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": \"Access Denied\"\n}" } ] }, { "name": "Remove Students from a Year Group", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"student_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/year-groups/:id/remove_students", "host": [ "{{baseUrl}}" ], "path": [ "year-groups", ":id", "remove_students" ], "variable": [ { "key": "id", "value": "{{yearGroupId}}", "description": "(Required) Unique identifier for year group." } ] }, "description": "This endpoint removes a list of student IDs from a year group, as specified by the year group ID." }, "response": [ { "name": "Success", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"student_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/year-groups/:id/remove_students", "host": [ "{{baseUrl}}" ], "path": [ "v2", "year-groups", ":id", "remove_students" ], "variable": [ { "key": "id", "value": "", "description": "(Required) Unique identifier for year group." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"ok\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"student_ids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/year-groups/:id/remove_students", "host": [ "{{baseUrl}}" ], "path": [ "v2", "year-groups", ":id", "remove_students" ], "variable": [ { "key": "id", "value": "", "description": "(Required) Unique identifier for year group." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": \"Access Denied\"\n}" } ] }, { "name": "Get Advisors", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/year-groups/:id/advisors", "host": [ "{{baseUrl}}" ], "path": [ "year-groups", ":id", "advisors" ], "variable": [ { "key": "id", "value": "{{yearGroupId}}", "description": "(Required) Unique identifier for year group." } ] }, "description": "This endpoint retrieves the Homeroom, CAS, EE and TOK advisors for a year group, as specified by the year group ID. Returns advisor’s ID/s and role/s." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/year-groups/:id/advisors", "host": [ "{{baseUrl}}" ], "path": [ "v2", "year-groups", ":id", "advisors" ], "variable": [ { "key": "id", "value": "", "description": "(Required) Unique identifier for year group." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"advisors\": [\n {\n \"id\": 10193613,\n \"roles\": [\n \"homeroom\"\n ]\n },\n {\n \"id\": 12425959,\n \"roles\": [\n \"cas\"\n ]\n }\n ]\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/year-groups/:id/advisors", "host": [ "{{baseUrl}}" ], "path": [ "v2", "year-groups", ":id", "advisors" ], "variable": [ { "key": "id", "value": "", "description": "(Required) Unique identifier for year group." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": \"Access Denied\"\n}" } ] }, { "name": "Get Homeroom Attendance for a Year Group and Term", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/year-groups/:yearGroupId/homeroom/attendance/term/:term_id", "host": [ "{{baseUrl}}" ], "path": [ "year-groups", ":yearGroupId", "homeroom", "attendance", "term", ":term_id" ], "variable": [ { "key": "yearGroupId", "value": "{{yearGroupId}}" }, { "key": "term_id", "value": "{{termId}}", "description": "(Required) Unique identifier for academic term." } ] }, "description": "This endpoint retrieves homeroom attendance for students belonging to a year group. Attendance is retrieved by academic term, as specified by academic term ID." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/year-groups/:id/homeroom/attendance/term/:term_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "year-groups", ":id", "homeroom", "attendance", "term", ":term_id" ], "variable": [ { "key": "id", "value": "", "description": "(Required) Unique identifier for year group." }, { "key": "term_id", "value": "", "description": "(Required) Unique identifier for academic term." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"students\": [\n {\n \"id\": 10193652,\n \"attendance\": {\n \"Present\": 57,\n \"Late\": 2,\n \"Absent\": 1\n }\n },\n {\n \"id\": 12449380,\n \"attendance\": {\n \"Present\": 60\n }\n }\n ]\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/year-groups/:id/homeroom/attendance/term/:term_id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "year-groups", ":id", "homeroom", "attendance", "term", ":term_id" ], "variable": [ { "key": "id", "value": "", "description": "(Required) Unique identifier for year group." }, { "key": "term_id", "value": "", "description": "(Required) Unique identifier for academic term." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": \"Access Denied\"\n}" } ] }, { "name": "Get Homeroom Attendance for a Year Group by Date", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/year-groups/:id/homeroom/attendance/date/:date", "host": [ "{{baseUrl}}" ], "path": [ "year-groups", ":id", "homeroom", "attendance", "date", ":date" ], "variable": [ { "key": "id", "value": "{{yearGroupId}}", "description": "(Required) Unique identifier for year group." }, { "key": "date", "value": "", "description": "(Required) A date string" } ] }, "description": "This endpoint retrieves homeroom attendance for students as specified by year group ID and date." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/year-groups/:id/homeroom/attendance/date/:date", "host": [ "{{baseUrl}}" ], "path": [ "v2", "year-groups", ":id", "homeroom", "attendance", "date", ":date" ], "variable": [ { "key": "id", "value": "", "description": "(Required) Unique identifier for year group." }, { "key": "date", "value": "", "description": "(Required) A date string" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"students\": [\n {\n \"id\": 10193652,\n \"attendance\": {\n \"status\": \"Present\",\n \"note\": \"\"\n }\n },\n {\n \"id\": 12449380,\n \"attendance\": {\n \"status\": \"Absent\",\n \"note\": \"Chloe was absent due to a dentist appointment.\"\n }\n }\n ]\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/year-groups/:id/homeroom/attendance/date/:date", "host": [ "{{baseUrl}}" ], "path": [ "v2", "year-groups", ":id", "homeroom", "attendance", "date", ":date" ], "variable": [ { "key": "id", "value": "", "description": "(Required) Unique identifier for year group." }, { "key": "date", "value": "", "description": "(Required) A date string" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": \"Access Denied\"\n}" } ] } ], "description": "This section describes all the APIs relating to year groups." }, { "name": "Memberships", "item": [ { "name": "Get all Memberships", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/memberships?classes=active", "host": [ "{{baseUrl}}" ], "path": [ "memberships" ], "query": [ { "key": "modified_since", "value": "", "description": "A timestamp to filter the modification date of results.", "disabled": true }, { "key": "page", "value": "", "description": "An integer defining which page to display.", "disabled": true }, { "key": "per_page", "value": "", "description": "An integer defining the number of records to display per page.", "disabled": true }, { "key": "deleted_since", "value": "", "description": "A timestamp to filter the deletion date of results.", "disabled": true }, { "key": "user_ids", "value": "{{studentId}}", "disabled": true }, { "key": "classes", "value": "active" } ] }, "description": "This endpoint retrieves all members for each class (students, teachers and admin). It returns for each user the class ID, user ID, user role in the class and other details." }, "response": [ { "name": "successful", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/memberships?modified_since=&page=&per_page=&deleted_since=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "memberships" ], "query": [ { "key": "modified_since", "value": "" }, { "key": "page", "value": "" }, { "key": "per_page", "value": "" }, { "key": "deleted_since", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"memberships\": [\n {\n \"id\": \"\",\n \"user_id\": \"\",\n \"level\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"class_id\": \"\",\n \"user_email\": \"\",\n \"uniq_class_id\": \"\",\n \"uniq_student_id\": \"\",\n \"role\": \"\"\n },\n {\n \"id\": \"\",\n \"user_id\": \"\",\n \"level\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"class_id\": \"\",\n \"user_email\": \"\",\n \"uniq_class_id\": \"\",\n \"uniq_student_id\": \"\",\n \"role\": \"\"\n }\n ],\n \"meta\": {\n \"current_page\": \"\",\n \"total_pages\": \"\",\n \"total_count\": \"\",\n \"per_page\": \"\"\n }\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/memberships?modified_since=&page=&per_page=&deleted_since=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "memberships" ], "query": [ { "key": "modified_since", "value": "" }, { "key": "page", "value": "" }, { "key": "per_page", "value": "" }, { "key": "deleted_since", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": \"Access Denied\"\n}" } ] }, { "name": "Get a Student Memberships", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/students/:id/memberships", "host": [ "{{baseUrl}}" ], "path": [ "students", ":id", "memberships" ], "variable": [ { "key": "id", "value": "{{studentId}}" } ] } }, "response": [] }, { "name": "Get Memberships for a Teacher", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teachers/:id/groups", "host": [ "{{baseUrl}}" ], "path": [ "teachers", ":id", "groups" ], "variable": [ { "key": "id", "value": "10948384" } ] } }, "response": [] }, { "name": "Get Memberships for a Teacher Copy", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/teachers/:id/groups", "host": [ "{{baseUrl}}" ], "path": [ "teachers", ":id", "groups" ], "variable": [ { "key": "id", "value": "10948384" } ] } }, "response": [] } ], "description": "This section describes all the APIs relating to student and teacher memberships of classes." }, { "name": "Behavior Notes", "item": [ { "name": "Get all behavior notes", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/behavior/notes", "host": [ "{{baseUrl}}" ], "path": [ "behavior", "notes" ], "query": [ { "key": "page", "value": "", "description": "An integer defining which page to display.", "disabled": true }, { "key": "per_page", "value": "", "description": "An integer defining the number of records to display per page.", "disabled": true } ] }, "description": "This endpoint retrieves all the available behavior notes for the School." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/behavior/notes?page=&per_page=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "behavior", "notes" ], "query": [ { "key": "page", "value": "" }, { "key": "per_page", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"behavior_notes\": [\n {\n \"id\": \"\",\n \"student_id\": \"\",\n \"email\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"grade\": \"\",\n \"incident_time\": \"\",\n \"behavior_type\": \"\",\n \"notes\": \"\",\n \"next_step\": \"\",\n \"next_step_date\": \"\",\n \"reported_by\": \"\",\n \"homeroom_advisor\": \"\"\n },\n {\n \"id\": \"\",\n \"student_id\": \"\",\n \"email\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"grade\": \"\",\n \"incident_time\": \"\",\n \"behavior_type\": \"\",\n \"notes\": \"\",\n \"next_step\": \"\",\n \"next_step_date\": \"\",\n \"reported_by\": \"\",\n \"homeroom_advisor\": \"\"\n }\n ],\n \"meta\": {\n \"current_page\": \"\",\n \"total_pages\": \"\",\n \"total_count\": \"\",\n \"per_page\": \"\"\n }\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/behavior/notes?page=&per_page=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "behavior", "notes" ], "query": [ { "key": "page", "value": "" }, { "key": "per_page", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": \"Access Denied\"\n}" } ] } ], "description": "This section describes all the APIs relating to student behavior notes." }, { "name": "Utilities", "item": [ { "name": "Get Avatar", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/avatars/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "avatars", ":id" ], "variable": [ { "key": "id", "value": "", "description": "(Required) Unique identifier for user." } ] }, "description": "This endpoint retrieves the avatar of a user, as specified by user ID." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/avatars/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "avatars", ":id" ], "variable": [ { "key": "id", "value": "", "description": "(Required) Unique identifier for user." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Redirect", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/avatars/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "avatars", ":id" ], "variable": [ { "key": "id", "value": "", "description": "(Required) Unique identifier for user." } ] } }, "status": "Found", "code": 302, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/avatars/:id", "host": [ "{{baseUrl}}" ], "path": [ "v2", "avatars", ":id" ], "variable": [ { "key": "id", "value": "", "description": "(Required) Unique identifier for user." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": \"Access Denied\"\n}" } ] }, { "name": "Ping", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/ping", "host": [ "{{baseUrl}}" ], "path": [ "ping" ] }, "description": "This endpoint determines whether the API key is valid." }, "response": [ { "name": "Success", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/ping", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ping" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"pong\": \"ok\"\n}" }, { "name": "Unauthorized", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/v2/ping", "host": [ "{{baseUrl}}" ], "path": [ "v2", "ping" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"error\": \"Access Denied\"\n}" } ] } ], "description": "This section describes all the APIs relating to utilities." } ], "auth": { "type": "apikey", "apikey": [ { "key": "in", "value": "header", "type": "string" }, { "key": "value", "value": "{{auth-token}}", "type": "string" }, { "key": "key", "value": "auth-token", "type": "string" } ] }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ], "variable": [ { "key": "baseUrl", "value": "https://{{subdomain}}.managebac.{{tld}}/{{version}}" }, { "key": "studentId", "value": "" }, { "key": "classId", "value": "" }, { "key": "termId", "value": "" }, { "key": "teacherId", "value": "" }, { "key": "yearGroupId", "value": "" }, { "key": "taskId", "value": "" }, { "key": "parentId", "value": "" } ] }