Provides abilty to add students, purchase programs, enroll courses and retrieve class progress reports.
\nJSON data in all calls must be wrapped in an array even if only one object is needed or is being sent.
\nIn the code examples:
\nReplace {{proto}} with https
\nReplace {{env}} with your api url.
\nYour api url will look like: api.{{partner_name}}.fvhsonline.com
\nField names must be lower case.
Uses BASIC authentication and an X-api-key
Errors will be returned as JSON objects like: {\"error-1\": \"id 3 is invalid\"}
Unknown
\nAll phone numbers must be in international phone number format.
\nMax total length = 25
\n+ is optional as the first char.
\nDigit separator chars are /-() and {space}.
\nParens must be matched.
\nX plus 1-6 digit extension is optional
Returns student demographic information.
\n","urlObject":{"protocol":"{{proto}}","path":["student","{{idstudent}}"],"host":["{{env}}"],"query":[],"variable":[]}},"response":[{"id":"f1d88446-be30-4af9-afdd-3b47a5e2f1e0","name":"Get Student","originalRequest":{"method":"GET","header":[{"key":"X-api-key","value":"{{apikey}}","disabled":false}],"url":"{{proto}}://{{env}}/student/2040"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache","name":"Cache-Control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"Content-Length","value":"414","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Wed, 25 Jul 2018 07:58:39 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Expires","value":"-1","name":"Expires","description":"Gives the date/time after which the response is considered stale"},{"key":"Pragma","value":"no-cache","name":"Pragma","description":"Implementation-specific headers that may have various effects anywhere along the request-response chain."},{"key":"Server","value":"Microsoft-IIS/8.5","name":"Server","description":"A name for the server"},{"key":"X-AspNet-Version","value":"4.0.30319","name":"X-AspNet-Version","description":"Custom header"},{"key":"X-Powered-By","value":"ASP.NET","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":"[\r\n\t{\r\n\t\t\"FirstName\": \"Michael\",\r\n\t\t\"Middle\": null,\r\n\t\t\"LastName\": \"Testing\",\r\n\t\t\"nickname\": \"Mike\",\r\n\t\t\"EmailAddress\": \"mchoate7a@cox.net\",\r\n\t\t\"Phone\": \"+1 602 555-1212\",\r\n\t\t\"Address\": \"123 Main St.\",\r\n\t\t\"Address2\": null,\r\n\t\t\"Address3\": null,\r\n\t\t\"City\": \"Any City\",\r\n\t\t\"State\": \"Any Province\",\r\n\t\t\"Country\": \"US\",\r\n\t\t\"DOB\": \"1997-12-22T00:00:00\",\r\n\t\t\"DateRegistered\": \"2017-12-28T00:59:15.19\",\r\n\t\t\"ethnicity\": 5,\r\n\t\t\"gradelevel\": 0,\r\n\t\t\"idAgent\": 4,\r\n\t\t\"ZipCode\": \"Any Postal\",\r\n\t\t\"userField\": \"choate family\"\r\n\t}\r\n]\r\n"}],"_postman_id":"36b94389-bc0b-452d-9367-f914585ffc91"},{"name":"Get Agent","id":"85f66d9e-75a5-4d81-a55f-eb869104908e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{loginuser}}"},{"key":"password","value":"{{loginpsw}}"}]},"isInherited":false},"method":"GET","header":[{"key":"X-api-key","value":"{{apikey}}"}],"url":"{{proto}}://{{env}}/agent/{{idagent}}","description":"Returns agent information for specific agent.
\n","urlObject":{"protocol":"{{proto}}","path":["agent","{{idagent}}"],"host":["{{env}}"],"query":[],"variable":[]}},"response":[{"id":"f568bbc6-afad-4a06-ac47-c27aae91c6b9","name":"Get Agent","originalRequest":{"method":"GET","header":[{"key":"X-api-key","value":"{{apikey}}"}],"url":"{{proto}}://{{env}}/agent/{{idagent}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.5"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 08 Jan 2019 02:26:08 GMT"},{"key":"Content-Length","value":"73"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"idagent\": 159,\n \"agent\": \"Agent Name\",\n \"agent_company\": \"Agent Company\",\n \"idpartner\": 123,\n \"partner\": \"Partner Name\",\n \"partner_company\": \"Partner Company\"\n }\n]"}],"_postman_id":"85f66d9e-75a5-4d81-a55f-eb869104908e"},{"name":"Get Agents","id":"a394680c-ce10-4d31-b35d-06eeb213b260","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{loginuser}}"},{"key":"password","value":"{{loginpsw}}"}]},"isInherited":false},"method":"GET","header":[{"key":"X-api-key","value":"{{apikey}}"}],"url":"{{proto}}://{{env}}/agents","description":"Returns agent information for all agents of default partner.
\n","urlObject":{"protocol":"{{proto}}","path":["agents"],"host":["{{env}}"],"query":[],"variable":[]}},"response":[{"id":"c652b3dc-e51a-4a54-9fe9-26ed63d79d65","name":"Get Agents","originalRequest":{"method":"GET","header":[{"key":"X-api-key","value":"{{apikey}}"}],"url":"{{proto}}://{{env}}/agents"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 12 May 2019 12:00:44 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Kestrel"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"partners\": [\n {\n \"idpartner\": 321,\n \"partner\": \"Partner Name\",\n \"partner_company\": \"Partner Company\",\n \"agents\": [\n {\n \"idagent\": 165,\n \"agent\": \"Agent1 Name\",\n \"agent_company\": \"Agent1 Company\"\n },\n {\n \"idagent\": 143,\n \"agent\": \"Agent2 Name\",\n \"agent_company\": \"Agent2 Company\"\n }\n ]\n }\n ]\n}"}],"_postman_id":"a394680c-ce10-4d31-b35d-06eeb213b260"},{"name":"Get Student Enrollment","id":"319bf279-6e54-4501-8e9f-b0f8e8104a90","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{loginuser}}"},{"key":"password","value":"{{loginpsw}}"}]},"isInherited":false},"method":"GET","header":[{"key":"X-api-key","value":"{{apikey}}"}],"url":"{{proto}}://{{env}}/studentenrollment/{{idstudent}}","description":"Returns student enrollment information
\n","urlObject":{"protocol":"{{proto}}","path":["studentenrollment","{{idstudent}}"],"host":["{{env}}"],"query":[],"variable":[]}},"response":[{"id":"618ef174-fe4a-4580-8f26-b93e57e31164","name":"Get Student Enrollment","originalRequest":{"method":"GET","header":[{"key":"X-api-key","value":"{{apikey}}"}],"url":"{{proto}}://{{env}}/studentenrollment/{{idstudent}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/8.5"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 08 Jan 2019 02:29:10 GMT"},{"key":"Content-Length","value":"273"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"idstudent\": 2040,\n \"idprogram_group\": 6,\n \"idprogram\": 8,\n \"program_name\": \"Independent Study\",\n \"enrollment_status\": \"Pending Course Validation\",\n \"homeroom_teacher\": 33,\n \"enroll_date\": \"2018-02-01T03:19:41.997\",\n \"expiration_date\": \"2019-10-03T02:38:19.333\",\n \"last_session_date\": null,\n \"total_login_time\": null,\n \"number_of_logins\": null\n },\n {\n \"idstudent\": 2040,\n \"idprogram_group\": 6,\n \"idprogram\": 9,\n \"program_name\": \"Pre-Academic Year Program\",\n \"enrollment_status\": \"Active\",\n \"homeroom_teacher\": 33,\n \"enroll_date\": \"2018-02-01T03:23:57.867\",\n \"expiration_date\": \"2019-03-31T00:00:00\",\n \"last_session_date\": \"2018-03-07T11:36:46.973\",\n \"total_login_time\": null,\n \"number_of_logins\": 1\n }\n]"}],"_postman_id":"319bf279-6e54-4501-8e9f-b0f8e8104a90"},{"name":"Get Student List","event":[{"listen":"prerequest","script":{"id":"d2a3ec90-f4bf-49da-8927-887a54711ac3","exec":["pm.environment.set(\"variable_key\", \"variable_value\");","pm.environment.get(\"apikey\");",""],"type":"text/javascript"}}],"id":"c86e1a04-c89c-41dd-9fea-f94c187c5dbc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{loginuser}}"},{"key":"password","value":"{{loginpsw}}"}]},"isInherited":false},"method":"GET","header":[{"key":"X-api-key","value":"{{apikey}}"}],"url":"{{proto}}://{{env}}/studentlist/{{idagent}}/{{limit}}/{{detail}}","description":"Returns a list of students.
\n{{limit}} sets number of records returned (500 max, 100 default).
\n{{detail}} sets number of fields returned per record.
\n{{limit}} and {{detail}} are optional
\n","urlObject":{"protocol":"{{proto}}","path":["studentlist","{{idagent}}","{{limit}}","{{detail}}"],"host":["{{env}}"],"query":[],"variable":[]}},"response":[{"id":"6b8a361a-9d7f-4dfd-8754-528641788584","name":"Get Student List","originalRequest":{"method":"GET","header":[{"key":"X-api-key","value":"{{apikey}}"}],"url":"{{proto}}://{{env}}/studentlist/{{idagent}}/{{limit}}/{{detail}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 04 Mar 2019 07:11:12 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Kestrel"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"idstudent\": 2284,\n \"emailaddress\": \"2284@cox2291.net\"\n },\n {\n \"idstudent\": 2283,\n \"emailaddress\": \"2283@cox2291.net\"\n },\n {\n \"idstudent\": 2282,\n \"emailaddress\": \"x018@cox2291.net\"\n },\n {\n \"idstudent\": 2281,\n \"emailaddress\": \"017@cox2291.net\"\n },\n {\n \"idstudent\": 2280,\n \"emailaddress\": \"013@cox2291.net\"\n },\n {\n \"idstudent\": 2279,\n \"emailaddress\": \"012@cox2291.net\"\n },\n {\n \"idstudent\": 2278,\n \"emailaddress\": \"009@cox2291.net\"\n },\n {\n \"idstudent\": 2277,\n \"emailaddress\": \"008@cox2291.net\"\n },\n {\n \"idstudent\": 2276,\n \"emailaddress\": \"007@cox2291.net\"\n },\n {\n \"idstudent\": 2275,\n \"emailaddress\": \"006@cox2291.net\"\n }\n]"}],"_postman_id":"c86e1a04-c89c-41dd-9fea-f94c187c5dbc"},{"name":"Get Student Class Login","id":"cc8e3711-4d57-4fc6-afe8-e6e45abdf8e3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{loginuser}}"},{"key":"password","value":"{{loginpsw}}"}]},"isInherited":false},"method":"GET","header":[{"key":"X-api-key","value":"{{apikey}}"}],"url":"{{proto}}://{{env}}/classlogin/{{idstudent}}/{{idprogram}}","description":"To login, send a classlogin request to the API.
\nIf successful, a URL is returned which is good for one login.
\n{{idprogram}} is optional and defaults to Independent Study Program (idprogram = 8)
\nThe URL looks like this: \nhttp://r647.core.learn.vendor.com/student/?userid=e39e373d%3d
\nThe above example url is not a valid link.
The link will open to the student's classroom displaying his/her selected classes.
\nPossible returns are:
\n","urlObject":{"protocol":"{{proto}}","path":["classlogin","{{idstudent}}","{{idprogram}}"],"host":["{{env}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"cc8e3711-4d57-4fc6-afe8-e6e45abdf8e3"},{"name":"Get Proctor List for Student","id":"8d0625d0-f3de-4fdc-a80f-1834697b0834","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{loginuser}}"},{"key":"password","value":"{{loginpsw}}"}]},"isInherited":false},"method":"GET","header":[{"key":"X-api-key","value":"{{apikey}}"}],"url":"{{proto}}://{{env}}/proctorlist/{{idstudent}}","urlObject":{"protocol":"{{proto}}","path":["proctorlist","{{idstudent}}"],"host":["{{env}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8d0625d0-f3de-4fdc-a80f-1834697b0834"},{"name":"Get Proctor ","id":"b39bc43b-5643-414a-bfab-3eac1b8eb4c9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{loginuser}}"},{"key":"password","value":"{{loginpsw}}"}]},"isInherited":false},"method":"GET","header":[{"key":"X-api-key","value":"{{apikey}}"}],"url":"{{proto}}://{{env}}/proctor/{{idproctor}}","urlObject":{"protocol":"{{proto}}","path":["proctor","{{idproctor}}"],"host":["{{env}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b39bc43b-5643-414a-bfab-3eac1b8eb4c9"},{"name":"Get Products for Program(s)","id":"3f8ea8a9-0ddb-4c3b-b652-0ad6f6f284b5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{loginuser}}"},{"key":"password","value":"{{loginpsw}}"}]},"isInherited":false},"method":"GET","header":[{"key":"X-api-key","value":"{{apikey}}"}],"url":"{{proto}}://{{env}}/products/{{idprogram}}","urlObject":{"protocol":"{{proto}}","path":["products","{{idprogram}}"],"host":["{{env}}"],"query":[],"variable":[]}},"response":[{"id":"19efa580-72ff-449e-a810-d5e300e1c132","name":"Get Products for Program(s)","originalRequest":{"method":"GET","header":[{"key":"X-api-key","value":"{{apikey}}"}],"url":"{{proto}}://{{env}}/products/{{idprogram}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 12 May 2019 12:05:18 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Kestrel"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"idprogram\": 8,\n \"name\": \"Independent Study\",\n \"code\": \"IS\",\n \"products\": [\n {\n \"idproduct\": 57,\n \"name\": \"Independent Study Program - Access Fee (1 month)\",\n \"term\": \"1 m \"\n },\n {\n \"idproduct\": 80,\n \"name\": \"FVHS Soft Skills Program Single Course 1-3\",\n \"term\": \"3 m\"\n },\n {\n \"idproduct\": 81,\n \"name\": \"FVHS Soft Skills Program Course 4 \",\n \"term\": \"3 m\"\n },\n {\n \"idproduct\": 82,\n \"name\": \"FVHS Soft Skills Program Full Group Membership - Monthly\",\n \"term\": \"1 m\"\n },\n {\n \"idproduct\": 83,\n \"name\": \"FVHS Soft Skills Program Full Group Membership - Quarterly\",\n \"term\": \"3 m\"\n }\n ]\n }\n]"}],"_postman_id":"3f8ea8a9-0ddb-4c3b-b652-0ad6f6f284b5"},{"name":"Get Courses for Student(s)","id":"e9d7863c-e500-412c-afc4-d8e657149532","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{loginuser}}"},{"key":"password","value":"{{loginpsw}}"}]},"isInherited":false},"method":"GET","header":[{"key":"X-api-key","value":"{{apikey}}"}],"url":"{{proto}}://{{env}}/studentcourses/{{idstudent}}/{{limit}}","description":"Returns array of idstudent's SCDIB courses.
\n{{limit}} = total number of students returned, defaults to 100
\nif {{idstudent}} = 0, all students are returned up to {{limit}}
\n","urlObject":{"protocol":"{{proto}}","path":["studentcourses","{{idstudent}}","{{limit}}"],"host":["{{env}}"],"query":[],"variable":[]}},"response":[{"id":"3dbc1458-4659-48bc-8ddc-b3e5143b7e29","name":"Get Courses for Student(s)","originalRequest":{"method":"GET","header":[{"key":"X-api-key","value":"{{apikey}}"}],"url":"{{proto}}://{{env}}/studentcourses/{{idstudent}}/{{limit}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 12 May 2019 12:05:52 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Kestrel"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"idstudent\": 2054,\r\n \"programs\": [\r\n {\r\n \"idprogram\": 12,\r\n \"courses\": [\r\n {\r\n \"scbid\": 242321560,\r\n \"class\": \"ELE with Reading - Level 1 A\",\r\n \"subject\": \"Literature\",\r\n \"confirmed\": true,\r\n \"transfer\": false,\r\n \"accepted\": false\r\n },\r\n {\r\n \"scbid\": 242321567,\r\n \"class\": \"ELE with Reading - Level 1 B\",\r\n \"subject\": \"Literature\",\r\n \"confirmed\": true,\r\n \"transfer\": false,\r\n \"accepted\": false\r\n },\r\n {\r\n \"scbid\": 242321579,\r\n \"class\": \"ELE with Reading - Level 2 A\",\r\n \"subject\": \"Literature\",\r\n \"confirmed\": true,\r\n \"transfer\": false,\r\n \"accepted\": false\r\n },\r\n {\r\n \"scbid\": 242321589,\r\n \"class\": \"ELE with Reading - Level 2 B\",\r\n \"subject\": \"Literature\",\r\n \"confirmed\": true,\r\n \"transfer\": false,\r\n \"accepted\": false\r\n }\r\n ]\r\n },\r\n {\r\n \"idprogram\": 8,\r\n \"courses\": [\r\n {\r\n \"scbid\": 12062039,\r\n \"class\": \"ELA English 1 A\",\r\n \"subject\": \"Literature\",\r\n \"confirmed\": true,\r\n \"transfer\": false,\r\n \"accepted\": false\r\n },\r\n {\r\n \"scbid\": 12062040,\r\n \"class\": \"ELA English 1 B\",\r\n \"subject\": \"Literature\",\r\n \"confirmed\": true,\r\n \"transfer\": false,\r\n \"accepted\": false\r\n },\r\n {\r\n \"scbid\": 12062041,\r\n \"class\": \"ELA English 1\",\r\n \"subject\": \"Literature\",\r\n \"confirmed\": true,\r\n \"transfer\": false,\r\n \"accepted\": false\r\n }\r\n ]\r\n }\r\n ]\r\n }\r\n]"}],"_postman_id":"e9d7863c-e500-412c-afc4-d8e657149532"},{"name":"Get Courses for Program(s)","id":"3a014c53-1929-484c-938f-ef57d6f021f7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{loginuser}}"},{"key":"password","value":"{{loginpsw}}"}]},"isInherited":false},"method":"GET","header":[{"key":"X-api-key","value":"{{apikey}}"}],"url":"{{proto}}://{{env}}/courses/{{idprogram}}","description":"{{proto}}://{{env}}/courses/{{idprogram}}
\nShow courses for {{idprogram}}
\n{{proto}}://{{env}}/courses
\nShow courses for all idprograms
\n","urlObject":{"protocol":"{{proto}}","path":["courses","{{idprogram}}"],"host":["{{env}}"],"query":[],"variable":[]}},"response":[{"id":"e28b1ee1-5673-448c-8c23-920008b75ee9","name":"Get Courses for Program(s)","originalRequest":{"method":"GET","header":[{"key":"X-api-key","value":"{{apikey}}"}],"url":"{{proto}}://{{env}}/courses/12"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 12 May 2019 12:09:11 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Kestrel"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"idprogram\": 12,\n \"description\": \"English Language Enhancement\",\n \"courses\": [\n {\n \"scbid\": 246157487,\n \"class\": \"ELE with Reading - Level 4 A\",\n \"subject\": \"Literature\"\n },\n {\n \"scbid\": 246157488,\n \"class\": \"ELE with Reading - Level 4 B\",\n \"subject\": \"Literature\"\n },\n {\n \"scbid\": 246157489,\n \"class\": \"ELE with Math - Level 1 A\",\n \"subject\": \"Math\"\n },\n {\n \"scbid\": 246157490,\n \"class\": \"ELE with Math - Level 1 B\",\n \"subject\": \"Math\"\n }\n ]\n }\n]"}],"_postman_id":"3a014c53-1929-484c-938f-ef57d6f021f7"},{"name":"Get Course Progress Information","id":"75163af9-e934-40ca-bef8-1d2d5beb68ce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{loginuser}}"},{"key":"password","value":"{{loginpsw}}"}]},"isInherited":false},"method":"GET","header":[{"key":"x-api-key","value":"{{apikey}}"}],"url":"{{proto}}://{{env}}/studentprogress/{{idstudent}}","urlObject":{"protocol":"{{proto}}","path":["studentprogress","{{idstudent}}"],"host":["{{env}}"],"query":[],"variable":[]}},"response":[{"id":"4c0e033c-e4fa-4d51-8d58-12571bcf4f67","name":"Get Course Progress Information","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"{{apikey}}"}],"url":"{{proto}}://{{env}}/studentprogress/{{idstudent}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 12 May 2019 12:10:51 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Kestrel"},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\r\n \"idstudent\": 2054,\r\n \"studentprogess\": [\r\n {\r\n \"actualGrade\": 17.6499233,\r\n \"completedAssignments\": 5,\r\n \"courseName\": \"ELE with Reading - Level 1 A\",\r\n \"overallGrade\": 70,\r\n \"percentByCount\": 5.681818,\r\n \"percentByTime\": 9.6054,\r\n \"percentExpected\": 38.0952377,\r\n \"progressDate\": \"2019-05-12T00:00:00\",\r\n \"relativeGrade\": 2.5,\r\n \"studentBuildId\": 246133555,\r\n \"totalAssignments\": 88,\r\n \"userId\": 225405581\r\n },\r\n {\r\n \"actualGrade\": 4.2441287,\r\n \"completedAssignments\": 6,\r\n \"courseName\": \"ELE with Reading - Level 3 A\",\r\n \"overallGrade\": 35.4166679,\r\n \"percentByCount\": 4.83871,\r\n \"percentByTime\": 4.565113,\r\n \"percentExpected\": 38.0952377,\r\n \"progressDate\": \"2019-05-12T00:00:00\",\r\n \"relativeGrade\": 1.02163458,\r\n \"studentBuildId\": 246133559,\r\n \"totalAssignments\": 124,\r\n \"userId\": 225405581\r\n }\r\n ]\r\n}"}],"_postman_id":"75163af9-e934-40ca-bef8-1d2d5beb68ce"},{"name":"Register student","id":"6a87653d-3f3c-4253-839b-5cf2abe9bb99","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"For registration of students in programs that will not be requesting transcripts all address fields are not required. See required fields below.
\nREQUIRED:\nInclude idagent in all new student registration to make sure the correct agent is assigned.
\nOPTIONAL: To include proctor information, append field \"proctor\": to student data. See proctor field specification at 'Add Proctor for Student' below.\nA proctor is only required for academic programs that include tests. A proctor is not required for Sample Class, SAT, GED, ACT, Pre-AYP and ELE.
\n** Nickname or \"English\" name is recommended for use by U.S. Teachers
\n","urlObject":{"protocol":"https","path":["student"],"host":["{{env}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6a87653d-3f3c-4253-839b-5cf2abe9bb99"},{"name":"Enroll Student in Program","id":"2b8671b1-9a43-4b3f-ab40-61ffcb02ddbf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Enroll a student in a new Program or extend the access time of an existing Program by authorizing purchase of a Product.
\nReturn value is the IdProgram enrolled in by purchasing the selected IdProduct.
\nAdd courses to an enrolled program for a student.
Use 'Enroll program for student' to enroll a student in a program.
Consult the program and course table to find the SCBID for the course.
The start date is the date when the student will begin study (usually the same date as the program enrollment date).
The planned end date is the date when the student should finish the course (used to compute the 'percent complete' value for progress reports).
Courses for Special Programs may be added automatically on enrollment. It may not be possible to add courses to Special Programs using this method.
\n","urlObject":{"protocol":"{{proto}}","path":["courses"],"host":["{{env}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b13220ed-dd07-42e3-b8b7-a6b7bb17e927"},{"name":"Add Proctor for Student","id":"55ba44dd-5efe-4654-a8fe-c900c7098a94","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{loginuser}}"},{"key":"password","value":"{{loginpsw}}"}]},"isInherited":false},"method":"POST","header":[{"key":"X-api-key","value":"{{apikey}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\r\n\t{\r\n\t\t\"idstudent\": \"1542\",\r\n\t\t\"idrelation\": \"2\",\r\n\t\t\"firstname\": \"Mike\",\r\n\t\t\"middle\": null,\r\n\t\t\"lastname\": \"Choate\",\r\n\t\t\"emailaddress\": \"mchoate@cox99.net\",\r\n\t\t\"phone\": \"+1(602)569-0980\",\r\n\t\t\"address\": \"10028 N 28th St.\",\r\n\t\t\"address2\": null,\r\n\t\t\"address3\": null,\r\n\t\t\"city\": \"Phoenix\",\r\n\t\t\"state\": \"AZ\",\r\n\t\t\"country\": \"US\",\r\n\t\t\"zipcode\": \"85028\"\r\n\t}\r\n]\r\n "},"url":"{{proto}}://{{env}}/proctor","description":"A proctor is only required for academic programs that include tests.
\nA proctor is not required for Sample Class, SAT, GED, ACT, Pre-AYP and ELE.
Address fields are not required for the proctor except the 2-digit country code.
\nData for new Agent and data for new Company in the same api call: \n
\nAgent Data
\nAgent Programs programs {}
'true' means program is available.
\n* English/Chinese/French/Latin/Spanish
\n** Core Subject/Electives
\nCompany Data
Data for new Agent of existing Company\n
Agent Data
\nAgent Programs programs {}
'true' means program is available.
\n* English/Chinese/French/Latin/Spanish
\n** Core Subject/Electives
Data for new Agent of Partner Company\n
\nAgent Data
\nAgent Programs programs {}
'true' means program is available.
\n* English/Chinese/French/Latin/Spanish
\n** Core Subject/Electives
Request may contain any of the standard user fields. Fields not included will not be updated.
\n** Nickname or \"English\" name is recommended for use by U.S. Teachers
\n","urlObject":{"protocol":"{{proto}}","path":["student","2036"],"host":["{{env}}"],"query":[],"variable":[]}},"response":[{"id":"815bdc0d-a09e-4f62-aca5-5de45aa61b60","name":"Update Student Information","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-api-key","value":"{{apikey}}"}],"body":{"mode":"raw","raw":"[\r\n\t{\r\n\t\t\"firstname\": \"Mike\",\r\n\t\t\"lastname\": \"Choate\",\r\n\t\t\"nickname\": \"API Testing\",\r\n\t\t\"emailaddress\": \"tech2048@esplearning.com\",\r\n\t\t\"password\": \"iAbHB0YHCggGBo\",\r\n\t\t\"phone\": \"+1(602)569-0980\",\r\n\t\t\"address\": \"10028 N 28th St.\",\r\n\t\t\"city\": \"Phoenix\",\r\n\t\t\"state\": \"AZ\",\r\n\t\t\"country\": \"US\",\r\n\t\t\"dob\": \"1994-12-19T00:00:00\",\r\n\t\t\"ethnicity\": 6,\r\n\t\t\"gradelevel\": 4,\r\n\t\t\"idagent\": 117,\r\n\t\t\"zipcode\": \"85028\",\r\n\t\t\"userfield\": \"choate Family\"\r\n\t}\r\n]\r\n"},"url":"{{proto}}://{{env}}/student/{{idstudent}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-SourceFiles","value":"=?UTF-8?B?RjpcaW5ldHB1Yl9URVNUXGFwYXhfYXBpXzAyXGFwYXhfYXBpXzAyXHN0dWRlbnRcMjI2Nw==?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Mon, 07 Jan 2019 23:29:41 GMT"},{"key":"Content-Length","value":"52"}],"cookie":[],"responseTime":null,"body":"{\n \"success-1\": \"idstudent '2267' information updated\"\n}"}],"_postman_id":"e478fef3-e219-44ba-bdd4-4c05dece2227"},{"name":"Update Proctor Information","id":"49391b0f-fa79-4849-9d89-b5f47ebd6a07","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{loginuser}}"},{"key":"password","value":"{{loginpsw}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-api-key","value":"{{apikey}}"}],"body":{"mode":"raw","raw":"[\r\n\t{\r\n\t\t\"idrelation\": \"2\",\r\n\t\t\"firstname\": \"elrod\",\r\n\t\t\"middle\": null,\r\n\t\t\"lastname\": \"johnson\",\r\n\t\t\"emailaddress\": \"elrod@cox99.net\",\r\n\t\t\"phone\": \"+1(602)569-0980\",\r\n\t\t\"address\": \"10028 N 28th St.\",\r\n\t\t\"address2\": null,\r\n\t\t\"address3\": null,\r\n\t\t\"city\": \"Phoenix\",\r\n\t\t\"state\": \"AZ\",\r\n\t\t\"country\": \"US\",\r\n\t\t\"zipcode\": \"85028\"\r\n\t}\r\n]\r\n"},"url":"{{proto}}://{{env}}/proctor/{{idproctor}}","description":"Request may contain any of the standard proctor data fields. Fields not included will not be updated.
\nChange the planned start end planned end dates for a student's course.
\n","urlObject":{"protocol":"{{proto}}","path":["courses","{{idstudent}}"],"host":["{{env}}"],"query":[],"variable":[]}},"response":[{"id":"f34c6526-11b5-4e42-99b5-1489b9ab75b8","name":"Update Course Study Dates for Student","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-api-key","value":"{{apikey}}"}],"body":{"mode":"raw","raw":"[\r\n\t{\r\n\t\t\"scbid\": \"242305814\",\r\n\t\t\"start\": \"2019-01-02\",\r\n\t\t\"end\": \"2019-02-10\"\r\n\t}, \r\n\t{\r\n\t\t\"scbid\": \"11335035\",\r\n\t\t\"start\": \"2019-01-02\",\r\n\t\t\"end\": \"2019-02-10\"\r\n\t}\r\n]\r\n"},"url":"{{proto}}://{{env}}/course/{{idstudent}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-SourceFiles","value":"=?UTF-8?B?RjpcaW5ldHB1Yl9URVNUXGFwYXhfYXBpXzAyXGFwYXhfYXBpXzAyXGNvdXJzZVwyMjY3?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Mon, 07 Jan 2019 23:30:55 GMT"},{"key":"Content-Length","value":"150"}],"cookie":[],"responseTime":null,"body":"{\n \"info-1\": \"scbid '242305814'\",\n \"error-1\": \"start date must be > current date\",\n \"info-2\": \"scbid '11335035'\",\n \"error-2\": \"start date must be > current date\"\n}"}],"_postman_id":"5d6cbae5-21f2-41e8-a999-05560f4dde6b"}],"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"