IMS Candidate Final Public

IMS Global Logo

IMS OneRoster Rostering Service REST/JSON Binding Version 1.2

IMS Candidate Final Public
Version 1.0

Date Issued: 1st July 2021
Latest version: http://www.imsglobal.org/activity/onerosterlis/

IPR and Distribution Notices

Recipients of this document are requested to submit, with their comments, notification of any relevant patent claims or other intellectual property rights of which they may be aware that might be infringed by any implementation of the specification set forth in this document, and to provide supporting documentation.

IMS takes no position regarding the validity or scope of any intellectual property or other rights that might be claimed to pertain to the implementation or use of the technology described in this document or the extent to which any license under such rights might or might not be available; neither does it represent that it has made any effort to identify any such rights. Information on IMS's procedures with respect to rights in IMS specifications can be found at the IMS Intellectual Property Rights web page: http://www.imsglobal.org/ipr/imsipr_policyFinal.pdf.

Copyright © 2021 IMS Global Learning Consortium. All Rights Reserved.

Use of this specification to develop products or services is governed by the license with IMS found on the IMS website: http://www.imsglobal.org/speclicense.html.

Permission is granted to all parties to use excerpts from this document as needed in producing requests for proposals.

The limited permissions granted above are perpetual and will not be revoked by IMS or its successors or assigns.

THIS SPECIFICATION IS BEING OFFERED WITHOUT ANY WARRANTY WHATSOEVER, AND IN PARTICULAR, ANY WARRANTY OF NONINFRINGEMENT IS EXPRESSLY DISCLAIMED. ANY USE OF THIS SPECIFICATION SHALL BE MADE ENTIRELY AT THE IMPLEMENTER'S OWN RISK, AND NEITHER THE CONSORTIUM, NOR ANY OF ITS MEMBERS OR SUBMITTERS, SHALL HAVE ANY LIABILITY WHATSOEVER TO ANY IMPLEMENTER OR THIRD PARTY FOR ANY DAMAGES OF ANY NATURE WHATSOEVER, DIRECTLY OR INDIRECTLY, ARISING FROM THE USE OF THIS SPECIFICATION.

Public contributions, comments and questions can be posted here: www.imsglobal.org/forums/ims-glc-public-forums-and-resources.

Trademark information: http://www.imsglobal.org/copyright.html

Document Name: IMS OneRoster Rostering Service REST/JSON Binding v1.2

Revision: 1st July 2021

toc | top

Abstract

The IMS OneRoster (OR) standard addresses the exchange of student data (primarily about people, courses, enrollments and grades) between different educational systems for the specific needs of K-12. The primary use-case is the exchange of data between a Student Information System (SIS) and Learning Management System (LMS). In OR 1.2, the service has been split into three core services:

This OR 1.2 Rostering Service provides the ability to manage the exchange of information about people, classes, courses, organizations and enrollments. The service description includes the definition of the data formats that are exchanged using a set of service operations. In this document the binding implementation as a REST/JSON service is described.

toc | top

Table of Contents

Abstract

1. Introduction

1.1 Scope and Context

1.2 Conventions

1.3 Changes in Rostering Service 1.2

1.4 Structure of this Document

1.5 Nomenclature

2. REST Endpoints

2.1 Mapping of the Service Operations to the REST Endpoints

2.2 API Root URL and Versioning

2.3 Predefined Endpoint Query Parameters

2.3.1 "getAcademicSession" Endpoint Query Parameters

2.3.2 "getAllAcademicSessions" Endpoint Query Parameters

2.3.3 "getAllClasses" Endpoint Query Parameters

2.3.4 "getAllCourses" Endpoint Query Parameters

2.3.5 "getAllDemographics" Endpoint Query Parameters

2.3.6 "getAllEnrollments" Endpoint Query Parameters

2.3.7 "getAllGradingPeriods" Endpoint Query Parameters

2.3.8 "getAllOrgs" Endpoint Query Parameters

2.3.9 "getAllSchools" Endpoint Query Parameters

2.3.10 "getAllStudents" Endpoint Query Parameters

2.3.11 "getAllTeachers" Endpoint Query Parameters

2.3.12 "getAllTerms" Endpoint Query Parameters

2.3.13 "getAllUsers" Endpoint Query Parameters

2.3.14 "getClass" Endpoint Query Parameters

2.3.15 "getClassesForCourse" Endpoint Query Parameters

2.3.16 "getClassesForSchool" Endpoint Query Parameters

2.3.17 "getClassesForStudent" Endpoint Query Parameters

2.3.18 "getClassesForTeacher" Endpoint Query Parameters

2.3.19 "getClassesForTerm" Endpoint Query Parameters

2.3.20 "getClassesForUser" Endpoint Query Parameters

2.3.21 "getCourse" Endpoint Query Parameters

2.3.22 "getCoursesForSchool" Endpoint Query Parameters

2.3.23 "getDemographics" Endpoint Query Parameters

2.3.24 "getEnrollment" Endpoint Query Parameters

2.3.25 "getEnrollmentsForClassInSchool" Endpoint Query Parameters

2.3.26 "getEnrollmentsForSchool" Endpoint Query Parameters

2.3.27 "getGradingPeriod" Endpoint Query Parameters

2.3.28 "getGradingPeriodsForTerm" Endpoint Query Parameters

2.3.29 "getOrg" Endpoint Query Parameters

2.3.30 "getSchool" Endpoint Query Parameters

2.3.31 "getStudent" Endpoint Query Parameters

2.3.32 "getStudentsForClass" Endpoint Query Parameters

2.3.33 "getStudentsForClassInSchool" Endpoint Query Parameters

2.3.34 "getStudentsForSchool" Endpoint Query Parameters

2.3.35 "getTeacher" Endpoint Query Parameters

2.3.36 "getTeachersForClass" Endpoint Query Parameters

2.3.37 "getTeachersForClassInSchool" Endpoint Query Parameters

2.3.38 "getTeachersForSchool" Endpoint Query Parameters

2.3.39 "getTerm" Endpoint Query Parameters

2.3.40 "getTermsForSchool" Endpoint Query Parameters

2.3.41 "getUser" Endpoint Query Parameters

2.4 HTTP Code Handling

2.5 Service Discovery

3. Using the Endpoint Parameters

3.1 Pagination

3.2 Sorting

3.3 Filtering

3.4 Field Selection

4. Security Framework

4.1 Transport Security

4.2 Authorization

4.3 Scopes

4.3.1 "http://purl.imsglobal.org/spec/or/v1p2/scope/roster-core.readonly" Scope

4.3.2 "http://purl.imsglobal.org/spec/or/v1p2/scope/roster-demographics.readonly" Scope

4.3.3 "http://purl.imsglobal.org/spec/or/v1p2/scope/roster.readonly" Scope

5. UML to JSON Payload Mapping

5.1 Service Parameter Payload Properties UML/JSON Mapping

5.2 Service Parameter Payload Class UML/JSON Mapping

5.2.1 OrgSet Service Parameter Payload Class Mapping

5.2.2 SingleOrg Service Parameter Payload Class Mapping

5.2.3 CourseSet Service Parameter Payload Class Mapping

5.2.4 SingleCourse Service Parameter Payload Class Mapping

5.2.5 ClassSet Service Parameter Payload Class Mapping

5.2.6 SingleClass Service Parameter Payload Class Mapping

5.2.7 UserSet Service Parameter Payload Class Mapping

5.2.8 EnrollmentSet Service Parameter Payload Class Mapping

5.2.9 SingleEnrollment Service Parameter Payload Class Mapping

5.2.10 DemographicsSet Service Parameter Payload Class Mapping

5.2.11 SingleDemographics Service Parameter Payload Class Mapping

5.2.12 AcademicSessionSet Service Parameter Payload Class Mapping

5.2.13 SingleAcademicSession Service Parameter Payload Class Mapping

5.2.14 SingleUser Service Parameter Payload Class Mapping

5.3 Payload Classes UML/JSON Mapping

5.3.1 AcadSessionGUIDRef Payload Class Mapping

5.3.2 AcademicSession Payload Class Mapping

5.3.3 Base Payload Class Mapping

5.3.4 Class Payload Class Mapping

5.3.5 ClassGUIDRef Payload Class Mapping

5.3.6 Course Payload Class Mapping

5.3.7 CourseGUIDRef Payload Class Mapping

5.3.8 Credential Payload Class Mapping

5.3.9 Demographics Payload Class Mapping

5.3.10 Enrollment Payload Class Mapping

5.3.11 GUIDRef Payload Class Mapping

5.3.12 Metadata Payload Class Mapping

5.3.13 Org Payload Class Mapping

5.3.14 OrgGUIDRef Payload Class Mapping

5.3.15 ResourceGUIDRef Payload Class Mapping

5.3.16 Role Payload Class Mapping

5.3.17 User Payload Class Mapping

5.3.18 UserGUIDRef Payload Class Mapping

5.3.19 UserId Payload Class Mapping

5.3.20 UserProfile Payload Class Mapping

5.3.21 imsx_CodeMinor Payload Class Mapping

5.3.22 imsx_CodeMinorField Payload Class Mapping

5.3.23 imsx_StatusInfo Payload Class Mapping

5.4 Enumerated Class UML/JSON Mapping

5.5 Enumerated List Class UML/JSON Mapping

5.6 Primitive Type UML/JSON Mapping

6. JSON Payloads

6.1 "getAcademicSession" Request Payload

6.2 "getAcademicSession" Response Payload

6.2.1 Response Payloads for the HTTP Codes (default, 400, 401, 403, 404, 422, 429, 500)

6.2.2 Response Payloads for the HTTP Codes (200)

6.3 "getAllAcademicSessions" Request Payload

6.4 "getAllAcademicSessions" Response Payload

6.4.1 Response Payloads for the HTTP Codes (default, 400, 401, 403, 422, 429, 500)

6.4.2 Response Payloads for the HTTP Codes (200)

6.5 "getAllClasses" Request Payload

6.6 "getAllClasses" Response Payload

6.6.1 Response Payloads for the HTTP Codes (default, 400, 401, 403, 422, 429, 500)

6.6.2 Response Payloads for the HTTP Codes (200)

6.7 "getAllCourses" Request Payload

6.8 "getAllCourses" Response Payload

6.8.1 Response Payloads for the HTTP Codes (default, 400, 401, 403, 429, 500, 422)

6.8.2 Response Payloads for the HTTP Codes (200)

6.9 "getAllDemographics" Request Payload

6.10 "getAllDemographics" Response Payload

6.10.1 Response Payloads for the HTTP Codes (default, 400, 401, 403, 422, 429, 500)

6.10.2 Response Payloads for the HTTP Codes (200)

6.11 "getAllEnrollments" Request Payload

6.12 "getAllEnrollments" Response Payload

6.12.1 Response Payloads for the HTTP Codes (default, 400, 401, 403, 422, 429, 500)

6.12.2 Response Payloads for the HTTP Codes (200)

6.13 "getAllGradingPeriods" Request Payload

6.14 "getAllGradingPeriods" Response Payload

6.14.1 Response Payloads for the HTTP Codes (default, 400, 401, 403, 422, 429, 500)

6.14.2 Response Payloads for the HTTP Codes (200)

6.15 "getAllOrgs" Request Payload

6.16 "getAllOrgs" Response Payload

6.16.1 Response Payloads for the HTTP Codes (default, 400, 401, 403, 422, 429, 500)

6.16.2 Response Payloads for the HTTP Codes (200)

6.17 "getAllSchools" Request Payload

6.18 "getAllSchools" Response Payload

6.18.1 Response Payloads for the HTTP Codes (default, 400, 401, 403, 422, 429, 500)

6.18.2 Response Payloads for the HTTP Codes (200)

6.19 "getAllStudents" Request Payload

6.20 "getAllStudents" Response Payload

6.20.1 Response Payloads for the HTTP Codes (default, 400, 401, 403, 422, 429, 500)

6.20.2 Response Payloads for the HTTP Codes (200)

6.21 "getAllTeachers" Request Payload

6.22 "getAllTeachers" Response Payload

6.22.1 Response Payloads for the HTTP Codes (default, 400, 401, 403, 422, 429, 500)

6.22.2 Response Payloads for the HTTP Codes (200)

6.23 "getAllTerms" Request Payload

6.24 "getAllTerms" Response Payload

6.24.1 Response Payloads for the HTTP Codes (default, 400, 401, 403, 422, 429, 500)

6.24.2 Response Payloads for the HTTP Codes (200)

6.25 "getAllUsers" Request Payload

6.26 "getAllUsers" Response Payload

6.26.1 Response Payloads for the HTTP Codes (default, 400, 401, 403, 422, 429, 500)

6.26.2 Response Payloads for the HTTP Codes (200)

6.27 "getClass" Request Payload

6.28 "getClass" Response Payload

6.28.1 Response Payloads for the HTTP Codes (default, 400, 401, 403, 404, 422, 429, 500)

6.28.2 Response Payloads for the HTTP Codes (200)

6.29 "getClassesForCourse" Request Payload

6.30 "getClassesForCourse" Response Payload

6.30.1 Response Payloads for the HTTP Codes (default, 400, 401, 403, 422, 429, 500)

6.30.2 Response Payloads for the HTTP Codes (200)

6.31 "getClassesForSchool" Request Payload

6.32 "getClassesForSchool" Response Payload

6.32.1 Response Payloads for the HTTP Codes (default, 400, 401, 403, 422, 429, 500)

6.32.2 Response Payloads for the HTTP Codes (200)

6.33 "getClassesForStudent" Request Payload

6.34 "getClassesForStudent" Response Payload

6.34.1 Response Payloads for the HTTP Codes (default, 400, 401, 403, 422, 429, 500)

6.34.2 Response Payloads for the HTTP Codes (200)

6.35 "getClassesForTeacher" Request Payload

6.36 "getClassesForTeacher" Response Payload

6.36.1 Response Payloads for the HTTP Codes (default, 400, 401, 403, 422, 429, 500)

6.36.2 Response Payloads for the HTTP Codes (200)

6.37 "getClassesForTerm" Request Payload

6.38 "getClassesForTerm" Response Payload

6.38.1 Response Payloads for the HTTP Codes (default, 400, 401, 403, 422, 429, 500)

6.38.2 Response Payloads for the HTTP Codes (200)

6.39 "getClassesForUser" Request Payload

6.40 "getClassesForUser" Response Payload

6.40.1 Response Payloads for the HTTP Codes (default, 400, 401, 403, 422, 429, 500)

6.40.2 Response Payloads for the HTTP Codes (200)

6.41 "getCourse" Request Payload

6.42 "getCourse" Response Payload

6.42.1 Response Payloads for the HTTP Codes (default, 400, 401, 403, 429, 500, 404, 422)

6.42.2 Response Payloads for the HTTP Codes (200)

6.43 "getCoursesForSchool" Request Payload

6.44 "getCoursesForSchool" Response Payload

6.44.1 Response Payloads for the HTTP Codes (default, 400, 401, 403, 422, 429, 500)

6.44.2 Response Payloads for the HTTP Codes (200)

6.45 "getDemographics" Request Payload

6.46 "getDemographics" Response Payload

6.46.1 Response Payloads for the HTTP Codes (default, 400, 401, 403, 404, 422, 429, 500)

6.46.2 Response Payloads for the HTTP Codes (200)

6.47 "getEnrollment" Request Payload

6.48 "getEnrollment" Response Payload

6.48.1 Response Payloads for the HTTP Codes (default, 400, 401, 403, 404, 422, 429, 500)

6.48.2 Response Payloads for the HTTP Codes (200)

6.49 "getEnrollmentsForClassInSchool" Request Payload

6.50 "getEnrollmentsForClassInSchool" Response Payload

6.50.1 Response Payloads for the HTTP Codes (default, 400, 401, 403, 422, 429, 500)

6.50.2 Response Payloads for the HTTP Codes (200)

6.51 "getEnrollmentsForSchool" Request Payload

6.52 "getEnrollmentsForSchool" Response Payload

6.52.1 Response Payloads for the HTTP Codes (default, 400, 401, 403, 422, 429, 500)

6.52.2 Response Payloads for the HTTP Codes (200)

6.53 "getGradingPeriod" Request Payload

6.54 "getGradingPeriod" Response Payload

6.54.1 Response Payloads for the HTTP Codes (default, 400, 401, 403, 404, 422, 429, 500)

6.54.2 Response Payloads for the HTTP Codes (200)

6.55 "getGradingPeriodsForTerm" Request Payload

6.56 "getGradingPeriodsForTerm" Response Payload

6.56.1 Response Payloads for the HTTP Codes (default, 400, 401, 403, 422, 429, 500)

6.56.2 Response Payloads for the HTTP Codes (200)

6.57 "getOrg" Request Payload

6.58 "getOrg" Response Payload

6.58.1 Response Payloads for the HTTP Codes (default, 400, 401, 403, 404, 422, 429, 500)

6.58.2 Response Payloads for the HTTP Codes (200)

6.59 "getSchool" Request Payload

6.60 "getSchool" Response Payload

6.60.1 Response Payloads for the HTTP Codes (default, 400, 401, 403, 404, 422, 429, 500)

6.60.2 Response Payloads for the HTTP Codes (200)

6.61 "getStudent" Request Payload

6.62 "getStudent" Response Payload

6.62.1 Response Payloads for the HTTP Codes (default, 400, 401, 403, 404, 429, 422, 500)

6.62.2 Response Payloads for the HTTP Codes (200)

6.63 "getStudentsForClass" Request Payload

6.64 "getStudentsForClass" Response Payload

6.64.1 Response Payloads for the HTTP Codes (default, 400, 401, 403, 422, 429, 500)

6.64.2 Response Payloads for the HTTP Codes (200)

6.65 "getStudentsForClassInSchool" Request Payload

6.66 "getStudentsForClassInSchool" Response Payload

6.66.1 Response Payloads for the HTTP Codes (default, 400, 401, 403, 422, 429, 500)

6.66.2 Response Payloads for the HTTP Codes (200)

6.67 "getStudentsForSchool" Request Payload

6.68 "getStudentsForSchool" Response Payload

6.68.1 Response Payloads for the HTTP Codes (default, 400, 401, 403, 422, 429, 500)

6.68.2 Response Payloads for the HTTP Codes (200)

6.69 "getTeacher" Request Payload

6.70 "getTeacher" Response Payload

6.70.1 Response Payloads for the HTTP Codes (default, 400, 401, 403, 404, 429, 422, 500)

6.70.2 Response Payloads for the HTTP Codes (200)

6.71 "getTeachersForClass" Request Payload

6.72 "getTeachersForClass" Response Payload

6.72.1 Response Payloads for the HTTP Codes (default, 400, 401, 403, 422, 429, 500)

6.72.2 Response Payloads for the HTTP Codes (200)

6.73 "getTeachersForClassInSchool" Request Payload

6.74 "getTeachersForClassInSchool" Response Payload

6.74.1 Response Payloads for the HTTP Codes (default, 400, 401, 403, 422, 429, 500)

6.74.2 Response Payloads for the HTTP Codes (200)

6.75 "getTeachersForSchool" Request Payload

6.76 "getTeachersForSchool" Response Payload

6.76.1 Response Payloads for the HTTP Codes (default, 400, 401, 403, 422, 429, 500)

6.76.2 Response Payloads for the HTTP Codes (200)

6.77 "getTerm" Request Payload

6.78 "getTerm" Response Payload

6.78.1 Response Payloads for the HTTP Codes (default, 400, 401, 403, 404, 422, 429, 500)

6.78.2 Response Payloads for the HTTP Codes (200)

6.79 "getTermsForSchool" Request Payload

6.80 "getTermsForSchool" Response Payload

6.80.1 Response Payloads for the HTTP Codes (default, 400, 401, 403, 422, 429, 500)

6.80.2 Response Payloads for the HTTP Codes (200)

6.81 "getUser" Request Payload

6.82 "getUser" Response Payload

6.82.1 Response Payloads for the HTTP Codes (default, 400, 401, 403, 404, 429, 422, 500)

6.82.2 Response Payloads for the HTTP Codes (200)

7. OpenAPI Description

7.1 General Information

7.2 Tags Information

7.3 Security Information

7.4 Paths Information

7.4.1 "/academicSessions" Path

7.4.2 "/academicSessions/{sourcedId}" Path

7.4.3 "/classes" Path

7.4.4 "/classes/{classSourcedId}/students" Path

7.4.5 "/classes/{classSourcedId}/teachers" Path

7.4.6 "/classes/{sourcedId}" Path

7.4.7 "/courses" Path

7.4.8 "/courses/{courseSourcedId}/classes" Path

7.4.9 "/courses/{sourcedId}" Path

7.4.10 "/demographics" Path

7.4.11 "/demographics/{sourcedId}" Path

7.4.12 "/enrollments" Path

7.4.13 "/enrollments/{sourcedId}" Path

7.4.14 "/gradingPeriods" Path

7.4.15 "/gradingPeriods/{sourcedId}" Path

7.4.16 "/orgs" Path

7.4.17 "/orgs/{sourcedId}" Path

7.4.18 "/schools" Path

7.4.19 "/schools/{schoolSourcedId}/classes" Path

7.4.20 "/schools/{schoolSourcedId}/classes/{classSourcedId}/enrollments" Path

7.4.21 "/schools/{schoolSourcedId}/classes/{classSourcedId}/students" Path

7.4.22 "/schools/{schoolSourcedId}/classes/{classSourcedId}/teachers" Path

7.4.23 "/schools/{schoolSourcedId}/courses" Path

7.4.24 "/schools/{schoolSourcedId}/enrollments" Path

7.4.25 "/schools/{schoolSourcedId}/students" Path

7.4.26 "/schools/{schoolSourcedId}/teachers" Path

7.4.27 "/schools/{schoolSourcedId}/terms" Path

7.4.28 "/schools/{sourcedId}" Path

7.4.29 "/students" Path

7.4.30 "/students/{sourcedId}" Path

7.4.31 "/students/{studentSourcedId}/classes" Path

7.4.32 "/teachers" Path

7.4.33 "/teachers/{sourcedId}" Path

7.4.34 "/teachers/{teacherSourcedId}/classes" Path

7.4.35 "/terms" Path

7.4.36 "/terms/{sourcedId}" Path

7.4.37 "/terms/{termSourcedId}/classes" Path

7.4.38 "/terms/{termSourcedId}/gradingPeriods" Path

7.4.39 "/users" Path

7.4.40 "/users/{sourcedId}" Path

7.4.41 "/users/{userSourcedId}/classes" Path

7.5 Definitions Information

7.5.1 "AcadSessionGUIDRefDType" Definition

7.5.2 "AcademicSessionDType" Definition

7.5.3 "AcademicSessionSetDType" Definition

7.5.4 "ClassDType" Definition

7.5.5 "ClassGUIDRefDType" Definition

7.5.6 "ClassSetDType" Definition

7.5.7 "CourseDType" Definition

7.5.8 "CourseGUIDRefDType" Definition

7.5.9 "CourseSetDType" Definition

7.5.10 "CredentialDType" Definition

7.5.11 "DemographicsDType" Definition

7.5.12 "DemographicsSetDType" Definition

7.5.13 "EnrollmentDType" Definition

7.5.14 "EnrollmentSetDType" Definition

7.5.15 "MetadataDType" Definition

7.5.16 "OrgDType" Definition

7.5.17 "OrgGUIDRefDType" Definition

7.5.18 "OrgSetDType" Definition

7.5.19 "ResourceGUIDRefDType" Definition

7.5.20 "RoleDType" Definition

7.5.21 "SingleAcademicSessionDType" Definition

7.5.22 "SingleClassDType" Definition

7.5.23 "SingleCourseDType" Definition

7.5.24 "SingleDemographicsDType" Definition

7.5.25 "SingleEnrollmentDType" Definition

7.5.26 "SingleOrgDType" Definition

7.5.27 "SingleUserDType" Definition

7.5.28 "UserDType" Definition

7.5.29 "UserGUIDRefDType" Definition

7.5.30 "UserIdDType" Definition

7.5.31 "UserProfileDType" Definition

7.5.32 "UserSetDType" Definition

7.5.33 "imsx_CodeMinorDType" Definition

7.5.34 "imsx_CodeMinorFieldDType" Definition

7.5.35 "imsx_StatusInfoDType" Definition

8. Extending and Profiling the Binding

8.1 Extending the Binding

8.1.1 Proprietary Operations

8.1.2 Proprietary Scopes

8.1.3 Proprietary Data Elements

8.1.4 Proprietary Vocabulary Terms

8.2 Profiling the Binding

References

Appendix A Model Binding Terms and Concepts

A1 REST Endpoint Description Explanations

A1.1 REST Endpoint Mapping Table Explanation

A1.2 Query Parameter Table Explanation

A1.3 Error Codes and Handling for each Endpoint Table Explanation

A2 UML to JSON Mapping Description Explanations

A2.1 Service Parameter Payload Properties UML/JSON Mapping Table Definition

A2.2 UML/JSON Payload Class Mapping Table Definition

A2.3 UML/JSON Enumerated and Enumerated List Class Mapping Table Definition

A2.4 UML/JSON Primitive Types Mapping Table Definition

A3 OpenAPI (v2) Descriptions Explanations

A3.1a OpenAPI(2) General Information Table Explanation

A3.1b OpenAPI(3) General Information Table Explanation

A3.2 OpenAPI Tags Table Explanation

A3.3 OpenAPI Security Table Explanation

A3.4 OpenAPI Paths Table Explanation

A3.5 OpenAPI Definitions Table Explanation

Appendix B OpenAPI Listings

B1 Listing of the OpenAPI (JSON) File

B1.1 OpenAPI 2.0 JSON Listing

B1.2 OpenAPI 3.0 JSON Listing

B2 Listing of the OpenAPI (YAML) File

B2.1 OpenAPI 2.0 YAML Listing

B2.2 OpenAPI 3.0 YAML Listing

Appendix C JSON Schema Listings

C1 JSON Schemas for Payload Validation

C1.1a JSON Schema for the "getAcademicSession" Operation Request Payload Validation.

C1.1b JSON Schema for the "getAcademicSession" Operation Response Payload Validation for HTTP Codes (default,400,401,403,404,422,429,500)

C1.1c JSON Schema for the "getAcademicSession" Operation Response Payload Validation for HTTP Codes (200)

C1.2a JSON Schema for the "getAllAcademicSessions" Operation Request Payload Validation.

C1.2b JSON Schema for the "getAllAcademicSessions" Operation Response Payload Validation for HTTP Codes (default,400,401,403,422,429,500)

C1.2c JSON Schema for the "getAllAcademicSessions" Operation Response Payload Validation for HTTP Codes (200)

C1.3a JSON Schema for the "getAllClasses" Operation Request Payload Validation.

C1.3b JSON Schema for the "getAllClasses" Operation Response Payload Validation for HTTP Codes (default,400,401,403,422,429,500)

C1.3c JSON Schema for the "getAllClasses" Operation Response Payload Validation for HTTP Codes (200)

C1.4a JSON Schema for the "getAllCourses" Operation Request Payload Validation.

C1.4b JSON Schema for the "getAllCourses" Operation Response Payload Validation for HTTP Codes (default,400,401,403,429,500,422)

C1.4c JSON Schema for the "getAllCourses" Operation Response Payload Validation for HTTP Codes (200)

C1.5a JSON Schema for the "getAllDemographics" Operation Request Payload Validation.

C1.5b JSON Schema for the "getAllDemographics" Operation Response Payload Validation for HTTP Codes (default,400,401,403,422,429,500)

C1.5c JSON Schema for the "getAllDemographics" Operation Response Payload Validation for HTTP Codes (200)

C1.6a JSON Schema for the "getAllEnrollments" Operation Request Payload Validation.

C1.6b JSON Schema for the "getAllEnrollments" Operation Response Payload Validation for HTTP Codes (default,400,401,403,422,429,500)

C1.6c JSON Schema for the "getAllEnrollments" Operation Response Payload Validation for HTTP Codes (200)

C1.7a JSON Schema for the "getAllGradingPeriods" Operation Request Payload Validation.

C1.7b JSON Schema for the "getAllGradingPeriods" Operation Response Payload Validation for HTTP Codes (default,400,401,403,422,429,500)

C1.7c JSON Schema for the "getAllGradingPeriods" Operation Response Payload Validation for HTTP Codes (200)

C1.8a JSON Schema for the "getAllOrgs" Operation Request Payload Validation.

C1.8b JSON Schema for the "getAllOrgs" Operation Response Payload Validation for HTTP Codes (default,400,401,403,422,429,500)

C1.8c JSON Schema for the "getAllOrgs" Operation Response Payload Validation for HTTP Codes (200)

C1.9a JSON Schema for the "getAllSchools" Operation Request Payload Validation.

C1.9b JSON Schema for the "getAllSchools" Operation Response Payload Validation for HTTP Codes (default,400,401,403,422,429,500)

C1.9c JSON Schema for the "getAllSchools" Operation Response Payload Validation for HTTP Codes (200)

C1.10a JSON Schema for the "getAllStudents" Operation Request Payload Validation.

C1.10b JSON Schema for the "getAllStudents" Operation Response Payload Validation for HTTP Codes (default,400,401,403,422,429,500)

C1.10c JSON Schema for the "getAllStudents" Operation Response Payload Validation for HTTP Codes (200)

C1.11a JSON Schema for the "getAllTeachers" Operation Request Payload Validation.

C1.11b JSON Schema for the "getAllTeachers" Operation Response Payload Validation for HTTP Codes (default,400,401,403,422,429,500)

C1.11c JSON Schema for the "getAllTeachers" Operation Response Payload Validation for HTTP Codes (200)

C1.12a JSON Schema for the "getAllTerms" Operation Request Payload Validation.

C1.12b JSON Schema for the "getAllTerms" Operation Response Payload Validation for HTTP Codes (default,400,401,403,422,429,500)

C1.12c JSON Schema for the "getAllTerms" Operation Response Payload Validation for HTTP Codes (200)

C1.13a JSON Schema for the "getAllUsers" Operation Request Payload Validation.

C1.13b JSON Schema for the "getAllUsers" Operation Response Payload Validation for HTTP Codes (default,400,401,403,422,429,500)

C1.13c JSON Schema for the "getAllUsers" Operation Response Payload Validation for HTTP Codes (200)

C1.14a JSON Schema for the "getClass" Operation Request Payload Validation.

C1.14b JSON Schema for the "getClass" Operation Response Payload Validation for HTTP Codes (default,400,401,403,404,422,429,500)

C1.14c JSON Schema for the "getClass" Operation Response Payload Validation for HTTP Codes (200)

C1.15a JSON Schema for the "getClassesForCourse" Operation Request Payload Validation.

C1.15b JSON Schema for the "getClassesForCourse" Operation Response Payload Validation for HTTP Codes (default,400,401,403,422,429,500)

C1.15c JSON Schema for the "getClassesForCourse" Operation Response Payload Validation for HTTP Codes (200)

C1.16a JSON Schema for the "getClassesForSchool" Operation Request Payload Validation.

C1.16b JSON Schema for the "getClassesForSchool" Operation Response Payload Validation for HTTP Codes (default,400,401,403,422,429,500)

C1.16c JSON Schema for the "getClassesForSchool" Operation Response Payload Validation for HTTP Codes (200)

C1.17a JSON Schema for the "getClassesForStudent" Operation Request Payload Validation.

C1.17b JSON Schema for the "getClassesForStudent" Operation Response Payload Validation for HTTP Codes (default,400,401,403,422,429,500)

C1.17c JSON Schema for the "getClassesForStudent" Operation Response Payload Validation for HTTP Codes (200)

C1.18a JSON Schema for the "getClassesForTeacher" Operation Request Payload Validation.

C1.18b JSON Schema for the "getClassesForTeacher" Operation Response Payload Validation for HTTP Codes (default,400,401,403,422,429,500)

C1.18c JSON Schema for the "getClassesForTeacher" Operation Response Payload Validation for HTTP Codes (200)

C1.19a JSON Schema for the "getClassesForTerm" Operation Request Payload Validation.

C1.19b JSON Schema for the "getClassesForTerm" Operation Response Payload Validation for HTTP Codes (default,400,401,403,422,429,500)

C1.19c JSON Schema for the "getClassesForTerm" Operation Response Payload Validation for HTTP Codes (200)

C1.20a JSON Schema for the "getClassesForUser" Operation Request Payload Validation.

C1.20b JSON Schema for the "getClassesForUser" Operation Response Payload Validation for HTTP Codes (default,400,401,403,422,429,500)

C1.20c JSON Schema for the "getClassesForUser" Operation Response Payload Validation for HTTP Codes (200)

C1.21a JSON Schema for the "getCourse" Operation Request Payload Validation.

C1.21b JSON Schema for the "getCourse" Operation Response Payload Validation for HTTP Codes (default,400,401,403,429,500,404,422)

C1.21c JSON Schema for the "getCourse" Operation Response Payload Validation for HTTP Codes (200)

C1.22a JSON Schema for the "getCoursesForSchool" Operation Request Payload Validation.

C1.22b JSON Schema for the "getCoursesForSchool" Operation Response Payload Validation for HTTP Codes (default,400,401,403,422,429,500)

C1.22c JSON Schema for the "getCoursesForSchool" Operation Response Payload Validation for HTTP Codes (200)

C1.23a JSON Schema for the "getDemographics" Operation Request Payload Validation.

C1.23b JSON Schema for the "getDemographics" Operation Response Payload Validation for HTTP Codes (default,400,401,403,404,422,429,500)

C1.23c JSON Schema for the "getDemographics" Operation Response Payload Validation for HTTP Codes (200)

C1.24a JSON Schema for the "getEnrollment" Operation Request Payload Validation.

C1.24b JSON Schema for the "getEnrollment" Operation Response Payload Validation for HTTP Codes (default,400,401,403,404,422,429,500)

C1.24c JSON Schema for the "getEnrollment" Operation Response Payload Validation for HTTP Codes (200)

C1.25a JSON Schema for the "getEnrollmentsForClassInSchool" Operation Request Payload Validation.

C1.25b JSON Schema for the "getEnrollmentsForClassInSchool" Operation Response Payload Validation for HTTP Codes (default,400,401,403,422,429,500)

C1.25c JSON Schema for the "getEnrollmentsForClassInSchool" Operation Response Payload Validation for HTTP Codes (200)

C1.26a JSON Schema for the "getEnrollmentsForSchool" Operation Request Payload Validation.

C1.26b JSON Schema for the "getEnrollmentsForSchool" Operation Response Payload Validation for HTTP Codes (default,400,401,403,422,429,500)

C1.26c JSON Schema for the "getEnrollmentsForSchool" Operation Response Payload Validation for HTTP Codes (200)

C1.27a JSON Schema for the "getGradingPeriod" Operation Request Payload Validation.

C1.27b JSON Schema for the "getGradingPeriod" Operation Response Payload Validation for HTTP Codes (default,400,401,403,404,422,429,500)

C1.27c JSON Schema for the "getGradingPeriod" Operation Response Payload Validation for HTTP Codes (200)

C1.28a JSON Schema for the "getGradingPeriodsForTerm" Operation Request Payload Validation.

C1.28b JSON Schema for the "getGradingPeriodsForTerm" Operation Response Payload Validation for HTTP Codes (default,400,401,403,422,429,500)

C1.28c JSON Schema for the "getGradingPeriodsForTerm" Operation Response Payload Validation for HTTP Codes (200)

C1.29a JSON Schema for the "getOrg" Operation Request Payload Validation.

C1.29b JSON Schema for the "getOrg" Operation Response Payload Validation for HTTP Codes (default,400,401,403,404,422,429,500)

C1.29c JSON Schema for the "getOrg" Operation Response Payload Validation for HTTP Codes (200)

C1.30a JSON Schema for the "getSchool" Operation Request Payload Validation.

C1.30b JSON Schema for the "getSchool" Operation Response Payload Validation for HTTP Codes (default,400,401,403,404,422,429,500)

C1.30c JSON Schema for the "getSchool" Operation Response Payload Validation for HTTP Codes (200)

C1.31a JSON Schema for the "getStudent" Operation Request Payload Validation.

C1.31b JSON Schema for the "getStudent" Operation Response Payload Validation for HTTP Codes (default,400,401,403,404,429,422,500)

C1.31c JSON Schema for the "getStudent" Operation Response Payload Validation for HTTP Codes (200)

C1.32a JSON Schema for the "getStudentsForClass" Operation Request Payload Validation.

C1.32b JSON Schema for the "getStudentsForClass" Operation Response Payload Validation for HTTP Codes (default,400,401,403,422,429,500)

C1.32c JSON Schema for the "getStudentsForClass" Operation Response Payload Validation for HTTP Codes (200)

C1.33a JSON Schema for the "getStudentsForClassInSchool" Operation Request Payload Validation.

C1.33b JSON Schema for the "getStudentsForClassInSchool" Operation Response Payload Validation for HTTP Codes (default,400,401,403,422,429,500)

C1.33c JSON Schema for the "getStudentsForClassInSchool" Operation Response Payload Validation for HTTP Codes (200)

C1.34a JSON Schema for the "getStudentsForSchool" Operation Request Payload Validation.

C1.34b JSON Schema for the "getStudentsForSchool" Operation Response Payload Validation for HTTP Codes (default,400,401,403,422,429,500)

C1.34c JSON Schema for the "getStudentsForSchool" Operation Response Payload Validation for HTTP Codes (200)

C1.35a JSON Schema for the "getTeacher" Operation Request Payload Validation.

C1.35b JSON Schema for the "getTeacher" Operation Response Payload Validation for HTTP Codes (default,400,401,403,404,429,422,500)

C1.35c JSON Schema for the "getTeacher" Operation Response Payload Validation for HTTP Codes (200)

C1.36a JSON Schema for the "getTeachersForClass" Operation Request Payload Validation.

C1.36b JSON Schema for the "getTeachersForClass" Operation Response Payload Validation for HTTP Codes (default,400,401,403,422,429,500)

C1.36c JSON Schema for the "getTeachersForClass" Operation Response Payload Validation for HTTP Codes (200)

C1.37a JSON Schema for the "getTeachersForClassInSchool" Operation Request Payload Validation.

C1.37b JSON Schema for the "getTeachersForClassInSchool" Operation Response Payload Validation for HTTP Codes (default,400,401,403,422,429,500)

C1.37c JSON Schema for the "getTeachersForClassInSchool" Operation Response Payload Validation for HTTP Codes (200)

C1.38a JSON Schema for the "getTeachersForSchool" Operation Request Payload Validation.

C1.38b JSON Schema for the "getTeachersForSchool" Operation Response Payload Validation for HTTP Codes (default,400,401,403,422,429,500)

C1.38c JSON Schema for the "getTeachersForSchool" Operation Response Payload Validation for HTTP Codes (200)

C1.39a JSON Schema for the "getTerm" Operation Request Payload Validation.

C1.39b JSON Schema for the "getTerm" Operation Response Payload Validation for HTTP Codes (default,400,401,403,404,422,429,500)

C1.39c JSON Schema for the "getTerm" Operation Response Payload Validation for HTTP Codes (200)

C1.40a JSON Schema for the "getTermsForSchool" Operation Request Payload Validation.

C1.40b JSON Schema for the "getTermsForSchool" Operation Response Payload Validation for HTTP Codes (default,400,401,403,422,429,500)

C1.40c JSON Schema for the "getTermsForSchool" Operation Response Payload Validation for HTTP Codes (200)

C1.41a JSON Schema for the "getUser" Operation Request Payload Validation.

C1.41b JSON Schema for the "getUser" Operation Response Payload Validation for HTTP Codes (default,400,401,403,404,429,422,500)

C1.41c JSON Schema for the "getUser" Operation Response Payload Validation for HTTP Codes (200)

About this Document

List of Contributors

Revision History

toc | top

List of Tables

Table 2.1 - The Set of REST Endpoint URL-leaf Values.

Table 2.4 - The List of HTTP Codes and Handling for each Endpoint.

Table 4.3.1 "http://purl.imsglobal.org/spec/or/v1p2/scope/roster-core.readonly" Scope

Table 4.3.2 "http://purl.imsglobal.org/spec/or/v1p2/scope/roster-demographics.readonly" Scope

Table 4.3.3 "http://purl.imsglobal.org/spec/or/v1p2/scope/roster.readonly" Scope

Table 7.1a - The Set of General Information Defined in the OpenAPI(2) Description.

Table 7.1b - The Set of General Information Defined in the OpenAPI(3) Description.

Table 7.2 - The Set of Tags Defined in the OpenAPI Description.

Table 7.3.1 - The Set of OAuth 2.0 Client Credentials Security Information Defined in the OpenAPI Description.

Table 7.4.1 - The Set of HTTP Verbs Permitted on the "/academicSessions" Path.

Table 7.4.2 - The Set of HTTP Verbs Permitted on the "/academicSessions/{sourcedId}" Path.

Table 7.4.3 - The Set of HTTP Verbs Permitted on the "/classes" Path.

Table 7.4.4 - The Set of HTTP Verbs Permitted on the "/classes/{classSourcedId}/students" Path.

Table 7.4.5 - The Set of HTTP Verbs Permitted on the "/classes/{classSourcedId}/teachers" Path.

Table 7.4.6 - The Set of HTTP Verbs Permitted on the "/classes/{sourcedId}" Path.

Table 7.4.7 - The Set of HTTP Verbs Permitted on the "/courses" Path.

Table 7.4.8 - The Set of HTTP Verbs Permitted on the "/courses/{courseSourcedId}/classes" Path.

Table 7.4.9 - The Set of HTTP Verbs Permitted on the "/courses/{sourcedId}" Path.

Table 7.4.10 - The Set of HTTP Verbs Permitted on the "/demographics" Path.

Table 7.4.11 - The Set of HTTP Verbs Permitted on the "/demographics/{sourcedId}" Path.

Table 7.4.12 - The Set of HTTP Verbs Permitted on the "/enrollments" Path.

Table 7.4.13 - The Set of HTTP Verbs Permitted on the "/enrollments/{sourcedId}" Path.

Table 7.4.14 - The Set of HTTP Verbs Permitted on the "/gradingPeriods" Path.

Table 7.4.15 - The Set of HTTP Verbs Permitted on the "/gradingPeriods/{sourcedId}" Path.

Table 7.4.16 - The Set of HTTP Verbs Permitted on the "/orgs" Path.

Table 7.4.17 - The Set of HTTP Verbs Permitted on the "/orgs/{sourcedId}" Path.

Table 7.4.18 - The Set of HTTP Verbs Permitted on the "/schools" Path.

Table 7.4.19 - The Set of HTTP Verbs Permitted on the "/schools/{schoolSourcedId}/classes" Path.

Table 7.4.20 - The Set of HTTP Verbs Permitted on the "/schools/{schoolSourcedId}/classes/{classSourcedId}/enrollments" Path.

Table 7.4.21 - The Set of HTTP Verbs Permitted on the "/schools/{schoolSourcedId}/classes/{classSourcedId}/students" Path.

Table 7.4.22 - The Set of HTTP Verbs Permitted on the "/schools/{schoolSourcedId}/classes/{classSourcedId}/teachers" Path.

Table 7.4.23 - The Set of HTTP Verbs Permitted on the "/schools/{schoolSourcedId}/courses" Path.

Table 7.4.24 - The Set of HTTP Verbs Permitted on the "/schools/{schoolSourcedId}/enrollments" Path.

Table 7.4.25 - The Set of HTTP Verbs Permitted on the "/schools/{schoolSourcedId}/students" Path.

Table 7.4.26 - The Set of HTTP Verbs Permitted on the "/schools/{schoolSourcedId}/teachers" Path.

Table 7.4.27 - The Set of HTTP Verbs Permitted on the "/schools/{schoolSourcedId}/terms" Path.

Table 7.4.28 - The Set of HTTP Verbs Permitted on the "/schools/{sourcedId}" Path.

Table 7.4.29 - The Set of HTTP Verbs Permitted on the "/students" Path.

Table 7.4.30 - The Set of HTTP Verbs Permitted on the "/students/{sourcedId}" Path.

Table 7.4.31 - The Set of HTTP Verbs Permitted on the "/students/{studentSourcedId}/classes" Path.

Table 7.4.32 - The Set of HTTP Verbs Permitted on the "/teachers" Path.

Table 7.4.33 - The Set of HTTP Verbs Permitted on the "/teachers/{sourcedId}" Path.

Table 7.4.34 - The Set of HTTP Verbs Permitted on the "/teachers/{teacherSourcedId}/classes" Path.

Table 7.4.35 - The Set of HTTP Verbs Permitted on the "/terms" Path.

Table 7.4.36 - The Set of HTTP Verbs Permitted on the "/terms/{sourcedId}" Path.

Table 7.4.37 - The Set of HTTP Verbs Permitted on the "/terms/{termSourcedId}/classes" Path.

Table 7.4.38 - The Set of HTTP Verbs Permitted on the "/terms/{termSourcedId}/gradingPeriods" Path.

Table 7.4.39 - The Set of HTTP Verbs Permitted on the "/users" Path.

Table 7.4.40 - The Set of HTTP Verbs Permitted on the "/users/{sourcedId}" Path.

Table 7.4.41 - The Set of HTTP Verbs Permitted on the "/users/{userSourcedId}/classes" Path.

Table 7.5.1 - OpenAPI JSON Schema description for the "AcadSessionGUIDRefDType" Complex Type.

Table 7.5.2 - OpenAPI JSON Schema description for the "AcademicSessionDType" Complex Type.

Table 7.5.3 - OpenAPI JSON Schema description for the "AcademicSessionSetDType" Complex Type.

Table 7.5.4 - OpenAPI JSON Schema description for the "BaseDType" Complex Type.

Table 7.5.5 - OpenAPI JSON Schema description for the "ClassDType" Complex Type.

Table 7.5.6 - OpenAPI JSON Schema description for the "ClassGUIDRefDType" Complex Type.

Table 7.5.7 - OpenAPI JSON Schema description for the "ClassSetDType" Complex Type.

Table 7.5.8 - OpenAPI JSON Schema description for the "CourseDType" Complex Type.

Table 7.5.9 - OpenAPI JSON Schema description for the "CourseGUIDRefDType" Complex Type.

Table 7.5.10 - OpenAPI JSON Schema description for the "CourseSetDType" Complex Type.

Table 7.5.11 - OpenAPI JSON Schema description for the "CredentialDType" Complex Type.

Table 7.5.12 - OpenAPI JSON Schema description for the "DemographicsDType" Complex Type.

Table 7.5.13 - OpenAPI JSON Schema description for the "DemographicsSetDType" Complex Type.

Table 7.5.14 - OpenAPI JSON Schema description for the "EnrollmentDType" Complex Type.

Table 7.5.15 - OpenAPI JSON Schema description for the "EnrollmentSetDType" Complex Type.

Table 7.5.16 - OpenAPI JSON Schema description for the "GUIDRefDType" Complex Type.

Table 7.5.17 - OpenAPI JSON Schema description for the "MetadataDType" Complex Type.

Table 7.5.18 - OpenAPI JSON Schema description for the "OrgDType" Complex Type.

Table 7.5.19 - OpenAPI JSON Schema description for the "OrgGUIDRefDType" Complex Type.

Table 7.5.20 - OpenAPI JSON Schema description for the "OrgSetDType" Complex Type.

Table 7.5.21 - OpenAPI JSON Schema description for the "ResourceGUIDRefDType" Complex Type.

Table 7.5.22 - OpenAPI JSON Schema description for the "RoleDType" Complex Type.

Table 7.5.23 - OpenAPI JSON Schema description for the "SingleAcademicSessionDType" Complex Type.

Table 7.5.24 - OpenAPI JSON Schema description for the "SingleClassDType" Complex Type.

Table 7.5.25 - OpenAPI JSON Schema description for the "SingleCourseDType" Complex Type.

Table 7.5.26 - OpenAPI JSON Schema description for the "SingleDemographicsDType" Complex Type.

Table 7.5.27 - OpenAPI JSON Schema description for the "SingleEnrollmentDType" Complex Type.

Table 7.5.28 - OpenAPI JSON Schema description for the "SingleOrgDType" Complex Type.

Table 7.5.29 - OpenAPI JSON Schema description for the "SingleUserDType" Complex Type.

Table 7.5.30 - OpenAPI JSON Schema description for the "UserDType" Complex Type.

Table 7.5.31 - OpenAPI JSON Schema description for the "UserGUIDRefDType" Complex Type.

Table 7.5.32 - OpenAPI JSON Schema description for the "UserIdDType" Complex Type.

Table 7.5.33 - OpenAPI JSON Schema description for the "UserProfileDType" Complex Type.

Table 7.5.34 - OpenAPI JSON Schema description for the "UserSetDType" Complex Type.

Table 7.5.35 - OpenAPI JSON Schema description for the "imsx_CodeMinorDType" Complex Type.

Table 7.5.36 - OpenAPI JSON Schema description for the "imsx_CodeMinorFieldDType" Complex Type.

Table 7.5.37 - OpenAPI JSON Schema description for the "imsx_StatusInfoDType" Complex Type.

Table A1.1 The key to the descriptions of the mapping between a service calls and its REST endpoint URL-leaf

Table A1.2 The key to the descriptions of the data attribute/characteristic tables

Table A1.3 The key to the descriptions of the list of error codes and handling for each endpoint

Table A3.1a The key to the tabular description of the OpenAPI(2) general information

Table A3.1b The key to the tabular description of the OpenAPI(3) general information

Table A3.2 The key to the tabular description of the OpenAPI tags information

Table A3.3 The key to the tabular description of the OpenAPI security information.

Table A3.4 The key to the tabular description of the OpenAPI paths information for an HTTP Verb

Table A3.5 The key to the tabular description of the OpenAPI definitions information

toc | top

List of Code Blocks

Code 6.2.1 - JSON payload example for "default, 400, 401, 403, 404, 422, 429, 500" response messages for a "getAcademicSession" operation.

Code 6.2.2 - JSON payload example for "200" response messages for a "getAcademicSession" operation.

Code 6.4.1 - JSON payload example for "default, 400, 401, 403, 422, 429, 500" response messages for a "getAllAcademicSessions" operation.

Code 6.4.2 - JSON payload example for "200" response messages for a "getAllAcademicSessions" operation.

Code 6.6.1 - JSON payload example for "default, 400, 401, 403, 422, 429, 500" response messages for a "getAllClasses" operation.

Code 6.6.2 - JSON payload example for "200" response messages for a "getAllClasses" operation.

Code 6.8.1 - JSON payload example for "default, 400, 401, 403, 429, 500, 422" response messages for a "getAllCourses" operation.

Code 6.8.2 - JSON payload example for "200" response messages for a "getAllCourses" operation.

Code 6.10.1 - JSON payload example for "default, 400, 401, 403, 422, 429, 500" response messages for a "getAllDemographics" operation.

Code 6.10.2 - JSON payload example for "200" response messages for a "getAllDemographics" operation.

Code 6.12.1 - JSON payload example for "default, 400, 401, 403, 422, 429, 500" response messages for a "getAllEnrollments" operation.

Code 6.12.2 - JSON payload example for "200" response messages for a "getAllEnrollments" operation.

Code 6.14.1 - JSON payload example for "default, 400, 401, 403, 422, 429, 500" response messages for a "getAllGradingPeriods" operation.

Code 6.14.2 - JSON payload example for "200" response messages for a "getAllGradingPeriods" operation.

Code 6.16.1 - JSON payload example for "default, 400, 401, 403, 422, 429, 500" response messages for a "getAllOrgs" operation.

Code 6.16.2 - JSON payload example for "200" response messages for a "getAllOrgs" operation.

Code 6.18.1 - JSON payload example for "default, 400, 401, 403, 422, 429, 500" response messages for a "getAllSchools" operation.

Code 6.18.2 - JSON payload example for "200" response messages for a "getAllSchools" operation.

Code 6.20.1 - JSON payload example for "default, 400, 401, 403, 422, 429, 500" response messages for a "getAllStudents" operation.

Code 6.20.2 - JSON payload example for "200" response messages for a "getAllStudents" operation.

Code 6.22.1 - JSON payload example for "default, 400, 401, 403, 422, 429, 500" response messages for a "getAllTeachers" operation.

Code 6.22.2 - JSON payload example for "200" response messages for a "getAllTeachers" operation.

Code 6.24.1 - JSON payload example for "default, 400, 401, 403, 422, 429, 500" response messages for a "getAllTerms" operation.

Code 6.24.2 - JSON payload example for "200" response messages for a "getAllTerms" operation.

Code 6.26.1 - JSON payload example for "default, 400, 401, 403, 422, 429, 500" response messages for a "getAllUsers" operation.

Code 6.26.2 - JSON payload example for "200" response messages for a "getAllUsers" operation.

Code 6.28.1 - JSON payload example for "default, 400, 401, 403, 404, 422, 429, 500" response messages for a "getClass" operation.

Code 6.28.2 - JSON payload example for "200" response messages for a "getClass" operation.

Code 6.30.1 - JSON payload example for "default, 400, 401, 403, 422, 429, 500" response messages for a "getClassesForCourse" operation.

Code 6.30.2 - JSON payload example for "200" response messages for a "getClassesForCourse" operation.

Code 6.32.1 - JSON payload example for "default, 400, 401, 403, 422, 429, 500" response messages for a "getClassesForSchool" operation.

Code 6.32.2 - JSON payload example for "200" response messages for a "getClassesForSchool" operation.

Code 6.34.1 - JSON payload example for "default, 400, 401, 403, 422, 429, 500" response messages for a "getClassesForStudent" operation.

Code 6.34.2 - JSON payload example for "200" response messages for a "getClassesForStudent" operation.

Code 6.36.1 - JSON payload example for "default, 400, 401, 403, 422, 429, 500" response messages for a "getClassesForTeacher" operation.

Code 6.36.2 - JSON payload example for "200" response messages for a "getClassesForTeacher" operation.

Code 6.38.1 - JSON payload example for "default, 400, 401, 403, 422, 429, 500" response messages for a "getClassesForTerm" operation.

Code 6.38.2 - JSON payload example for "200" response messages for a "getClassesForTerm" operation.

Code 6.40.1 - JSON payload example for "default, 400, 401, 403, 422, 429, 500" response messages for a "getClassesForUser" operation.

Code 6.40.2 - JSON payload example for "200" response messages for a "getClassesForUser" operation.

Code 6.42.1 - JSON payload example for "default, 400, 401, 403, 429, 500, 404, 422" response messages for a "getCourse" operation.

Code 6.42.2 - JSON payload example for "200" response messages for a "getCourse" operation.

Code 6.44.1 - JSON payload example for "default, 400, 401, 403, 422, 429, 500" response messages for a "getCoursesForSchool" operation.

Code 6.44.2 - JSON payload example for "200" response messages for a "getCoursesForSchool" operation.

Code 6.46.1 - JSON payload example for "default, 400, 401, 403, 404, 422, 429, 500" response messages for a "getDemographics" operation.

Code 6.46.2 - JSON payload example for "200" response messages for a "getDemographics" operation.

Code 6.48.1 - JSON payload example for "default, 400, 401, 403, 404, 422, 429, 500" response messages for a "getEnrollment" operation.

Code 6.48.2 - JSON payload example for "200" response messages for a "getEnrollment" operation.

Code 6.50.1 - JSON payload example for "default, 400, 401, 403, 422, 429, 500" response messages for a "getEnrollmentsForClassInSchool" operation.

Code 6.50.2 - JSON payload example for "200" response messages for a "getEnrollmentsForClassInSchool" operation.

Code 6.52.1 - JSON payload example for "default, 400, 401, 403, 422, 429, 500" response messages for a "getEnrollmentsForSchool" operation.

Code 6.52.2 - JSON payload example for "200" response messages for a "getEnrollmentsForSchool" operation.

Code 6.54.1 - JSON payload example for "default, 400, 401, 403, 404, 422, 429, 500" response messages for a "getGradingPeriod" operation.

Code 6.54.2 - JSON payload example for "200" response messages for a "getGradingPeriod" operation.

Code 6.56.1 - JSON payload example for "default, 400, 401, 403, 422, 429, 500" response messages for a "getGradingPeriodsForTerm" operation.

Code 6.56.2 - JSON payload example for "200" response messages for a "getGradingPeriodsForTerm" operation.

Code 6.58.1 - JSON payload example for "default, 400, 401, 403, 404, 422, 429, 500" response messages for a "getOrg" operation.

Code 6.58.2 - JSON payload example for "200" response messages for a "getOrg" operation.

Code 6.60.1 - JSON payload example for "default, 400, 401, 403, 404, 422, 429, 500" response messages for a "getSchool" operation.

Code 6.60.2 - JSON payload example for "200" response messages for a "getSchool" operation.

Code 6.62.1 - JSON payload example for "default, 400, 401, 403, 404, 429, 422, 500" response messages for a "getStudent" operation.

Code 6.62.2 - JSON payload example for "200" response messages for a "getStudent" operation.

Code 6.64.1 - JSON payload example for "default, 400, 401, 403, 422, 429, 500" response messages for a "getStudentsForClass" operation.

Code 6.64.2 - JSON payload example for "200" response messages for a "getStudentsForClass" operation.

Code 6.66.1 - JSON payload example for "default, 400, 401, 403, 422, 429, 500" response messages for a "getStudentsForClassInSchool" operation.

Code 6.66.2 - JSON payload example for "200" response messages for a "getStudentsForClassInSchool" operation.

Code 6.68.1 - JSON payload example for "default, 400, 401, 403, 422, 429, 500" response messages for a "getStudentsForSchool" operation.

Code 6.68.2 - JSON payload example for "200" response messages for a "getStudentsForSchool" operation.

Code 6.70.1 - JSON payload example for "default, 400, 401, 403, 404, 429, 422, 500" response messages for a "getTeacher" operation.

Code 6.70.2 - JSON payload example for "200" response messages for a "getTeacher" operation.

Code 6.72.1 - JSON payload example for "default, 400, 401, 403, 422, 429, 500" response messages for a "getTeachersForClass" operation.

Code 6.72.2 - JSON payload example for "200" response messages for a "getTeachersForClass" operation.

Code 6.74.1 - JSON payload example for "default, 400, 401, 403, 422, 429, 500" response messages for a "getTeachersForClassInSchool" operation.

Code 6.74.2 - JSON payload example for "200" response messages for a "getTeachersForClassInSchool" operation.

Code 6.76.1 - JSON payload example for "default, 400, 401, 403, 422, 429, 500" response messages for a "getTeachersForSchool" operation.

Code 6.76.2 - JSON payload example for "200" response messages for a "getTeachersForSchool" operation.

Code 6.78.1 - JSON payload example for "default, 400, 401, 403, 404, 422, 429, 500" response messages for a "getTerm" operation.

Code 6.78.2 - JSON payload example for "200" response messages for a "getTerm" operation.

Code 6.80.1 - JSON payload example for "default, 400, 401, 403, 422, 429, 500" response messages for a "getTermsForSchool" operation.

Code 6.80.2 - JSON payload example for "200" response messages for a "getTermsForSchool" operation.

Code 6.82.1 - JSON payload example for "default, 400, 401, 403, 404, 429, 422, 500" response messages for a "getUser" operation.

Code 6.82.2 - JSON payload example for "200" response messages for a "getUser" operation.

toc | top

1. Introduction

This Section is NOT NORMATIVE.

1.1. Scope and Context

This document is the OneRoster 1.2 Rostering Service REST/JSON Binding and as such it is used as the basis for the implementing the OR Rostering Service Model. The key related documents are:

The OR Rostering service model and this REST/JSON binding is described using the Unified Modeling Language (UML) based upon the IMS Global Model Driven Specification approach and the associated modelling toolkit [I-BAT, 06]. This means that this specification is based upon the concepts of:

Key artefacts produced as part of the REST/JSON binding description are the associated OpenAPI files based upon the OpenAPI Specifications version 2 [OAS, 14] and version 3 [OAS, 17].

1.2. Conventions

All sections marked as non-normative, all authoring guidelines, diagrams (with the exception of the UML diagrams), examples, and notes in this specification are non-normative. Everything else in this specification is normative.

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in [RFC 2119]. This means that from the perspective of conformance:

The Conformance and Certification Guide for this specification may introduce greater normative constraints than those defined here for specific service or implementation categories.

The SHOULD/SHOULD NOT/RECOMMENDED statements MUST NOT be used in any document, or section of a document, that is responsible for defining the information model and/or the associated bindings and/or conformance and certification.

1.3. Changes in Rostering Service 1.2

The set of changes made between OR 1.1 and OR 1.2 with respect to rostering are:

1.4. Structure of this Document

The structure of the rest of this document is:

2. REST Endpoints An explanation of the relationship between the logical service operations (as defined in the OneRoster Rostering Service Model) and how these are realised as the corresponding set of REST endpoints (including the set of query parameters that are permitted);
3. Using the Endpoint Parameters A detailed explanation of how the permitted set of query parameters should be used to control the volume and type of information that will be supplied by the service provider;
4. Security Framework The underlying security framework within which this REST/JSON binding is designed to operate. This includes the details about authentication and how the payload integrity may be protected;
5. UML to JSON Payload Mapping The description of how the JSON payloads are derived from the equivalent UML data model definitions [OR-ROS-SM-12]. Each UML class and attribute is mapped to the equivalent JSON object and property;
6. JSON Payloads Examples of the set of JSON payloads that are sent by the consumer (the request) and returned by the service provider (response). These examples are focused on the expected structure of a request/response and do not include actual payloads;
7. OpenAPI Description A detailed explanation of the structure of the OpenAPI files that are produced as part of the specification documentation. The associated JSON and YAML files are supplied in Appendix B;
8. Extending and Profiling the Binding An explanation of how the service can be extended, using the permitted points of extension and/or profiled. Profiling is the process by which the specification is tailored to a specific set of market/domain requirements;
References The set of cited documents, normative and informative, that are used to support the technical details in this document;
Appendix A Model Binding Terms and Concepts An overview of the model driven approach, the concepts and the terms used by IMS to create the service model REST/JSON binding definitions (based upon a profile of UML) and the accompanying documentation (including this binding);
Appendix B OpenAPI Listings The listings of the OpenAPI(JSON) and OpenAPI(YAML) files that have been created to define the REST/JSON binding in a machine-readable format i.e. conforming to the OpenAPI 2.0 specification;
Appendix C JSON Schema Listings The listings of the set of JSON Schema files (based upon IETF JSON Schema Draft 7) that have been created for the validation of the set of JSON payloads that are exchanged as part of this service.

1.5. Nomenclature

API Application Programming Interface
CEDS Common Education Data Standards
GUID Globally Unique Identifier
HTTP Hypertext Transfer Protocol
I-BAT IMS Binding Autogeneration Toolkit
IETF Internet Engineering Task Force
JSON Java Script Object Notation
LIS Learning Information Services
NCES National Centre for Education Statistics
PII Personally Identifiable Information
REST Representational State Transfer
RFC Request for Comments
TLS Transport Layer Security
UML Unified Modeling Language
URI Uniform Resource Identifier
URL Uniform Resource Locator
UTC Coordinated Universal Time
YAML Yet Another Markup Language

toc | top

2. REST Endpoints

This Section is NORMATIVE.

2.1 Mapping of the Service Operations to the REST Endpoints

The mapping between the service operations and the REST Endpoint URL-leaf values are listed in Table 2.1. The syntax and semantics for this mapping are described in Appendix A1.1.

Table 2.1 - The Set of REST Endpoint URL-leaf Values.
Service Call REST Endpoint HTTP Verb
getAcademicSession /academicSessions/{sourcedId} GET
getAllAcademicSessions /academicSessions GET
getAllClasses /classes GET
getAllCourses /courses GET
getAllDemographics /demographics GET
getAllEnrollments /enrollments GET
getAllGradingPeriods /gradingPeriods GET
getAllOrgs /orgs GET
getAllSchools /schools GET
getAllStudents /students GET
getAllTeachers /teachers GET
getAllTerms /terms GET
getAllUsers /users GET
getClass /classes/{sourcedId} GET
getClassesForCourse /courses/{courseSourcedId}/classes GET
getClassesForSchool /schools/{schoolSourcedId}/classes GET
getClassesForStudent /students/{studentSourcedId}/classes GET
getClassesForTeacher /teachers/{teacherSourcedId}/classes GET
getClassesForTerm /terms/{termSourcedId}/classes GET
getClassesForUser /users/{userSourcedId}/classes GET
getCourse /courses/{sourcedId} GET
getCoursesForSchool /schools/{schoolSourcedId}/courses GET
getDemographics /demographics/{sourcedId} GET
getEnrollment /enrollments/{sourcedId} GET
getEnrollmentsForClassInSchool /schools/{schoolSourcedId}/classes/{classSourcedId}/enrollments GET
getEnrollmentsForSchool /schools/{schoolSourcedId}/enrollments GET
getGradingPeriod /gradingPeriods/{sourcedId} GET
getGradingPeriodsForTerm /terms/{termSourcedId}/gradingPeriods GET
getOrg /orgs/{sourcedId} GET
getSchool /schools/{sourcedId} GET
getStudent /students/{sourcedId} GET
getStudentsForClass /classes/{classSourcedId}/students GET
getStudentsForClassInSchool /schools/{schoolSourcedId}/classes/{classSourcedId}/students GET
getStudentsForSchool /schools/{schoolSourcedId}/students GET
getTeacher /teachers/{sourcedId} GET
getTeachersForClass /classes/{classSourcedId}/teachers GET
getTeachersForClassInSchool /schools/{schoolSourcedId}/classes/{classSourcedId}/teachers GET
getTeachersForSchool /schools/{schoolSourcedId}/teachers GET
getTerm /terms/{sourcedId} GET
getTermsForSchool /schools/{schoolSourcedId}/terms GET
getUser /users/{sourcedId} GET

2.2 API Root URL and Versioning

All of the paths MUST also contain, as the base of the path, excluding the host name, the string: "/ims/oneroster/rostering/v1p2".

2.3 Predefined Endpoint Query Parameters

The definition of the permitted set of query parameters are defined in the following Tables. The syntax and semantics for this Tables are described in Appendix A1.2.

2.3.1 "getAcademicSession" Endpoint Query Parameters

2.3.1.1 "fields" Query Parameter

The description of the "fields" query parameter is presented in Table 2.3.1.1

Table 2.3.1.1 - The definition of the "fields" query parameter for the "getAcademicSession" operation.
Descriptor Definition
Parameter Name fields
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..*]
Description To identify the range of fields that should be supplied in the response message.

2.3.2 "getAllAcademicSessions" Endpoint Query Parameters

2.3.2.1 "limit" Query Parameter

The description of the "limit" query parameter is presented in Table 2.3.2.1

Table 2.3.2.1 - The definition of the "limit" query parameter for the "getAllAcademicSessions" operation.
Descriptor Definition
Parameter Name limit
Data Type PositiveInteger (Primitive-type)
Value Space See Appendix A1.2.
Default = "100".
Multiplicity [0..1]
Description To define the download segmentation value i.e. the maximum number of records to be contained in the response.

2.3.2.2 "offset" Query Parameter

The description of the "offset" query parameter is presented in Table 2.3.2.2

Table 2.3.2.2 - The definition of the "offset" query parameter for the "getAllAcademicSessions" operation.
Descriptor Definition
Parameter Name offset
Data Type NonNegativeInteger (Primitive-type)
Value Space See Appendix A1.2.
Default = "0".
Multiplicity [0..1]
Description The number of the first record to be supplied in the segmented response message.

2.3.2.3 "sort" Query Parameter

The description of the "sort" query parameter is presented in Table 2.3.2.3

Table 2.3.2.3 - The definition of the "sort" query parameter for the "getAllAcademicSessions" operation.
Descriptor Definition
Parameter Name sort
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..1]
Description Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter. The sort order should follow the [UNICODE, 16] standard.

2.3.2.4 "orderBy" Query Parameter

The description of the "orderBy" query parameter is presented in Table 2.3.2.4

Table 2.3.2.4 - The definition of the "orderBy" query parameter for the "getAllAcademicSessions" operation.
Descriptor Definition
Parameter Name orderBy
Data Type Enumeration
Value Space Enumerated value set of: { asc | desc }
Multiplicity [0..1]
Description The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc). The sort order should follow the [UNICODE, 16] standard.

2.3.2.5 "filter" Query Parameter

The description of the "filter" query parameter is presented in Table 2.3.2.5

Table 2.3.2.5 - The definition of the "filter" query parameter for the "getAllAcademicSessions" operation.
Descriptor Definition
Parameter Name filter
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..1]
Description The filtering rules to be applied when identifying the records to be supplied in the response message. The sort order should follow the [UNICODE, 16] standard.

2.3.2.6 "fields" Query Parameter

The description of the "fields" query parameter is presented in Table 2.3.2.6

Table 2.3.2.6 - The definition of the "fields" query parameter for the "getAllAcademicSessions" operation.
Descriptor Definition
Parameter Name fields
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..*]
Description To identify the range of fields that should be supplied in the response message.

2.3.3 "getAllClasses" Endpoint Query Parameters

2.3.3.1 "limit" Query Parameter

The description of the "limit" query parameter is presented in Table 2.3.3.1

Table 2.3.3.1 - The definition of the "limit" query parameter for the "getAllClasses" operation.
Descriptor Definition
Parameter Name limit
Data Type PositiveInteger (Primitive-type)
Value Space See Appendix A1.2.
Default = "100".
Multiplicity [0..1]
Description To define the download segmentation value i.e. the maximum number of records to be contained in the response.

2.3.3.2 "offset" Query Parameter

The description of the "offset" query parameter is presented in Table 2.3.3.2

Table 2.3.3.2 - The definition of the "offset" query parameter for the "getAllClasses" operation.
Descriptor Definition
Parameter Name offset
Data Type NonNegativeInteger (Primitive-type)
Value Space See Appendix A1.2.
Default = "0".
Multiplicity [0..1]
Description The number of the first record to be supplied in the segmented response message.

2.3.3.3 "sort" Query Parameter

The description of the "sort" query parameter is presented in Table 2.3.3.3

Table 2.3.3.3 - The definition of the "sort" query parameter for the "getAllClasses" operation.
Descriptor Definition
Parameter Name sort
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..1]
Description Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter. The sort order should follow the [UNICODE, 16] standard.

2.3.3.4 "orderBy" Query Parameter

The description of the "orderBy" query parameter is presented in Table 2.3.3.4

Table 2.3.3.4 - The definition of the "orderBy" query parameter for the "getAllClasses" operation.
Descriptor Definition
Parameter Name orderBy
Data Type Enumeration
Value Space Enumerated value set of: { asc | desc }
Multiplicity [0..1]
Description The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc). The sort order should follow the [UNICODE, 16] standard.

2.3.3.5 "filter" Query Parameter

The description of the "filter" query parameter is presented in Table 2.3.3.5

Table 2.3.3.5 - The definition of the "filter" query parameter for the "getAllClasses" operation.
Descriptor Definition
Parameter Name filter
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..1]
Description The filtering rules to be applied when identifying the records to be supplied in the response message. The sort order should follow the [UNICODE, 16] standard.

2.3.3.6 "fields" Query Parameter

The description of the "fields" query parameter is presented in Table 2.3.3.6

Table 2.3.3.6 - The definition of the "fields" query parameter for the "getAllClasses" operation.
Descriptor Definition
Parameter Name fields
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..*]
Description To identify the range of fields that should be supplied in the response message.

2.3.4 "getAllCourses" Endpoint Query Parameters

2.3.4.1 "limit" Query Parameter

The description of the "limit" query parameter is presented in Table 2.3.4.1

Table 2.3.4.1 - The definition of the "limit" query parameter for the "getAllCourses" operation.
Descriptor Definition
Parameter Name limit
Data Type PositiveInteger (Primitive-type)
Value Space See Appendix A1.2.
Default = "100".
Multiplicity [0..1]
Description To define the download segmentation value i.e. the maximum number of records to be contained in the response.

2.3.4.2 "offset" Query Parameter

The description of the "offset" query parameter is presented in Table 2.3.4.2

Table 2.3.4.2 - The definition of the "offset" query parameter for the "getAllCourses" operation.
Descriptor Definition
Parameter Name offset
Data Type NonNegativeInteger (Primitive-type)
Value Space See Appendix A1.2.
Default = "0".
Multiplicity [0..1]
Description The number of the first record to be supplied in the segmented response message.

2.3.4.3 "sort" Query Parameter

The description of the "sort" query parameter is presented in Table 2.3.4.3

Table 2.3.4.3 - The definition of the "sort" query parameter for the "getAllCourses" operation.
Descriptor Definition
Parameter Name sort
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..1]
Description Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter. The sort order should follow the [UNICODE, 16] standard.

2.3.4.4 "orderBy" Query Parameter

The description of the "orderBy" query parameter is presented in Table 2.3.4.4

Table 2.3.4.4 - The definition of the "orderBy" query parameter for the "getAllCourses" operation.
Descriptor Definition
Parameter Name orderBy
Data Type Enumeration
Value Space Enumerated value set of: { asc | desc }
Multiplicity [0..1]
Description The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc). The sort order should follow the [UNICODE, 16] standard.

2.3.4.5 "filter" Query Parameter

The description of the "filter" query parameter is presented in Table 2.3.4.5

Table 2.3.4.5 - The definition of the "filter" query parameter for the "getAllCourses" operation.
Descriptor Definition
Parameter Name filter
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..1]
Description The filtering rules to be applied when identifying the records to be supplied in the response message. The sort order should follow the [UNICODE, 16] standard.

2.3.4.6 "fields" Query Parameter

The description of the "fields" query parameter is presented in Table 2.3.4.6

Table 2.3.4.6 - The definition of the "fields" query parameter for the "getAllCourses" operation.
Descriptor Definition
Parameter Name fields
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..*]
Description To identify the range of fields that should be supplied in the response message.

2.3.5 "getAllDemographics" Endpoint Query Parameters

2.3.5.1 "limit" Query Parameter

The description of the "limit" query parameter is presented in Table 2.3.5.1

Table 2.3.5.1 - The definition of the "limit" query parameter for the "getAllDemographics" operation.
Descriptor Definition
Parameter Name limit
Data Type PositiveInteger (Primitive-type)
Value Space See Appendix A1.2.
Default = "100".
Multiplicity [0..1]
Description To define the download segmentation value i.e. the maximum number of records to be contained in the response.

2.3.5.2 "offset" Query Parameter

The description of the "offset" query parameter is presented in Table 2.3.5.2

Table 2.3.5.2 - The definition of the "offset" query parameter for the "getAllDemographics" operation.
Descriptor Definition
Parameter Name offset
Data Type NonNegativeInteger (Primitive-type)
Value Space See Appendix A1.2.
Default = "0".
Multiplicity [0..1]
Description The number of the first record to be supplied in the segmented response message.

2.3.5.3 "sort" Query Parameter

The description of the "sort" query parameter is presented in Table 2.3.5.3

Table 2.3.5.3 - The definition of the "sort" query parameter for the "getAllDemographics" operation.
Descriptor Definition
Parameter Name sort
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..1]
Description Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter. The sort order should follow the [UNICODE, 16] standard.

2.3.5.4 "orderBy" Query Parameter

The description of the "orderBy" query parameter is presented in Table 2.3.5.4

Table 2.3.5.4 - The definition of the "orderBy" query parameter for the "getAllDemographics" operation.
Descriptor Definition
Parameter Name orderBy
Data Type Enumeration
Value Space Enumerated value set of: { asc | desc }
Multiplicity [0..1]
Description The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc). The sort order should follow the [UNICODE, 16] standard.

2.3.5.5 "filter" Query Parameter

The description of the "filter" query parameter is presented in Table 2.3.5.5

Table 2.3.5.5 - The definition of the "filter" query parameter for the "getAllDemographics" operation.
Descriptor Definition
Parameter Name filter
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..1]
Description The filtering rules to be applied when identifying the records to be supplied in the response message. The sort order should follow the [UNICODE, 16] standard.

2.3.5.6 "fields" Query Parameter

The description of the "fields" query parameter is presented in Table 2.3.5.6

Table 2.3.5.6 - The definition of the "fields" query parameter for the "getAllDemographics" operation.
Descriptor Definition
Parameter Name fields
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..*]
Description To identify the range of fields that should be supplied in the response message.

2.3.6 "getAllEnrollments" Endpoint Query Parameters

2.3.6.1 "limit" Query Parameter

The description of the "limit" query parameter is presented in Table 2.3.6.1

Table 2.3.6.1 - The definition of the "limit" query parameter for the "getAllEnrollments" operation.
Descriptor Definition
Parameter Name limit
Data Type PositiveInteger (Primitive-type)
Value Space See Appendix A1.2.
Default = "100".
Multiplicity [0..1]
Description To define the download segmentation value i.e. the maximum number of records to be contained in the response.

2.3.6.2 "offset" Query Parameter

The description of the "offset" query parameter is presented in Table 2.3.6.2

Table 2.3.6.2 - The definition of the "offset" query parameter for the "getAllEnrollments" operation.
Descriptor Definition
Parameter Name offset
Data Type NonNegativeInteger (Primitive-type)
Value Space See Appendix A1.2.
Default = "0".
Multiplicity [0..1]
Description The number of the first record to be supplied in the segmented response message.

2.3.6.3 "sort" Query Parameter

The description of the "sort" query parameter is presented in Table 2.3.6.3

Table 2.3.6.3 - The definition of the "sort" query parameter for the "getAllEnrollments" operation.
Descriptor Definition
Parameter Name sort
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..1]
Description Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter. The sort order should follow the [UNICODE, 16] standard.

2.3.6.4 "orderBy" Query Parameter

The description of the "orderBy" query parameter is presented in Table 2.3.6.4

Table 2.3.6.4 - The definition of the "orderBy" query parameter for the "getAllEnrollments" operation.
Descriptor Definition
Parameter Name orderBy
Data Type Enumeration
Value Space Enumerated value set of: { asc | desc }
Multiplicity [0..1]
Description The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc). The sort order should follow the [UNICODE, 16] standard.

2.3.6.5 "filter" Query Parameter

The description of the "filter" query parameter is presented in Table 2.3.6.5

Table 2.3.6.5 - The definition of the "filter" query parameter for the "getAllEnrollments" operation.
Descriptor Definition
Parameter Name filter
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..1]
Description The filtering rules to be applied when identifying the records to be supplied in the response message. The sort order should follow the [UNICODE, 16] standard.

2.3.6.6 "fields" Query Parameter

The description of the "fields" query parameter is presented in Table 2.3.6.6

Table 2.3.6.6 - The definition of the "fields" query parameter for the "getAllEnrollments" operation.
Descriptor Definition
Parameter Name fields
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..*]
Description To identify the range of fields that should be supplied in the response message.

2.3.7 "getAllGradingPeriods" Endpoint Query Parameters

2.3.7.1 "limit" Query Parameter

The description of the "limit" query parameter is presented in Table 2.3.7.1

Table 2.3.7.1 - The definition of the "limit" query parameter for the "getAllGradingPeriods" operation.
Descriptor Definition
Parameter Name limit
Data Type PositiveInteger (Primitive-type)
Value Space See Appendix A1.2.
Default = "100".
Multiplicity [0..1]
Description To define the download segmentation value i.e. the maximum number of records to be contained in the response.

2.3.7.2 "offset" Query Parameter

The description of the "offset" query parameter is presented in Table 2.3.7.2

Table 2.3.7.2 - The definition of the "offset" query parameter for the "getAllGradingPeriods" operation.
Descriptor Definition
Parameter Name offset
Data Type NonNegativeInteger (Primitive-type)
Value Space See Appendix A1.2.
Default = "0".
Multiplicity [0..1]
Description The number of the first record to be supplied in the segmented response message.

2.3.7.3 "sort" Query Parameter

The description of the "sort" query parameter is presented in Table 2.3.7.3

Table 2.3.7.3 - The definition of the "sort" query parameter for the "getAllGradingPeriods" operation.
Descriptor Definition
Parameter Name sort
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..1]
Description Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter. The sort order should follow the [UNICODE, 16] standard.

2.3.7.4 "orderBy" Query Parameter

The description of the "orderBy" query parameter is presented in Table 2.3.7.4

Table 2.3.7.4 - The definition of the "orderBy" query parameter for the "getAllGradingPeriods" operation.
Descriptor Definition
Parameter Name orderBy
Data Type Enumeration
Value Space Enumerated value set of: { asc | desc }
Multiplicity [0..1]
Description The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc). The sort order should follow the [UNICODE, 16] standard.

2.3.7.5 "filter" Query Parameter

The description of the "filter" query parameter is presented in Table 2.3.7.5

Table 2.3.7.5 - The definition of the "filter" query parameter for the "getAllGradingPeriods" operation.
Descriptor Definition
Parameter Name filter
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..1]
Description The filtering rules to be applied when identifying the records to be supplied in the response message. The sort order should follow the [UNICODE, 16] standard.

2.3.7.6 "fields" Query Parameter

The description of the "fields" query parameter is presented in Table 2.3.7.6

Table 2.3.7.6 - The definition of the "fields" query parameter for the "getAllGradingPeriods" operation.
Descriptor Definition
Parameter Name fields
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..*]
Description To identify the range of fields that should be supplied in the response message.

2.3.8 "getAllOrgs" Endpoint Query Parameters

2.3.8.1 "limit" Query Parameter

The description of the "limit" query parameter is presented in Table 2.3.8.1

Table 2.3.8.1 - The definition of the "limit" query parameter for the "getAllOrgs" operation.
Descriptor Definition
Parameter Name limit
Data Type PositiveInteger (Primitive-type)
Value Space See Appendix A1.2.
Default = "100".
Multiplicity [0..1]
Description To define the download segmentation value i.e. the maximum number of records to be contained in the response.

2.3.8.2 "offset" Query Parameter

The description of the "offset" query parameter is presented in Table 2.3.8.2

Table 2.3.8.2 - The definition of the "offset" query parameter for the "getAllOrgs" operation.
Descriptor Definition
Parameter Name offset
Data Type NonNegativeInteger (Primitive-type)
Value Space See Appendix A1.2.
Default = "0".
Multiplicity [0..1]
Description The number of the first record to be supplied in the segmented response message.

2.3.8.3 "sort" Query Parameter

The description of the "sort" query parameter is presented in Table 2.3.8.3

Table 2.3.8.3 - The definition of the "sort" query parameter for the "getAllOrgs" operation.
Descriptor Definition
Parameter Name sort
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..1]
Description Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter. The sort order should follow the [UNICODE, 16] standard.

2.3.8.4 "orderBy" Query Parameter

The description of the "orderBy" query parameter is presented in Table 2.3.8.4

Table 2.3.8.4 - The definition of the "orderBy" query parameter for the "getAllOrgs" operation.
Descriptor Definition
Parameter Name orderBy
Data Type Enumeration
Value Space Enumerated value set of: { asc | desc }
Multiplicity [0..1]
Description The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc). The sort order should follow the [UNICODE, 16] standard.

2.3.8.5 "filter" Query Parameter

The description of the "filter" query parameter is presented in Table 2.3.8.5

Table 2.3.8.5 - The definition of the "filter" query parameter for the "getAllOrgs" operation.
Descriptor Definition
Parameter Name filter
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..1]
Description The filtering rules to be applied when identifying the records to be supplied in the response message. The sort order should follow the [UNICODE, 16] standard.

2.3.8.6 "fields" Query Parameter

The description of the "fields" query parameter is presented in Table 2.3.8.6

Table 2.3.8.6 - The definition of the "fields" query parameter for the "getAllOrgs" operation.
Descriptor Definition
Parameter Name fields
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..*]
Description To identify the range of fields that should be supplied in the response message.

2.3.9 "getAllSchools" Endpoint Query Parameters

2.3.9.1 "limit" Query Parameter

The description of the "limit" query parameter is presented in Table 2.3.9.1

Table 2.3.9.1 - The definition of the "limit" query parameter for the "getAllSchools" operation.
Descriptor Definition
Parameter Name limit
Data Type PositiveInteger (Primitive-type)
Value Space See Appendix A1.2.
Default = "100".
Multiplicity [0..1]
Description To define the download segmentation value i.e. the maximum number of records to be contained in the response.

2.3.9.2 "offset" Query Parameter

The description of the "offset" query parameter is presented in Table 2.3.9.2

Table 2.3.9.2 - The definition of the "offset" query parameter for the "getAllSchools" operation.
Descriptor Definition
Parameter Name offset
Data Type NonNegativeInteger (Primitive-type)
Value Space See Appendix A1.2.
Default = "0".
Multiplicity [0..1]
Description The number of the first record to be supplied in the segmented response message.

2.3.9.3 "sort" Query Parameter

The description of the "sort" query parameter is presented in Table 2.3.9.3

Table 2.3.9.3 - The definition of the "sort" query parameter for the "getAllSchools" operation.
Descriptor Definition
Parameter Name sort
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..1]
Description Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter. The sort order should follow the [UNICODE, 16] standard.

2.3.9.4 "orderBy" Query Parameter

The description of the "orderBy" query parameter is presented in Table 2.3.9.4

Table 2.3.9.4 - The definition of the "orderBy" query parameter for the "getAllSchools" operation.
Descriptor Definition
Parameter Name orderBy
Data Type Enumeration
Value Space Enumerated value set of: { asc | desc }
Multiplicity [0..1]
Description The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc). The sort order should follow the [UNICODE, 16] standard.

2.3.9.5 "filter" Query Parameter

The description of the "filter" query parameter is presented in Table 2.3.9.5

Table 2.3.9.5 - The definition of the "filter" query parameter for the "getAllSchools" operation.
Descriptor Definition
Parameter Name filter
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..1]
Description The filtering rules to be applied when identifying the records to be supplied in the response message. The sort order should follow the [UNICODE, 16] standard.

2.3.9.6 "fields" Query Parameter

The description of the "fields" query parameter is presented in Table 2.3.9.6

Table 2.3.9.6 - The definition of the "fields" query parameter for the "getAllSchools" operation.
Descriptor Definition
Parameter Name fields
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..*]
Description To identify the range of fields that should be supplied in the response message.

2.3.10 "getAllStudents" Endpoint Query Parameters

2.3.10.1 "limit" Query Parameter

The description of the "limit" query parameter is presented in Table 2.3.10.1

Table 2.3.10.1 - The definition of the "limit" query parameter for the "getAllStudents" operation.
Descriptor Definition
Parameter Name limit
Data Type PositiveInteger (Primitive-type)
Value Space See Appendix A1.2.
Default = "100".
Multiplicity [0..1]
Description To define the download segmentation value i.e. the maximum number of records to be contained in the response.

2.3.10.2 "offset" Query Parameter

The description of the "offset" query parameter is presented in Table 2.3.10.2

Table 2.3.10.2 - The definition of the "offset" query parameter for the "getAllStudents" operation.
Descriptor Definition
Parameter Name offset
Data Type NonNegativeInteger (Primitive-type)
Value Space See Appendix A1.2.
Default = "0".
Multiplicity [0..1]
Description The number of the first record to be supplied in the segmented response message.

2.3.10.3 "sort" Query Parameter

The description of the "sort" query parameter is presented in Table 2.3.10.3

Table 2.3.10.3 - The definition of the "sort" query parameter for the "getAllStudents" operation.
Descriptor Definition
Parameter Name sort
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..1]
Description Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter. The sort order should follow the [UNICODE, 16] standard.

2.3.10.4 "orderBy" Query Parameter

The description of the "orderBy" query parameter is presented in Table 2.3.10.4

Table 2.3.10.4 - The definition of the "orderBy" query parameter for the "getAllStudents" operation.
Descriptor Definition
Parameter Name orderBy
Data Type Enumeration
Value Space Enumerated value set of: { asc | desc }
Multiplicity [0..1]
Description The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc). The sort order should follow the [UNICODE, 16] standard.

2.3.10.5 "filter" Query Parameter

The description of the "filter" query parameter is presented in Table 2.3.10.5

Table 2.3.10.5 - The definition of the "filter" query parameter for the "getAllStudents" operation.
Descriptor Definition
Parameter Name filter
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..1]
Description The filtering rules to be applied when identifying the records to be supplied in the response message. The sort order should follow the [UNICODE, 16] standard.

2.3.10.6 "fields" Query Parameter

The description of the "fields" query parameter is presented in Table 2.3.10.6

Table 2.3.10.6 - The definition of the "fields" query parameter for the "getAllStudents" operation.
Descriptor Definition
Parameter Name fields
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..*]
Description To identify the range of fields that should be supplied in the response message.

2.3.11 "getAllTeachers" Endpoint Query Parameters

2.3.11.1 "limit" Query Parameter

The description of the "limit" query parameter is presented in Table 2.3.11.1

Table 2.3.11.1 - The definition of the "limit" query parameter for the "getAllTeachers" operation.
Descriptor Definition
Parameter Name limit
Data Type PositiveInteger (Primitive-type)
Value Space See Appendix A1.2.
Default = "100".
Multiplicity [0..1]
Description To define the download segmentation value i.e. the maximum number of records to be contained in the response.

2.3.11.2 "offset" Query Parameter

The description of the "offset" query parameter is presented in Table 2.3.11.2

Table 2.3.11.2 - The definition of the "offset" query parameter for the "getAllTeachers" operation.
Descriptor Definition
Parameter Name offset
Data Type NonNegativeInteger (Primitive-type)
Value Space See Appendix A1.2.
Default = "0".
Multiplicity [0..1]
Description The number of the first record to be supplied in the segmented response message.

2.3.11.3 "sort" Query Parameter

The description of the "sort" query parameter is presented in Table 2.3.11.3

Table 2.3.11.3 - The definition of the "sort" query parameter for the "getAllTeachers" operation.
Descriptor Definition
Parameter Name sort
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..1]
Description Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter. The sort order should follow the [UNICODE, 16] standard.

2.3.11.4 "orderBy" Query Parameter

The description of the "orderBy" query parameter is presented in Table 2.3.11.4

Table 2.3.11.4 - The definition of the "orderBy" query parameter for the "getAllTeachers" operation.
Descriptor Definition
Parameter Name orderBy
Data Type Enumeration
Value Space Enumerated value set of: { asc | desc }
Multiplicity [0..1]
Description The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc). The sort order should follow the [UNICODE, 16] standard.

2.3.11.5 "filter" Query Parameter

The description of the "filter" query parameter is presented in Table 2.3.11.5

Table 2.3.11.5 - The definition of the "filter" query parameter for the "getAllTeachers" operation.
Descriptor Definition
Parameter Name filter
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..1]
Description The filtering rules to be applied when identifying the records to be supplied in the response message. The sort order should follow the [UNICODE, 16] standard.

2.3.11.6 "fields" Query Parameter

The description of the "fields" query parameter is presented in Table 2.3.11.6

Table 2.3.11.6 - The definition of the "fields" query parameter for the "getAllTeachers" operation.
Descriptor Definition
Parameter Name fields
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..*]
Description To identify the range of fields that should be supplied in the response message.

2.3.12 "getAllTerms" Endpoint Query Parameters

2.3.12.1 "limit" Query Parameter

The description of the "limit" query parameter is presented in Table 2.3.12.1

Table 2.3.12.1 - The definition of the "limit" query parameter for the "getAllTerms" operation.
Descriptor Definition
Parameter Name limit
Data Type PositiveInteger (Primitive-type)
Value Space See Appendix A1.2.
Default = "100".
Multiplicity [0..1]
Description To define the download segmentation value i.e. the maximum number of records to be contained in the response.

2.3.12.2 "offset" Query Parameter

The description of the "offset" query parameter is presented in Table 2.3.12.2

Table 2.3.12.2 - The definition of the "offset" query parameter for the "getAllTerms" operation.
Descriptor Definition
Parameter Name offset
Data Type NonNegativeInteger (Primitive-type)
Value Space See Appendix A1.2.
Default = "0".
Multiplicity [0..1]
Description The number of the first record to be supplied in the segmented response message.

2.3.12.3 "sort" Query Parameter

The description of the "sort" query parameter is presented in Table 2.3.12.3

Table 2.3.12.3 - The definition of the "sort" query parameter for the "getAllTerms" operation.
Descriptor Definition
Parameter Name sort
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..1]
Description Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter. The sort order should follow the [UNICODE, 16] standard.

2.3.12.4 "orderBy" Query Parameter

The description of the "orderBy" query parameter is presented in Table 2.3.12.4

Table 2.3.12.4 - The definition of the "orderBy" query parameter for the "getAllTerms" operation.
Descriptor Definition
Parameter Name orderBy
Data Type Enumeration
Value Space Enumerated value set of: { asc | desc }
Multiplicity [0..1]
Description The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc). The sort order should follow the [UNICODE, 16] standard.

2.3.12.5 "filter" Query Parameter

The description of the "filter" query parameter is presented in Table 2.3.12.5

Table 2.3.12.5 - The definition of the "filter" query parameter for the "getAllTerms" operation.
Descriptor Definition
Parameter Name filter
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..1]
Description The filtering rules to be applied when identifying the records to be supplied in the response message. The sort order should follow the [UNICODE, 16] standard.

2.3.12.6 "fields" Query Parameter

The description of the "fields" query parameter is presented in Table 2.3.12.6

Table 2.3.12.6 - The definition of the "fields" query parameter for the "getAllTerms" operation.
Descriptor Definition
Parameter Name fields
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..*]
Description To identify the range of fields that should be supplied in the response message.

2.3.13 "getAllUsers" Endpoint Query Parameters

2.3.13.1 "limit" Query Parameter

The description of the "limit" query parameter is presented in Table 2.3.13.1

Table 2.3.13.1 - The definition of the "limit" query parameter for the "getAllUsers" operation.
Descriptor Definition
Parameter Name limit
Data Type PositiveInteger (Primitive-type)
Value Space See Appendix A1.2.
Default = "100".
Multiplicity [0..1]
Description To define the download segmentation value i.e. the maximum number of records to be contained in the response.

2.3.13.2 "offset" Query Parameter

The description of the "offset" query parameter is presented in Table 2.3.13.2

Table 2.3.13.2 - The definition of the "offset" query parameter for the "getAllUsers" operation.
Descriptor Definition
Parameter Name offset
Data Type NonNegativeInteger (Primitive-type)
Value Space See Appendix A1.2.
Default = "0".
Multiplicity [0..1]
Description The number of the first record to be supplied in the segmented response message.

2.3.13.3 "sort" Query Parameter

The description of the "sort" query parameter is presented in Table 2.3.13.3

Table 2.3.13.3 - The definition of the "sort" query parameter for the "getAllUsers" operation.
Descriptor Definition
Parameter Name sort
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..1]
Description Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter. The sort order should follow the [UNICODE, 16] standard.

2.3.13.4 "orderBy" Query Parameter

The description of the "orderBy" query parameter is presented in Table 2.3.13.4

Table 2.3.13.4 - The definition of the "orderBy" query parameter for the "getAllUsers" operation.
Descriptor Definition
Parameter Name orderBy
Data Type Enumeration
Value Space Enumerated value set of: { asc | desc }
Multiplicity [0..1]
Description The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc). The sort order should follow the [UNICODE, 16] standard.

2.3.13.5 "filter" Query Parameter

The description of the "filter" query parameter is presented in Table 2.3.13.5

Table 2.3.13.5 - The definition of the "filter" query parameter for the "getAllUsers" operation.
Descriptor Definition
Parameter Name filter
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..1]
Description The filtering rules to be applied when identifying the records to be supplied in the response message. The sort order should follow the [UNICODE, 16] standard.

2.3.13.6 "fields" Query Parameter

The description of the "fields" query parameter is presented in Table 2.3.13.6

Table 2.3.13.6 - The definition of the "fields" query parameter for the "getAllUsers" operation.
Descriptor Definition
Parameter Name fields
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..*]
Description To identify the range of fields that should be supplied in the response message.

2.3.14 "getClass" Endpoint Query Parameters

2.3.14.1 "fields" Query Parameter

The description of the "fields" query parameter is presented in Table 2.3.14.1

Table 2.3.14.1 - The definition of the "fields" query parameter for the "getClass" operation.
Descriptor Definition
Parameter Name fields
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..*]
Description To identify the range of fields that should be supplied in the response message.

2.3.15 "getClassesForCourse" Endpoint Query Parameters

2.3.15.1 "limit" Query Parameter

The description of the "limit" query parameter is presented in Table 2.3.15.1

Table 2.3.15.1 - The definition of the "limit" query parameter for the "getClassesForCourse" operation.
Descriptor Definition
Parameter Name limit
Data Type PositiveInteger (Primitive-type)
Value Space See Appendix A1.2.
Default = "100".
Multiplicity [0..1]
Description To define the download segmentation value i.e. the maximum number of records to be contained in the response.

2.3.15.2 "offset" Query Parameter

The description of the "offset" query parameter is presented in Table 2.3.15.2

Table 2.3.15.2 - The definition of the "offset" query parameter for the "getClassesForCourse" operation.
Descriptor Definition
Parameter Name offset
Data Type NonNegativeInteger (Primitive-type)
Value Space See Appendix A1.2.
Default = "0".
Multiplicity [0..1]
Description The number of the first record to be supplied in the segmented response message.

2.3.15.3 "sort" Query Parameter

The description of the "sort" query parameter is presented in Table 2.3.15.3

Table 2.3.15.3 - The definition of the "sort" query parameter for the "getClassesForCourse" operation.
Descriptor Definition
Parameter Name sort
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..1]
Description Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter. The sort order should follow the [UNICODE, 16] standard.

2.3.15.4 "orderBy" Query Parameter

The description of the "orderBy" query parameter is presented in Table 2.3.15.4

Table 2.3.15.4 - The definition of the "orderBy" query parameter for the "getClassesForCourse" operation.
Descriptor Definition
Parameter Name orderBy
Data Type Enumeration
Value Space Enumerated value set of: { asc | desc }
Multiplicity [0..1]
Description The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc). The sort order should follow the [UNICODE, 16] standard.

2.3.15.5 "filter" Query Parameter

The description of the "filter" query parameter is presented in Table 2.3.15.5

Table 2.3.15.5 - The definition of the "filter" query parameter for the "getClassesForCourse" operation.
Descriptor Definition
Parameter Name filter
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..1]
Description The filtering rules to be applied when identifying the records to be supplied in the response message. The sort order should follow the [UNICODE, 16] standard.

2.3.15.6 "fields" Query Parameter

The description of the "fields" query parameter is presented in Table 2.3.15.6

Table 2.3.15.6 - The definition of the "fields" query parameter for the "getClassesForCourse" operation.
Descriptor Definition
Parameter Name fields
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..*]
Description To identify the range of fields that should be supplied in the response message.

2.3.16 "getClassesForSchool" Endpoint Query Parameters

2.3.16.1 "limit" Query Parameter

The description of the "limit" query parameter is presented in Table 2.3.16.1

Table 2.3.16.1 - The definition of the "limit" query parameter for the "getClassesForSchool" operation.
Descriptor Definition
Parameter Name limit
Data Type PositiveInteger (Primitive-type)
Value Space See Appendix A1.2.
Default = "100".
Multiplicity [0..1]
Description To define the download segmentation value i.e. the maximum number of records to be contained in the response.

2.3.16.2 "offset" Query Parameter

The description of the "offset" query parameter is presented in Table 2.3.16.2

Table 2.3.16.2 - The definition of the "offset" query parameter for the "getClassesForSchool" operation.
Descriptor Definition
Parameter Name offset
Data Type NonNegativeInteger (Primitive-type)
Value Space See Appendix A1.2.
Default = "0".
Multiplicity [0..1]
Description The number of the first record to be supplied in the segmented response message.

2.3.16.3 "sort" Query Parameter

The description of the "sort" query parameter is presented in Table 2.3.16.3

Table 2.3.16.3 - The definition of the "sort" query parameter for the "getClassesForSchool" operation.
Descriptor Definition
Parameter Name sort
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..1]
Description Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter. The sort order should follow the [UNICODE, 16] standard.

2.3.16.4 "orderBy" Query Parameter

The description of the "orderBy" query parameter is presented in Table 2.3.16.4

Table 2.3.16.4 - The definition of the "orderBy" query parameter for the "getClassesForSchool" operation.
Descriptor Definition
Parameter Name orderBy
Data Type Enumeration
Value Space Enumerated value set of: { asc | desc }
Multiplicity [0..1]
Description The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc). The sort order should follow the [UNICODE, 16] standard.

2.3.16.5 "filter" Query Parameter

The description of the "filter" query parameter is presented in Table 2.3.16.5

Table 2.3.16.5 - The definition of the "filter" query parameter for the "getClassesForSchool" operation.
Descriptor Definition
Parameter Name filter
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..1]
Description The filtering rules to be applied when identifying the records to be supplied in the response message. The sort order should follow the [UNICODE, 16] standard.

2.3.16.6 "fields" Query Parameter

The description of the "fields" query parameter is presented in Table 2.3.16.6

Table 2.3.16.6 - The definition of the "fields" query parameter for the "getClassesForSchool" operation.
Descriptor Definition
Parameter Name fields
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..*]
Description To identify the range of fields that should be supplied in the response message.

2.3.17 "getClassesForStudent" Endpoint Query Parameters

2.3.17.1 "limit" Query Parameter

The description of the "limit" query parameter is presented in Table 2.3.17.1

Table 2.3.17.1 - The definition of the "limit" query parameter for the "getClassesForStudent" operation.
Descriptor Definition
Parameter Name limit
Data Type PositiveInteger (Primitive-type)
Value Space See Appendix A1.2.
Default = "100".
Multiplicity [0..1]
Description To define the download segmentation value i.e. the maximum number of records to be contained in the response.

2.3.17.2 "offset" Query Parameter

The description of the "offset" query parameter is presented in Table 2.3.17.2

Table 2.3.17.2 - The definition of the "offset" query parameter for the "getClassesForStudent" operation.
Descriptor Definition
Parameter Name offset
Data Type NonNegativeInteger (Primitive-type)
Value Space See Appendix A1.2.
Default = "0".
Multiplicity [0..1]
Description The number of the first record to be supplied in the segmented response message.

2.3.17.3 "sort" Query Parameter

The description of the "sort" query parameter is presented in Table 2.3.17.3

Table 2.3.17.3 - The definition of the "sort" query parameter for the "getClassesForStudent" operation.
Descriptor Definition
Parameter Name sort
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..1]
Description Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter. The sort order should follow the [UNICODE, 16] standard.

2.3.17.4 "orderBy" Query Parameter

The description of the "orderBy" query parameter is presented in Table 2.3.17.4

Table 2.3.17.4 - The definition of the "orderBy" query parameter for the "getClassesForStudent" operation.
Descriptor Definition
Parameter Name orderBy
Data Type Enumeration
Value Space Enumerated value set of: { asc | desc }
Multiplicity [0..1]
Description The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc). The sort order should follow the [UNICODE, 16] standard.

2.3.17.5 "filter" Query Parameter

The description of the "filter" query parameter is presented in Table 2.3.17.5

Table 2.3.17.5 - The definition of the "filter" query parameter for the "getClassesForStudent" operation.
Descriptor Definition
Parameter Name filter
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..1]
Description The filtering rules to be applied when identifying the records to be supplied in the response message. The sort order should follow the [UNICODE, 16] standard.

2.3.17.6 "fields" Query Parameter

The description of the "fields" query parameter is presented in Table 2.3.17.6

Table 2.3.17.6 - The definition of the "fields" query parameter for the "getClassesForStudent" operation.
Descriptor Definition
Parameter Name fields
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..*]
Description To identify the range of fields that should be supplied in the response message.

2.3.18 "getClassesForTeacher" Endpoint Query Parameters

2.3.18.1 "limit" Query Parameter

The description of the "limit" query parameter is presented in Table 2.3.18.1

Table 2.3.18.1 - The definition of the "limit" query parameter for the "getClassesForTeacher" operation.
Descriptor Definition
Parameter Name limit
Data Type PositiveInteger (Primitive-type)
Value Space See Appendix A1.2.
Default = "100".
Multiplicity [0..1]
Description To define the download segmentation value i.e. the maximum number of records to be contained in the response.

2.3.18.2 "offset" Query Parameter

The description of the "offset" query parameter is presented in Table 2.3.18.2

Table 2.3.18.2 - The definition of the "offset" query parameter for the "getClassesForTeacher" operation.
Descriptor Definition
Parameter Name offset
Data Type NonNegativeInteger (Primitive-type)
Value Space See Appendix A1.2.
Default = "0".
Multiplicity [0..1]
Description The number of the first record to be supplied in the segmented response message.

2.3.18.3 "sort" Query Parameter

The description of the "sort" query parameter is presented in Table 2.3.18.3

Table 2.3.18.3 - The definition of the "sort" query parameter for the "getClassesForTeacher" operation.
Descriptor Definition
Parameter Name sort
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..1]
Description Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter. The sort order should follow the [UNICODE, 16] standard.

2.3.18.4 "orderBy" Query Parameter

The description of the "orderBy" query parameter is presented in Table 2.3.18.4

Table 2.3.18.4 - The definition of the "orderBy" query parameter for the "getClassesForTeacher" operation.
Descriptor Definition
Parameter Name orderBy
Data Type Enumeration
Value Space Enumerated value set of: { asc | desc }
Multiplicity [0..1]
Description The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc). The sort order should follow the [UNICODE, 16] standard.

2.3.18.5 "filter" Query Parameter

The description of the "filter" query parameter is presented in Table 2.3.18.5

Table 2.3.18.5 - The definition of the "filter" query parameter for the "getClassesForTeacher" operation.
Descriptor Definition
Parameter Name filter
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..1]
Description The filtering rules to be applied when identifying the records to be supplied in the response message. The sort order should follow the [UNICODE, 16] standard.

2.3.18.6 "fields" Query Parameter

The description of the "fields" query parameter is presented in Table 2.3.18.6

Table 2.3.18.6 - The definition of the "fields" query parameter for the "getClassesForTeacher" operation.
Descriptor Definition
Parameter Name fields
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..*]
Description To identify the range of fields that should be supplied in the response message.

2.3.19 "getClassesForTerm" Endpoint Query Parameters

2.3.19.1 "limit" Query Parameter

The description of the "limit" query parameter is presented in Table 2.3.19.1

Table 2.3.19.1 - The definition of the "limit" query parameter for the "getClassesForTerm" operation.
Descriptor Definition
Parameter Name limit
Data Type PositiveInteger (Primitive-type)
Value Space See Appendix A1.2.
Default = "100".
Multiplicity [0..1]
Description To define the download segmentation value i.e. the maximum number of records to be contained in the response.

2.3.19.2 "offset" Query Parameter

The description of the "offset" query parameter is presented in Table 2.3.19.2

Table 2.3.19.2 - The definition of the "offset" query parameter for the "getClassesForTerm" operation.
Descriptor Definition
Parameter Name offset
Data Type NonNegativeInteger (Primitive-type)
Value Space See Appendix A1.2.
Default = "0".
Multiplicity [0..1]
Description The number of the first record to be supplied in the segmented response message.

2.3.19.3 "sort" Query Parameter

The description of the "sort" query parameter is presented in Table 2.3.19.3

Table 2.3.19.3 - The definition of the "sort" query parameter for the "getClassesForTerm" operation.
Descriptor Definition
Parameter Name sort
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..1]
Description Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter. The sort order should follow the [UNICODE, 16] standard.

2.3.19.4 "orderBy" Query Parameter

The description of the "orderBy" query parameter is presented in Table 2.3.19.4

Table 2.3.19.4 - The definition of the "orderBy" query parameter for the "getClassesForTerm" operation.
Descriptor Definition
Parameter Name orderBy
Data Type Enumeration
Value Space Enumerated value set of: { asc | desc }
Multiplicity [0..1]
Description The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc). The sort order should follow the [UNICODE, 16] standard.

2.3.19.5 "filter" Query Parameter

The description of the "filter" query parameter is presented in Table 2.3.19.5

Table 2.3.19.5 - The definition of the "filter" query parameter for the "getClassesForTerm" operation.
Descriptor Definition
Parameter Name filter
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..1]
Description The filtering rules to be applied when identifying the records to be supplied in the response message. The sort order should follow the [UNICODE, 16] standard.

2.3.19.6 "fields" Query Parameter

The description of the "fields" query parameter is presented in Table 2.3.19.6

Table 2.3.19.6 - The definition of the "fields" query parameter for the "getClassesForTerm" operation.
Descriptor Definition
Parameter Name fields
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..*]
Description To identify the range of fields that should be supplied in the response message.

2.3.20 "getClassesForUser" Endpoint Query Parameters

2.3.20.1 "limit" Query Parameter

The description of the "limit" query parameter is presented in Table 2.3.20.1

Table 2.3.20.1 - The definition of the "limit" query parameter for the "getClassesForUser" operation.
Descriptor Definition
Parameter Name limit
Data Type PositiveInteger (Primitive-type)
Value Space See Appendix A1.2.
Default = "100".
Multiplicity [0..1]
Description To define the download segmentation value i.e. the maximum number of records to be contained in the response.

2.3.20.2 "offset" Query Parameter

The description of the "offset" query parameter is presented in Table 2.3.20.2

Table 2.3.20.2 - The definition of the "offset" query parameter for the "getClassesForUser" operation.
Descriptor Definition
Parameter Name offset
Data Type NonNegativeInteger (Primitive-type)
Value Space See Appendix A1.2.
Default = "0".
Multiplicity [0..1]
Description The number of the first record to be supplied in the segmented response message.

2.3.20.3 "sort" Query Parameter

The description of the "sort" query parameter is presented in Table 2.3.20.3

Table 2.3.20.3 - The definition of the "sort" query parameter for the "getClassesForUser" operation.
Descriptor Definition
Parameter Name sort
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..1]
Description Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter. The sort order should follow the [UNICODE, 16] standard.

2.3.20.4 "orderBy" Query Parameter

The description of the "orderBy" query parameter is presented in Table 2.3.20.4

Table 2.3.20.4 - The definition of the "orderBy" query parameter for the "getClassesForUser" operation.
Descriptor Definition
Parameter Name orderBy
Data Type Enumeration
Value Space Enumerated value set of: { asc | desc }
Multiplicity [0..1]
Description The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc). The sort order should follow the [UNICODE, 16] standard.

2.3.20.5 "filter" Query Parameter

The description of the "filter" query parameter is presented in Table 2.3.20.5

Table 2.3.20.5 - The definition of the "filter" query parameter for the "getClassesForUser" operation.
Descriptor Definition
Parameter Name filter
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..1]
Description The filtering rules to be applied when identifying the records to be supplied in the response message. The sort order should follow the [UNICODE, 16] standard.

2.3.20.6 "fields" Query Parameter

The description of the "fields" query parameter is presented in Table 2.3.20.6

Table 2.3.20.6 - The definition of the "fields" query parameter for the "getClassesForUser" operation.
Descriptor Definition
Parameter Name fields
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..*]
Description To identify the range of fields that should be supplied in the response message.

2.3.21 "getCourse" Endpoint Query Parameters

2.3.21.1 "fields" Query Parameter

The description of the "fields" query parameter is presented in Table 2.3.21.1

Table 2.3.21.1 - The definition of the "fields" query parameter for the "getCourse" operation.
Descriptor Definition
Parameter Name fields
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..*]
Description To identify the range of fields that should be supplied in the response message.

2.3.22 "getCoursesForSchool" Endpoint Query Parameters

2.3.22.1 "limit" Query Parameter

The description of the "limit" query parameter is presented in Table 2.3.22.1

Table 2.3.22.1 - The definition of the "limit" query parameter for the "getCoursesForSchool" operation.
Descriptor Definition
Parameter Name limit
Data Type PositiveInteger (Primitive-type)
Value Space See Appendix A1.2.
Default = "100".
Multiplicity [0..1]
Description To define the download segmentation value i.e. the maximum number of records to be contained in the response.

2.3.22.2 "offset" Query Parameter

The description of the "offset" query parameter is presented in Table 2.3.22.2

Table 2.3.22.2 - The definition of the "offset" query parameter for the "getCoursesForSchool" operation.
Descriptor Definition
Parameter Name offset
Data Type NonNegativeInteger (Primitive-type)
Value Space See Appendix A1.2.
Default = "0".
Multiplicity [0..1]
Description The number of the first record to be supplied in the segmented response message.

2.3.22.3 "sort" Query Parameter

The description of the "sort" query parameter is presented in Table 2.3.22.3

Table 2.3.22.3 - The definition of the "sort" query parameter for the "getCoursesForSchool" operation.
Descriptor Definition
Parameter Name sort
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..1]
Description Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter. The sort order should follow the [UNICODE, 16] standard.

2.3.22.4 "orderBy" Query Parameter

The description of the "orderBy" query parameter is presented in Table 2.3.22.4

Table 2.3.22.4 - The definition of the "orderBy" query parameter for the "getCoursesForSchool" operation.
Descriptor Definition
Parameter Name orderBy
Data Type Enumeration
Value Space Enumerated value set of: { asc | desc }
Multiplicity [0..1]
Description The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc). The sort order should follow the [UNICODE, 16] standard.

2.3.22.5 "filter" Query Parameter

The description of the "filter" query parameter is presented in Table 2.3.22.5

Table 2.3.22.5 - The definition of the "filter" query parameter for the "getCoursesForSchool" operation.
Descriptor Definition
Parameter Name filter
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..1]
Description The filtering rules to be applied when identifying the records to be supplied in the response message. The sort order should follow the [UNICODE, 16] standard.

2.3.22.6 "fields" Query Parameter

The description of the "fields" query parameter is presented in Table 2.3.22.6

Table 2.3.22.6 - The definition of the "fields" query parameter for the "getCoursesForSchool" operation.
Descriptor Definition
Parameter Name fields
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..*]
Description To identify the range of fields that should be supplied in the response message.

2.3.23 "getDemographics" Endpoint Query Parameters

2.3.23.1 "fields" Query Parameter

The description of the "fields" query parameter is presented in Table 2.3.23.1

Table 2.3.23.1 - The definition of the "fields" query parameter for the "getDemographics" operation.
Descriptor Definition
Parameter Name fields
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..*]
Description To identify the range of fields that should be supplied in the response message.

2.3.24 "getEnrollment" Endpoint Query Parameters

2.3.24.1 "fields" Query Parameter

The description of the "fields" query parameter is presented in Table 2.3.24.1

Table 2.3.24.1 - The definition of the "fields" query parameter for the "getEnrollment" operation.
Descriptor Definition
Parameter Name fields
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..*]
Description To identify the range of fields that should be supplied in the response message.

2.3.25 "getEnrollmentsForClassInSchool" Endpoint Query Parameters

2.3.25.1 "limit" Query Parameter

The description of the "limit" query parameter is presented in Table 2.3.25.1

Table 2.3.25.1 - The definition of the "limit" query parameter for the "getEnrollmentsForClassInSchool" operation.
Descriptor Definition
Parameter Name limit
Data Type PositiveInteger (Primitive-type)
Value Space See Appendix A1.2.
Default = "100".
Multiplicity [0..1]
Description To define the download segmentation value i.e. the maximum number of records to be contained in the response.

2.3.25.2 "offset" Query Parameter

The description of the "offset" query parameter is presented in Table 2.3.25.2

Table 2.3.25.2 - The definition of the "offset" query parameter for the "getEnrollmentsForClassInSchool" operation.
Descriptor Definition
Parameter Name offset
Data Type NonNegativeInteger (Primitive-type)
Value Space See Appendix A1.2.
Default = "0".
Multiplicity [0..1]
Description The number of the first record to be supplied in the segmented response message.

2.3.25.3 "sort" Query Parameter

The description of the "sort" query parameter is presented in Table 2.3.25.3

Table 2.3.25.3 - The definition of the "sort" query parameter for the "getEnrollmentsForClassInSchool" operation.
Descriptor Definition
Parameter Name sort
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..1]
Description Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter. The sort order should follow the [UNICODE, 16] standard.

2.3.25.4 "orderBy" Query Parameter

The description of the "orderBy" query parameter is presented in Table 2.3.25.4

Table 2.3.25.4 - The definition of the "orderBy" query parameter for the "getEnrollmentsForClassInSchool" operation.
Descriptor Definition
Parameter Name orderBy
Data Type Enumeration
Value Space Enumerated value set of: { asc | desc }
Multiplicity [0..1]
Description The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc). The sort order should follow the [UNICODE, 16] standard.

2.3.25.5 "filter" Query Parameter

The description of the "filter" query parameter is presented in Table 2.3.25.5

Table 2.3.25.5 - The definition of the "filter" query parameter for the "getEnrollmentsForClassInSchool" operation.
Descriptor Definition
Parameter Name filter
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..1]
Description The filtering rules to be applied when identifying the records to be supplied in the response message. The sort order should follow the [UNICODE, 16] standard.

2.3.25.6 "fields" Query Parameter

The description of the "fields" query parameter is presented in Table 2.3.25.6

Table 2.3.25.6 - The definition of the "fields" query parameter for the "getEnrollmentsForClassInSchool" operation.
Descriptor Definition
Parameter Name fields
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..*]
Description To identify the range of fields that should be supplied in the response message.

2.3.26 "getEnrollmentsForSchool" Endpoint Query Parameters

2.3.26.1 "limit" Query Parameter

The description of the "limit" query parameter is presented in Table 2.3.26.1

Table 2.3.26.1 - The definition of the "limit" query parameter for the "getEnrollmentsForSchool" operation.
Descriptor Definition
Parameter Name limit
Data Type PositiveInteger (Primitive-type)
Value Space See Appendix A1.2.
Default = "100".
Multiplicity [0..1]
Description To define the download segmentation value i.e. the maximum number of records to be contained in the response.

2.3.26.2 "offset" Query Parameter

The description of the "offset" query parameter is presented in Table 2.3.26.2

Table 2.3.26.2 - The definition of the "offset" query parameter for the "getEnrollmentsForSchool" operation.
Descriptor Definition
Parameter Name offset
Data Type NonNegativeInteger (Primitive-type)
Value Space See Appendix A1.2.
Default = "0".
Multiplicity [0..1]
Description The number of the first record to be supplied in the segmented response message.

2.3.26.3 "sort" Query Parameter

The description of the "sort" query parameter is presented in Table 2.3.26.3

Table 2.3.26.3 - The definition of the "sort" query parameter for the "getEnrollmentsForSchool" operation.
Descriptor Definition
Parameter Name sort
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..1]
Description Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter. The sort order should follow the [UNICODE, 16] standard.

2.3.26.4 "orderBy" Query Parameter

The description of the "orderBy" query parameter is presented in Table 2.3.26.4

Table 2.3.26.4 - The definition of the "orderBy" query parameter for the "getEnrollmentsForSchool" operation.
Descriptor Definition
Parameter Name orderBy
Data Type Enumeration
Value Space Enumerated value set of: { asc | desc }
Multiplicity [0..1]
Description The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc). The sort order should follow the [UNICODE, 16] standard.

2.3.26.5 "filter" Query Parameter

The description of the "filter" query parameter is presented in Table 2.3.26.5

Table 2.3.26.5 - The definition of the "filter" query parameter for the "getEnrollmentsForSchool" operation.
Descriptor Definition
Parameter Name filter
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..1]
Description The filtering rules to be applied when identifying the records to be supplied in the response message. The sort order should follow the [UNICODE, 16] standard.

2.3.26.6 "fields" Query Parameter

The description of the "fields" query parameter is presented in Table 2.3.26.6

Table 2.3.26.6 - The definition of the "fields" query parameter for the "getEnrollmentsForSchool" operation.
Descriptor Definition
Parameter Name fields
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..*]
Description To identify the range of fields that should be supplied in the response message.

2.3.27 "getGradingPeriod" Endpoint Query Parameters

2.3.27.1 "fields" Query Parameter

The description of the "fields" query parameter is presented in Table 2.3.27.1

Table 2.3.27.1 - The definition of the "fields" query parameter for the "getGradingPeriod" operation.
Descriptor Definition
Parameter Name fields
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..*]
Description To identify the range of fields that should be supplied in the response message.

2.3.28 "getGradingPeriodsForTerm" Endpoint Query Parameters

2.3.28.1 "limit" Query Parameter

The description of the "limit" query parameter is presented in Table 2.3.28.1

Table 2.3.28.1 - The definition of the "limit" query parameter for the "getGradingPeriodsForTerm" operation.
Descriptor Definition
Parameter Name limit
Data Type PositiveInteger (Primitive-type)
Value Space See Appendix A1.2.
Default = "100".
Multiplicity [0..1]
Description To define the download segmentation value i.e. the maximum number of records to be contained in the response.

2.3.28.2 "offset" Query Parameter

The description of the "offset" query parameter is presented in Table 2.3.28.2

Table 2.3.28.2 - The definition of the "offset" query parameter for the "getGradingPeriodsForTerm" operation.
Descriptor Definition
Parameter Name offset
Data Type NonNegativeInteger (Primitive-type)
Value Space See Appendix A1.2.
Default = "0".
Multiplicity [0..1]
Description The number of the first record to be supplied in the segmented response message.

2.3.28.3 "sort" Query Parameter

The description of the "sort" query parameter is presented in Table 2.3.28.3

Table 2.3.28.3 - The definition of the "sort" query parameter for the "getGradingPeriodsForTerm" operation.
Descriptor Definition
Parameter Name sort
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..1]
Description Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter. The sort order should follow the [UNICODE, 16] standard.

2.3.28.4 "orderBy" Query Parameter

The description of the "orderBy" query parameter is presented in Table 2.3.28.4

Table 2.3.28.4 - The definition of the "orderBy" query parameter for the "getGradingPeriodsForTerm" operation.
Descriptor Definition
Parameter Name orderBy
Data Type Enumeration
Value Space Enumerated value set of: { asc | desc }
Multiplicity [0..1]
Description The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc). The sort order should follow the [UNICODE, 16] standard.

2.3.28.5 "filter" Query Parameter

The description of the "filter" query parameter is presented in Table 2.3.28.5

Table 2.3.28.5 - The definition of the "filter" query parameter for the "getGradingPeriodsForTerm" operation.
Descriptor Definition
Parameter Name filter
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..1]
Description The filtering rules to be applied when identifying the records to be supplied in the response message. The sort order should follow the [UNICODE, 16] standard.

2.3.28.6 "fields" Query Parameter

The description of the "fields" query parameter is presented in Table 2.3.28.6

Table 2.3.28.6 - The definition of the "fields" query parameter for the "getGradingPeriodsForTerm" operation.
Descriptor Definition
Parameter Name fields
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..*]
Description To identify the range of fields that should be supplied in the response message.

2.3.29 "getOrg" Endpoint Query Parameters

2.3.29.1 "fields" Query Parameter

The description of the "fields" query parameter is presented in Table 2.3.29.1

Table 2.3.29.1 - The definition of the "fields" query parameter for the "getOrg" operation.
Descriptor Definition
Parameter Name fields
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..*]
Description To identify the range of fields that should be supplied in the response message.

2.3.30 "getSchool" Endpoint Query Parameters

2.3.30.1 "fields" Query Parameter

The description of the "fields" query parameter is presented in Table 2.3.30.1

Table 2.3.30.1 - The definition of the "fields" query parameter for the "getSchool" operation.
Descriptor Definition
Parameter Name fields
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..*]
Description To identify the range of fields that should be supplied in the response message.

2.3.31 "getStudent" Endpoint Query Parameters

2.3.31.1 "fields" Query Parameter

The description of the "fields" query parameter is presented in Table 2.3.31.1

Table 2.3.31.1 - The definition of the "fields" query parameter for the "getStudent" operation.
Descriptor Definition
Parameter Name fields
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..*]
Description To identify the range of fields that should be supplied in the response message.

2.3.32 "getStudentsForClass" Endpoint Query Parameters

2.3.32.1 "limit" Query Parameter

The description of the "limit" query parameter is presented in Table 2.3.32.1

Table 2.3.32.1 - The definition of the "limit" query parameter for the "getStudentsForClass" operation.
Descriptor Definition
Parameter Name limit
Data Type PositiveInteger (Primitive-type)
Value Space See Appendix A1.2.
Default = "100".
Multiplicity [0..1]
Description To define the download segmentation value i.e. the maximum number of records to be contained in the response.

2.3.32.2 "offset" Query Parameter

The description of the "offset" query parameter is presented in Table 2.3.32.2

Table 2.3.32.2 - The definition of the "offset" query parameter for the "getStudentsForClass" operation.
Descriptor Definition
Parameter Name offset
Data Type NonNegativeInteger (Primitive-type)
Value Space See Appendix A1.2.
Default = "0".
Multiplicity [0..1]
Description The number of the first record to be supplied in the segmented response message.

2.3.32.3 "sort" Query Parameter

The description of the "sort" query parameter is presented in Table 2.3.32.3

Table 2.3.32.3 - The definition of the "sort" query parameter for the "getStudentsForClass" operation.
Descriptor Definition
Parameter Name sort
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..1]
Description Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter. The sort order should follow the [UNICODE, 16] standard.

2.3.32.4 "orderBy" Query Parameter

The description of the "orderBy" query parameter is presented in Table 2.3.32.4

Table 2.3.32.4 - The definition of the "orderBy" query parameter for the "getStudentsForClass" operation.
Descriptor Definition
Parameter Name orderBy
Data Type Enumeration
Value Space Enumerated value set of: { asc | desc }
Multiplicity [0..1]
Description The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc). The sort order should follow the [UNICODE, 16] standard.

2.3.32.5 "filter" Query Parameter

The description of the "filter" query parameter is presented in Table 2.3.32.5

Table 2.3.32.5 - The definition of the "filter" query parameter for the "getStudentsForClass" operation.
Descriptor Definition
Parameter Name filter
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..1]
Description The filtering rules to be applied when identifying the records to be supplied in the response message. The sort order should follow the [UNICODE, 16] standard.

2.3.32.6 "fields" Query Parameter

The description of the "fields" query parameter is presented in Table 2.3.32.6

Table 2.3.32.6 - The definition of the "fields" query parameter for the "getStudentsForClass" operation.
Descriptor Definition
Parameter Name fields
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..*]
Description To identify the range of fields that should be supplied in the response message.

2.3.33 "getStudentsForClassInSchool" Endpoint Query Parameters

2.3.33.1 "limit" Query Parameter

The description of the "limit" query parameter is presented in Table 2.3.33.1

Table 2.3.33.1 - The definition of the "limit" query parameter for the "getStudentsForClassInSchool" operation.
Descriptor Definition
Parameter Name limit
Data Type PositiveInteger (Primitive-type)
Value Space See Appendix A1.2.
Default = "100".
Multiplicity [0..1]
Description To define the download segmentation value i.e. the maximum number of records to be contained in the response.

2.3.33.2 "offset" Query Parameter

The description of the "offset" query parameter is presented in Table 2.3.33.2

Table 2.3.33.2 - The definition of the "offset" query parameter for the "getStudentsForClassInSchool" operation.
Descriptor Definition
Parameter Name offset
Data Type NonNegativeInteger (Primitive-type)
Value Space See Appendix A1.2.
Default = "0".
Multiplicity [0..1]
Description The number of the first record to be supplied in the segmented response message.

2.3.33.3 "sort" Query Parameter

The description of the "sort" query parameter is presented in Table 2.3.33.3

Table 2.3.33.3 - The definition of the "sort" query parameter for the "getStudentsForClassInSchool" operation.
Descriptor Definition
Parameter Name sort
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..1]
Description Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter. The sort order should follow the [UNICODE, 16] standard.

2.3.33.4 "orderBy" Query Parameter

The description of the "orderBy" query parameter is presented in Table 2.3.33.4

Table 2.3.33.4 - The definition of the "orderBy" query parameter for the "getStudentsForClassInSchool" operation.
Descriptor Definition
Parameter Name orderBy
Data Type Enumeration
Value Space Enumerated value set of: { asc | desc }
Multiplicity [0..1]
Description The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc). The sort order should follow the [UNICODE, 16] standard.

2.3.33.5 "filter" Query Parameter

The description of the "filter" query parameter is presented in Table 2.3.33.5

Table 2.3.33.5 - The definition of the "filter" query parameter for the "getStudentsForClassInSchool" operation.
Descriptor Definition
Parameter Name filter
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..1]
Description The filtering rules to be applied when identifying the records to be supplied in the response message. The sort order should follow the [UNICODE, 16] standard.

2.3.33.6 "fields" Query Parameter

The description of the "fields" query parameter is presented in Table 2.3.33.6

Table 2.3.33.6 - The definition of the "fields" query parameter for the "getStudentsForClassInSchool" operation.
Descriptor Definition
Parameter Name fields
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..*]
Description To identify the range of fields that should be supplied in the response message.

2.3.34 "getStudentsForSchool" Endpoint Query Parameters

2.3.34.1 "limit" Query Parameter

The description of the "limit" query parameter is presented in Table 2.3.34.1

Table 2.3.34.1 - The definition of the "limit" query parameter for the "getStudentsForSchool" operation.
Descriptor Definition
Parameter Name limit
Data Type PositiveInteger (Primitive-type)
Value Space See Appendix A1.2.
Default = "100".
Multiplicity [0..1]
Description To define the download segmentation value i.e. the maximum number of records to be contained in the response.

2.3.34.2 "offset" Query Parameter

The description of the "offset" query parameter is presented in Table 2.3.34.2

Table 2.3.34.2 - The definition of the "offset" query parameter for the "getStudentsForSchool" operation.
Descriptor Definition
Parameter Name offset
Data Type NonNegativeInteger (Primitive-type)
Value Space See Appendix A1.2.
Default = "0".
Multiplicity [0..1]
Description The number of the first record to be supplied in the segmented response message.

2.3.34.3 "sort" Query Parameter

The description of the "sort" query parameter is presented in Table 2.3.34.3

Table 2.3.34.3 - The definition of the "sort" query parameter for the "getStudentsForSchool" operation.
Descriptor Definition
Parameter Name sort
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..1]
Description Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter. The sort order should follow the [UNICODE, 16] standard.

2.3.34.4 "orderBy" Query Parameter

The description of the "orderBy" query parameter is presented in Table 2.3.34.4

Table 2.3.34.4 - The definition of the "orderBy" query parameter for the "getStudentsForSchool" operation.
Descriptor Definition
Parameter Name orderBy
Data Type Enumeration
Value Space Enumerated value set of: { asc | desc }
Multiplicity [0..1]
Description The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc). The sort order should follow the [UNICODE, 16] standard.

2.3.34.5 "filter" Query Parameter

The description of the "filter" query parameter is presented in Table 2.3.34.5

Table 2.3.34.5 - The definition of the "filter" query parameter for the "getStudentsForSchool" operation.
Descriptor Definition
Parameter Name filter
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..1]
Description The filtering rules to be applied when identifying the records to be supplied in the response message. The sort order should follow the [UNICODE, 16] standard.

2.3.34.6 "fields" Query Parameter

The description of the "fields" query parameter is presented in Table 2.3.34.6

Table 2.3.34.6 - The definition of the "fields" query parameter for the "getStudentsForSchool" operation.
Descriptor Definition
Parameter Name fields
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..*]
Description To identify the range of fields that should be supplied in the response message.

2.3.35 "getTeacher" Endpoint Query Parameters

2.3.35.1 "fields" Query Parameter

The description of the "fields" query parameter is presented in Table 2.3.35.1

Table 2.3.35.1 - The definition of the "fields" query parameter for the "getTeacher" operation.
Descriptor Definition
Parameter Name fields
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..*]
Description To identify the range of fields that should be supplied in the response message.

2.3.36 "getTeachersForClass" Endpoint Query Parameters

2.3.36.1 "limit" Query Parameter

The description of the "limit" query parameter is presented in Table 2.3.36.1

Table 2.3.36.1 - The definition of the "limit" query parameter for the "getTeachersForClass" operation.
Descriptor Definition
Parameter Name limit
Data Type PositiveInteger (Primitive-type)
Value Space See Appendix A1.2.
Default = "100".
Multiplicity [0..1]
Description To define the download segmentation value i.e. the maximum number of records to be contained in the response.

2.3.36.2 "offset" Query Parameter

The description of the "offset" query parameter is presented in Table 2.3.36.2

Table 2.3.36.2 - The definition of the "offset" query parameter for the "getTeachersForClass" operation.
Descriptor Definition
Parameter Name offset
Data Type NonNegativeInteger (Primitive-type)
Value Space See Appendix A1.2.
Default = "0".
Multiplicity [0..1]
Description The number of the first record to be supplied in the segmented response message.

2.3.36.3 "sort" Query Parameter

The description of the "sort" query parameter is presented in Table 2.3.36.3

Table 2.3.36.3 - The definition of the "sort" query parameter for the "getTeachersForClass" operation.
Descriptor Definition
Parameter Name sort
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..1]
Description Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter. The sort order should follow the [UNICODE, 16] standard.

2.3.36.4 "orderBy" Query Parameter

The description of the "orderBy" query parameter is presented in Table 2.3.36.4

Table 2.3.36.4 - The definition of the "orderBy" query parameter for the "getTeachersForClass" operation.
Descriptor Definition
Parameter Name orderBy
Data Type Enumeration
Value Space Enumerated value set of: { asc | desc }
Multiplicity [0..1]
Description The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc). The sort order should follow the [UNICODE, 16] standard.

2.3.36.5 "filter" Query Parameter

The description of the "filter" query parameter is presented in Table 2.3.36.5

Table 2.3.36.5 - The definition of the "filter" query parameter for the "getTeachersForClass" operation.
Descriptor Definition
Parameter Name filter
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..1]
Description The filtering rules to be applied when identifying the records to be supplied in the response message. The sort order should follow the [UNICODE, 16] standard.

2.3.36.6 "fields" Query Parameter

The description of the "fields" query parameter is presented in Table 2.3.36.6

Table 2.3.36.6 - The definition of the "fields" query parameter for the "getTeachersForClass" operation.
Descriptor Definition
Parameter Name fields
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..*]
Description To identify the range of fields that should be supplied in the response message.

2.3.37 "getTeachersForClassInSchool" Endpoint Query Parameters

2.3.37.1 "limit" Query Parameter

The description of the "limit" query parameter is presented in Table 2.3.37.1

Table 2.3.37.1 - The definition of the "limit" query parameter for the "getTeachersForClassInSchool" operation.
Descriptor Definition
Parameter Name limit
Data Type PositiveInteger (Primitive-type)
Value Space See Appendix A1.2.
Default = "100".
Multiplicity [0..1]
Description To define the download segmentation value i.e. the maximum number of records to be contained in the response.

2.3.37.2 "offset" Query Parameter

The description of the "offset" query parameter is presented in Table 2.3.37.2

Table 2.3.37.2 - The definition of the "offset" query parameter for the "getTeachersForClassInSchool" operation.
Descriptor Definition
Parameter Name offset
Data Type NonNegativeInteger (Primitive-type)
Value Space See Appendix A1.2.
Default = "0".
Multiplicity [0..1]
Description The number of the first record to be supplied in the segmented response message.

2.3.37.3 "sort" Query Parameter

The description of the "sort" query parameter is presented in Table 2.3.37.3

Table 2.3.37.3 - The definition of the "sort" query parameter for the "getTeachersForClassInSchool" operation.
Descriptor Definition
Parameter Name sort
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..1]
Description Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter. The sort order should follow the [UNICODE, 16] standard.

2.3.37.4 "orderBy" Query Parameter

The description of the "orderBy" query parameter is presented in Table 2.3.37.4

Table 2.3.37.4 - The definition of the "orderBy" query parameter for the "getTeachersForClassInSchool" operation.
Descriptor Definition
Parameter Name orderBy
Data Type Enumeration
Value Space Enumerated value set of: { asc | desc }
Multiplicity [0..1]
Description The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc). The sort order should follow the [UNICODE, 16] standard.

2.3.37.5 "filter" Query Parameter

The description of the "filter" query parameter is presented in Table 2.3.37.5

Table 2.3.37.5 - The definition of the "filter" query parameter for the "getTeachersForClassInSchool" operation.
Descriptor Definition
Parameter Name filter
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..1]
Description The filtering rules to be applied when identifying the records to be supplied in the response message. The sort order should follow the [UNICODE, 16] standard.

2.3.37.6 "fields" Query Parameter

The description of the "fields" query parameter is presented in Table 2.3.37.6

Table 2.3.37.6 - The definition of the "fields" query parameter for the "getTeachersForClassInSchool" operation.
Descriptor Definition
Parameter Name fields
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..*]
Description To identify the range of fields that should be supplied in the response message.

2.3.38 "getTeachersForSchool" Endpoint Query Parameters

2.3.38.1 "limit" Query Parameter

The description of the "limit" query parameter is presented in Table 2.3.38.1

Table 2.3.38.1 - The definition of the "limit" query parameter for the "getTeachersForSchool" operation.
Descriptor Definition
Parameter Name limit
Data Type PositiveInteger (Primitive-type)
Value Space See Appendix A1.2.
Default = "100".
Multiplicity [0..1]
Description To define the download segmentation value i.e. the maximum number of records to be contained in the response.

2.3.38.2 "offset" Query Parameter

The description of the "offset" query parameter is presented in Table 2.3.38.2

Table 2.3.38.2 - The definition of the "offset" query parameter for the "getTeachersForSchool" operation.
Descriptor Definition
Parameter Name offset
Data Type NonNegativeInteger (Primitive-type)
Value Space See Appendix A1.2.
Default = "0".
Multiplicity [0..1]
Description The number of the first record to be supplied in the segmented response message.

2.3.38.3 "sort" Query Parameter

The description of the "sort" query parameter is presented in Table 2.3.38.3

Table 2.3.38.3 - The definition of the "sort" query parameter for the "getTeachersForSchool" operation.
Descriptor Definition
Parameter Name sort
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..1]
Description Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter. The sort order should follow the [UNICODE, 16] standard.

2.3.38.4 "orderBy" Query Parameter

The description of the "orderBy" query parameter is presented in Table 2.3.38.4

Table 2.3.38.4 - The definition of the "orderBy" query parameter for the "getTeachersForSchool" operation.
Descriptor Definition
Parameter Name orderBy
Data Type Enumeration
Value Space Enumerated value set of: { asc | desc }
Multiplicity [0..1]
Description The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc). The sort order should follow the [UNICODE, 16] standard.

2.3.38.5 "filter" Query Parameter

The description of the "filter" query parameter is presented in Table 2.3.38.5

Table 2.3.38.5 - The definition of the "filter" query parameter for the "getTeachersForSchool" operation.
Descriptor Definition
Parameter Name filter
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..1]
Description The filtering rules to be applied when identifying the records to be supplied in the response message. The sort order should follow the [UNICODE, 16] standard.

2.3.38.6 "fields" Query Parameter

The description of the "fields" query parameter is presented in Table 2.3.38.6

Table 2.3.38.6 - The definition of the "fields" query parameter for the "getTeachersForSchool" operation.
Descriptor Definition
Parameter Name fields
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..*]
Description To identify the range of fields that should be supplied in the response message.

2.3.39 "getTerm" Endpoint Query Parameters

2.3.39.1 "fields" Query Parameter

The description of the "fields" query parameter is presented in Table 2.3.39.1

Table 2.3.39.1 - The definition of the "fields" query parameter for the "getTerm" operation.
Descriptor Definition
Parameter Name fields
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..*]
Description To identify the range of fields that should be supplied in the response message.

2.3.40 "getTermsForSchool" Endpoint Query Parameters

2.3.40.1 "limit" Query Parameter

The description of the "limit" query parameter is presented in Table 2.3.40.1

Table 2.3.40.1 - The definition of the "limit" query parameter for the "getTermsForSchool" operation.
Descriptor Definition
Parameter Name limit
Data Type PositiveInteger (Primitive-type)
Value Space See Appendix A1.2.
Default = "100".
Multiplicity [0..1]
Description To define the download segmentation value i.e. the maximum number of records to be contained in the response.

2.3.40.2 "offset" Query Parameter

The description of the "offset" query parameter is presented in Table 2.3.40.2

Table 2.3.40.2 - The definition of the "offset" query parameter for the "getTermsForSchool" operation.
Descriptor Definition
Parameter Name offset
Data Type NonNegativeInteger (Primitive-type)
Value Space See Appendix A1.2.
Default = "0".
Multiplicity [0..1]
Description The number of the first record to be supplied in the segmented response message.

2.3.40.3 "sort" Query Parameter

The description of the "sort" query parameter is presented in Table 2.3.40.3

Table 2.3.40.3 - The definition of the "sort" query parameter for the "getTermsForSchool" operation.
Descriptor Definition
Parameter Name sort
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..1]
Description Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter. The sort order should follow the [UNICODE, 16] standard.

2.3.40.4 "orderBy" Query Parameter

The description of the "orderBy" query parameter is presented in Table 2.3.40.4

Table 2.3.40.4 - The definition of the "orderBy" query parameter for the "getTermsForSchool" operation.
Descriptor Definition
Parameter Name orderBy
Data Type Enumeration
Value Space Enumerated value set of: { asc | desc }
Multiplicity [0..1]
Description The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc). The sort order should follow the [UNICODE, 16] standard.

2.3.40.5 "filter" Query Parameter

The description of the "filter" query parameter is presented in Table 2.3.40.5

Table 2.3.40.5 - The definition of the "filter" query parameter for the "getTermsForSchool" operation.
Descriptor Definition
Parameter Name filter
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..1]
Description The filtering rules to be applied when identifying the records to be supplied in the response message. The sort order should follow the [UNICODE, 16] standard.

2.3.40.6 "fields" Query Parameter

The description of the "fields" query parameter is presented in Table 2.3.40.6

Table 2.3.40.6 - The definition of the "fields" query parameter for the "getTermsForSchool" operation.
Descriptor Definition
Parameter Name fields
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..*]
Description To identify the range of fields that should be supplied in the response message.

2.3.41 "getUser" Endpoint Query Parameters

2.3.41.1 "fields" Query Parameter

The description of the "fields" query parameter is presented in Table 2.3.41.1

Table 2.3.41.1 - The definition of the "fields" query parameter for the "getUser" operation.
Descriptor Definition
Parameter Name fields
Data Type String (Primitive-type)
Value Space See Appendix A1.2.
Multiplicity [0..*]
Description To identify the range of fields that should be supplied in the response message.

2.4 HTTP Code Handling

A service provider will either return a data payload or a payload that indicates the cause of the failure. The list of HTTP Codes and handling for each endpoint is shown in Table 2.4. The syntax and semantics for this tabular description are described in Appendix A1.3.

Table 2.4 - The List of HTTP Codes and Handling for each Endpoint.
REST Endpoint HTTP Verb HTTP Codes and Handling
/academicSessions GET
  • 200 - the request was successfully completed and a collection has been returned. This would be accompanied by the 'codeMajor/severity' values of 'success/status' and for a REST binding a HTTP code of '200'. The payload is defined by the structure AcademicSessionSetDType.
  • 400 - either an invalid selection field or invalid filter selection was supplied and data filtering on the selection criteria was not possible i.e. 'invalid_selection_field' or 'invalid_filter_field' respectively. This is accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 401 - the request was not correctly authorised i.e. 'unauthorisedrequest'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 403 - this is used to indicate that the server can be reached and process the request but refuses to take any further action i.e. 'forbidden'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 422 - this error condition may occur if a JSON request body contains well-formed (i.e. syntactically correct), but semantically erroneous, JSON instructions. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 429 - the server is receiving too many requests i.e. 'server_busy'. Retry at a later time. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 500 - this code should be used only if there is catastrophic error and there is not a more appropriate code i.e. 'internal_server_error'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
/academicSessions/{sourcedId} GET
  • 200 - the request was successfully completed and a record has been returned. This would be accompanied by the 'codeMajor/severity' values of 'success/status' and for a REST binding a HTTP code of '200'. The payload is defined by the structure SingleAcademicSessionDType.
  • 400 - either an invalid selection field or invalid filter selection was supplied and data filtering on the selection criteria was not possible i.e. 'invalid_selection_field' or 'invalid_filter_field' respectively. This is accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 401 - the request was not correctly authorised i.e. 'unauthorisedrequest'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 403 - this is used to indicate that the server can be reached and process the request but refuses to take any further action i.e. 'forbidden'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 404 - either the supplied identifier is unknown in the Service Provider and so the object could not be changed or an invalid GUID has been supplied. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The statement 'Unknown Object' should also be presented. The payload is defined by the structure imsx_StatusInfoDType.
  • 422 - this error condition may occur if a JSON request body contains well-formed (i.e. syntactically correct), but semantically erroneous, JSON instructions. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 429 - the server is receiving too many requests i.e. 'server_busy'. Retry at a later time. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 500 - this code should be used only if there is catastrophic error and there is not a more appropriate code i.e. 'internal_server_error'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
/classes GET
  • 200 - the request was successfully completed and a collection has been returned. This would be accompanied by the 'codeMajor/severity' values of 'success/status' and for a REST binding a HTTP code of '200'. The payload is defined by the structure ClassSetDType.
  • 400 - either an invalid selection field or invalid filter selection was supplied and data filtering on the selection criteria was not possible i.e. 'invalid_selection_field' or 'invalid_filter_field' respectively. This is accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 401 - the request was not correctly authorised i.e. 'unauthorisedrequest'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 403 - this is used to indicate that the server can be reached and process the request but refuses to take any further action i.e. 'forbidden'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 422 - this error condition may occur if a JSON request body contains well-formed (i.e. syntactically correct), but semantically erroneous, JSON instructions. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 429 - the server is receiving too many requests i.e. 'server_busy'. Retry at a later time. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 500 - this code should be used only if there is catastrophic error and there is not a more appropriate code i.e. 'internal_server_error'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
/classes/{sourcedId} GET
  • 200 - the request was successfully completed and a record has been returned. This would be accompanied by the 'codeMajor/severity' values of 'success/status' and for a REST binding a HTTP code of '200'. The payload is defined by the structure SingleClassDType.
  • 400 - either an invalid selection field or invalid filter selection was supplied and data filtering on the selection criteria was not possible i.e. 'invalid_selection_field' or 'invalid_filter_field' respectively. This is accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 401 - the request was not correctly authorised i.e. 'unauthorisedrequest'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 403 - this is used to indicate that the server can be reached and process the request but refuses to take any further action i.e. 'forbidden'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 404 - either the supplied identifier is unknown in the Service Provider and so the object could not be changed or an invalid GUID has been supplied. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The statement 'Unknown Object' should also be presented. The payload is defined by the structure imsx_StatusInfoDType.
  • 422 - this error condition may occur if a JSON request body contains well-formed (i.e. syntactically correct), but semantically erroneous, JSON instructions. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 429 - the server is receiving too many requests i.e. 'server_busy'. Retry at a later time. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 500 - this code should be used only if there is catastrophic error and there is not a more appropriate code i.e. 'internal_server_error'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
/classes/{classSourcedId}/students GET
  • 200 - the request was successfully completed and a collection has been returned. This would be accompanied by the 'codeMajor/severity' values of 'success/status' and for a REST binding a HTTP code of '200'. The payload is defined by the structure UserSetDType.
  • 400 - either an invalid selection field or invalid filter selection was supplied and data filtering on the selection criteria was not possible i.e. 'invalid_selection_field' or 'invalid_filter_field' respectively. This is accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 401 - the request was not correctly authorised i.e. 'unauthorisedrequest'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 403 - this is used to indicate that the server can be reached and process the request but refuses to take any further action i.e. 'forbidden'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 422 - this error condition may occur if a JSON request body contains well-formed (i.e. syntactically correct), but semantically erroneous, JSON instructions. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 429 - the server is receiving too many requests i.e. 'server_busy'. Retry at a later time. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 500 - this code should be used only if there is catastrophic error and there is not a more appropriate code i.e. 'internal_server_error'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
/classes/{classSourcedId}/teachers GET
  • 200 - the request was successfully completed and a collection has been returned. This would be accompanied by the 'codeMajor/severity' values of 'success/status' and for a REST binding a HTTP code of '200'. The payload is defined by the structure UserSetDType.
  • 400 - either an invalid selection field or invalid filter selection was supplied and data filtering on the selection criteria was not possible i.e. 'invalid_selection_field' or 'invalid_filter_field' respectively. This is accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 401 - the request was not correctly authorised i.e. 'unauthorisedrequest'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 403 - this is used to indicate that the server can be reached and process the request but refuses to take any further action i.e. 'forbidden'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 422 - this error condition may occur if a JSON request body contains well-formed (i.e. syntactically correct), but semantically erroneous, JSON instructions. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 429 - the server is receiving too many requests i.e. 'server_busy'. Retry at a later time. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 500 - this code should be used only if there is catastrophic error and there is not a more appropriate code i.e. 'internal_server_error'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
/courses GET
  • 200 - the request was successfully completed and a collection has been returned. This would be accompanied by the 'codeMajor/severity' values of 'success/status' and for a REST binding a HTTP code of '200'. The payload is defined by the structure CourseSetDType.
  • 400 - either an invalid selection field or invalid filter selection was supplied and data filtering on the selection criteria was not possible i.e. 'invalid_selection_field' or 'invalid_filter_field' respectively. This is accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 401 - the request was not correctly authorised i.e. 'unauthorisedrequest'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 403 - this is used to indicate that the server can be reached and process the request but refuses to take any further action i.e. 'forbidden'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 422 - this error condition may occur if a JSON request body contains well-formed (i.e. syntactically correct), but semantically erroneous, JSON instructions. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 429 - the server is receiving too many requests i.e. 'server_busy'. Retry at a later time. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 500 - this code should be used only if there is catastrophic error and there is not a more appropriate code i.e. 'internal_server_error'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
/courses/{sourcedId} GET
  • 200 - the request was successfully completed and a record has been returned. This would be accompanied by the 'codeMajor/severity' values of 'success/status' and for a REST binding a HTTP code of '200'. The payload is defined by the structure SingleCourseDType.
  • 400 - either an invalid selection field or invalid filter selection was supplied and data filtering on the selection criteria was not possible i.e. 'invalid_selection_field' or 'invalid_filter_field' respectively. This is accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 401 - the request was not correctly authorised i.e. 'unauthorisedrequest'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 403 - this is used to indicate that the server can be reached and process the request but refuses to take any further action i.e. 'forbidden'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 404 - either the supplied identifier is unknown in the Service Provider and so the object could not be changed or an invalid GUID has been supplied. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The statement 'Unknown Object' should also be presented. The payload is defined by the structure imsx_StatusInfoDType.
  • 422 - this error condition may occur if a JSON request body contains well-formed (i.e. syntactically correct), but semantically erroneous, JSON instructions. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 429 - the server is receiving too many requests i.e. 'server_busy'. Retry at a later time. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 500 - this code should be used only if there is catastrophic error and there is not a more appropriate code i.e. 'internal_server_error'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
/courses/{courseSourcedId}/classes GET
  • 200 - the request was successfully completed and a collection has been returned. This would be accompanied by the 'codeMajor/severity' values of 'success/status' and for a REST binding a HTTP code of '200'. The payload is defined by the structure ClassSetDType.
  • 400 - either an invalid selection field or invalid filter selection was supplied and data filtering on the selection criteria was not possible i.e. 'invalid_selection_field' or 'invalid_filter_field' respectively. This is accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 401 - the request was not correctly authorised i.e. 'unauthorisedrequest'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 403 - this is used to indicate that the server can be reached and process the request but refuses to take any further action i.e. 'forbidden'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 422 - this error condition may occur if a JSON request body contains well-formed (i.e. syntactically correct), but semantically erroneous, JSON instructions. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 429 - the server is receiving too many requests i.e. 'server_busy'. Retry at a later time. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 500 - this code should be used only if there is catastrophic error and there is not a more appropriate code i.e. 'internal_server_error'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
/demographics GET
  • 200 - the request was successfully completed and a collection has been returned. This would be accompanied by the 'codeMajor/severity' values of 'success/status' and for a REST binding a HTTP code of '200'. The payload is defined by the structure DemographicsSetDType.
  • 400 - either an invalid selection field or invalid filter selection was supplied and data filtering on the selection criteria was not possible i.e. 'invalid_selection_field' or 'invalid_filter_field' respectively. This is accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 401 - the request was not correctly authorised i.e. 'unauthorisedrequest'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 403 - this is used to indicate that the server can be reached and process the request but refuses to take any further action i.e. 'forbidden'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 422 - this error condition may occur if a JSON request body contains well-formed (i.e. syntactically correct), but semantically erroneous, JSON instructions. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 429 - the server is receiving too many requests i.e. 'server_busy'. Retry at a later time. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 500 - this code should be used only if there is catastrophic error and there is not a more appropriate code i.e. 'internal_server_error'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
/demographics/{sourcedId} GET
  • 200 - the request was successfully completed and a record has been returned. This would be accompanied by the 'codeMajor/severity' values of 'success/status' and for a REST binding a HTTP code of '200'. The payload is defined by the structure SingleDemographicsDType.
  • 400 - either an invalid selection field or invalid filter selection was supplied and data filtering on the selection criteria was not possible i.e. 'invalid_selection_field' or 'invalid_filter_field' respectively. This is accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 401 - the request was not correctly authorised i.e. 'unauthorisedrequest'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 403 - this is used to indicate that the server can be reached and process the request but refuses to take any further action i.e. 'forbidden'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 404 - either the supplied identifier is unknown in the Service Provider and so the object could not be changed or an invalid GUID has been supplied. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The statement 'Unknown Object' should also be presented. The payload is defined by the structure imsx_StatusInfoDType.
  • 422 - this error condition may occur if a JSON request body contains well-formed (i.e. syntactically correct), but semantically erroneous, JSON instructions. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 429 - the server is receiving too many requests i.e. 'server_busy'. Retry at a later time. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 500 - this code should be used only if there is catastrophic error and there is not a more appropriate code i.e. 'internal_server_error'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
/enrollments GET
  • 200 - the request was successfully completed and a collection has been returned. This would be accompanied by the 'codeMajor/severity' values of 'success/status' and for a REST binding a HTTP code of '200'. The payload is defined by the structure EnrollmentSetDType.
  • 400 - either an invalid selection field or invalid filter selection was supplied and data filtering on the selection criteria was not possible i.e. 'invalid_selection_field' or 'invalid_filter_field' respectively. This is accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 401 - the request was not correctly authorised i.e. 'unauthorisedrequest'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 403 - this is used to indicate that the server can be reached and process the request but refuses to take any further action i.e. 'forbidden'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 422 - this error condition may occur if a JSON request body contains well-formed (i.e. syntactically correct), but semantically erroneous, JSON instructions. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 429 - the server is receiving too many requests i.e. 'server_busy'. Retry at a later time. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 500 - this code should be used only if there is catastrophic error and there is not a more appropriate code i.e. 'internal_server_error'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
/enrollments/{sourcedId} GET
  • 200 - the request was successfully completed and a record has been returned. This would be accompanied by the 'codeMajor/severity' values of 'success/status' and for a REST binding a HTTP code of '200'. The payload is defined by the structure SingleEnrollmentDType.
  • 400 - either an invalid selection field or invalid filter selection was supplied and data filtering on the selection criteria was not possible i.e. 'invalid_selection_field' or 'invalid_filter_field' respectively. This is accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 401 - the request was not correctly authorised i.e. 'unauthorisedrequest'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 403 - this is used to indicate that the server can be reached and process the request but refuses to take any further action i.e. 'forbidden'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 404 - either the supplied identifier is unknown in the Service Provider and so the object could not be changed or an invalid GUID has been supplied. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The statement 'Unknown Object' should also be presented. The payload is defined by the structure imsx_StatusInfoDType.
  • 422 - this error condition may occur if a JSON request body contains well-formed (i.e. syntactically correct), but semantically erroneous, JSON instructions. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 429 - the server is receiving too many requests i.e. 'server_busy'. Retry at a later time. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 500 - this code should be used only if there is catastrophic error and there is not a more appropriate code i.e. 'internal_server_error'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
/gradingPeriods GET
  • 200 - the request was successfully completed and a collection has been returned. This would be accompanied by the 'codeMajor/severity' values of 'success/status' and for a REST binding a HTTP code of '200'. The payload is defined by the structure AcademicSessionSetDType.
  • 400 - either an invalid selection field or invalid filter selection was supplied and data filtering on the selection criteria was not possible i.e. 'invalid_selection_field' or 'invalid_filter_field' respectively. This is accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 401 - the request was not correctly authorised i.e. 'unauthorisedrequest'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 403 - this is used to indicate that the server can be reached and process the request but refuses to take any further action i.e. 'forbidden'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 422 - this error condition may occur if a JSON request body contains well-formed (i.e. syntactically correct), but semantically erroneous, JSON instructions. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 429 - the server is receiving too many requests i.e. 'server_busy'. Retry at a later time. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 500 - this code should be used only if there is catastrophic error and there is not a more appropriate code i.e. 'internal_server_error'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
/gradingPeriods/{sourcedId} GET
  • 200 - the request was successfully completed and a record has been returned. This would be accompanied by the 'codeMajor/severity' values of 'success/status' and for a REST binding a HTTP code of '200'. The payload is defined by the structure SingleAcademicSessionDType.
  • 400 - either an invalid selection field or invalid filter selection was supplied and data filtering on the selection criteria was not possible i.e. 'invalid_selection_field' or 'invalid_filter_field' respectively. This is accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 401 - the request was not correctly authorised i.e. 'unauthorisedrequest'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 403 - this is used to indicate that the server can be reached and process the request but refuses to take any further action i.e. 'forbidden'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 404 - either the supplied identifier is unknown in the Service Provider and so the object could not be changed or an invalid GUID has been supplied. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The statement 'Unknown Object' should also be presented. The payload is defined by the structure imsx_StatusInfoDType.
  • 422 - this error condition may occur if a JSON request body contains well-formed (i.e. syntactically correct), but semantically erroneous, JSON instructions. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 429 - the server is receiving too many requests i.e. 'server_busy'. Retry at a later time. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 500 - this code should be used only if there is catastrophic error and there is not a more appropriate code i.e. 'internal_server_error'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
/orgs GET
  • 200 - the request was successfully completed and a collection has been returned. This would be accompanied by the 'codeMajor/severity' values of 'success/status' and for a REST binding a HTTP code of '200'. The payload is defined by the structure OrgSetDType.
  • 400 - either an invalid selection field or invalid filter selection was supplied and data filtering on the selection criteria was not possible i.e. 'invalid_selection_field' or 'invalid_filter_field' respectively. This is accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 401 - the request was not correctly authorised i.e. 'unauthorisedrequest'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 403 - this is used to indicate that the server can be reached and process the request but refuses to take any further action i.e. 'forbidden'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 422 - this error condition may occur if a JSON request body contains well-formed (i.e. syntactically correct), but semantically erroneous, JSON instructions. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 429 - the server is receiving too many requests i.e. 'server_busy'. Retry at a later time. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 500 - this code should be used only if there is catastrophic error and there is not a more appropriate code i.e. 'internal_server_error'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
/orgs/{sourcedId} GET
  • 200 - the request was successfully completed and a record has been returned. This would be accompanied by the 'codeMajor/severity' values of 'success/status' and for a REST binding a HTTP code of '200'. The payload is defined by the structure SingleOrgDType.
  • 400 - either an invalid selection field or invalid filter selection was supplied and data filtering on the selection criteria was not possible i.e. 'invalid_selection_field' or 'invalid_filter_field' respectively. This is accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 401 - the request was not correctly authorised i.e. 'unauthorisedrequest'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 403 - this is used to indicate that the server can be reached and process the request but refuses to take any further action i.e. 'forbidden'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 404 - either the supplied identifier is unknown in the Service Provider and so the object could not be changed or an invalid GUID has been supplied. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The statement 'Unknown Object' should also be presented. The payload is defined by the structure imsx_StatusInfoDType.
  • 422 - this error condition may occur if a JSON request body contains well-formed (i.e. syntactically correct), but semantically erroneous, JSON instructions. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 429 - the server is receiving too many requests i.e. 'server_busy'. Retry at a later time. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 500 - this code should be used only if there is catastrophic error and there is not a more appropriate code i.e. 'internal_server_error'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
/schools GET
  • 200 - the request was successfully completed and a collection has been returned. This would be accompanied by the 'codeMajor/severity' values of 'success/status' and for a REST binding a HTTP code of '200'. The payload is defined by the structure OrgSetDType.
  • 400 - either an invalid selection field or invalid filter selection was supplied and data filtering on the selection criteria was not possible i.e. 'invalid_selection_field' or 'invalid_filter_field' respectively. This is accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 401 - the request was not correctly authorised i.e. 'unauthorisedrequest'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 403 - this is used to indicate that the server can be reached and process the request but refuses to take any further action i.e. 'forbidden'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 422 - this error condition may occur if a JSON request body contains well-formed (i.e. syntactically correct), but semantically erroneous, JSON instructions. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 429 - the server is receiving too many requests i.e. 'server_busy'. Retry at a later time. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 500 - this code should be used only if there is catastrophic error and there is not a more appropriate code i.e. 'internal_server_error'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
/schools/{sourcedId} GET
  • 200 - the request was successfully completed and a record has been returned. This would be accompanied by the 'codeMajor/severity' values of 'success/status' and for a REST binding a HTTP code of '200'. The payload is defined by the structure SingleOrgDType.
  • 400 - either an invalid selection field or invalid filter selection was supplied and data filtering on the selection criteria was not possible i.e. 'invalid_selection_field' or 'invalid_filter_field' respectively. This is accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 401 - the request was not correctly authorised i.e. 'unauthorisedrequest'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 403 - this is used to indicate that the server can be reached and process the request but refuses to take any further action i.e. 'forbidden'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 404 - either the supplied identifier is unknown in the Service Provider and so the object could not be changed or an invalid GUID has been supplied. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The statement 'Unknown Object' should also be presented. The payload is defined by the structure imsx_StatusInfoDType.
  • 422 - this error condition may occur if a JSON request body contains well-formed (i.e. syntactically correct), but semantically erroneous, JSON instructions. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 429 - the server is receiving too many requests i.e. 'server_busy'. Retry at a later time. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 500 - this code should be used only if there is catastrophic error and there is not a more appropriate code i.e. 'internal_server_error'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
/schools/{schoolSourcedId}/courses GET
  • 200 - the request was successfully completed and a collection has been returned. This would be accompanied by the 'codeMajor/severity' values of 'success/status' and for a REST binding a HTTP code of '200'. The payload is defined by the structure CourseSetDType.
  • 400 - either an invalid selection field or invalid filter selection was supplied and data filtering on the selection criteria was not possible i.e. 'invalid_selection_field' or 'invalid_filter_field' respectively. This is accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 401 - the request was not correctly authorised i.e. 'unauthorisedrequest'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 403 - this is used to indicate that the server can be reached and process the request but refuses to take any further action i.e. 'forbidden'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 422 - this error condition may occur if a JSON request body contains well-formed (i.e. syntactically correct), but semantically erroneous, JSON instructions. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 429 - the server is receiving too many requests i.e. 'server_busy'. Retry at a later time. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 500 - this code should be used only if there is catastrophic error and there is not a more appropriate code i.e. 'internal_server_error'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
/schools/{schoolSourcedId}/classes/{classSourcedId}/enrollments GET
  • 200 - the request was successfully completed and a collection has been returned. This would be accompanied by the 'codeMajor/severity' values of 'success/status' and for a REST binding a HTTP code of '200'. The payload is defined by the structure EnrollmentSetDType.
  • 400 - either an invalid selection field or invalid filter selection was supplied and data filtering on the selection criteria was not possible i.e. 'invalid_selection_field' or 'invalid_filter_field' respectively. This is accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 401 - the request was not correctly authorised i.e. 'unauthorisedrequest'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 403 - this is used to indicate that the server can be reached and process the request but refuses to take any further action i.e. 'forbidden'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 422 - this error condition may occur if a JSON request body contains well-formed (i.e. syntactically correct), but semantically erroneous, JSON instructions. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 429 - the server is receiving too many requests i.e. 'server_busy'. Retry at a later time. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 500 - this code should be used only if there is catastrophic error and there is not a more appropriate code i.e. 'internal_server_error'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
/schools/{schoolSourcedId}/classes/{classSourcedId}/students GET
  • 200 - the request was successfully completed and a collection has been returned. This would be accompanied by the 'codeMajor/severity' values of 'success/status' and for a REST binding a HTTP code of '200'. The payload is defined by the structure UserSetDType.
  • 400 - either an invalid selection field or invalid filter selection was supplied and data filtering on the selection criteria was not possible i.e. 'invalid_selection_field' or 'invalid_filter_field' respectively. This is accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 401 - the request was not correctly authorised i.e. 'unauthorisedrequest'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 403 - this is used to indicate that the server can be reached and process the request but refuses to take any further action i.e. 'forbidden'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 422 - this error condition may occur if a JSON request body contains well-formed (i.e. syntactically correct), but semantically erroneous, JSON instructions. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 429 - the server is receiving too many requests i.e. 'server_busy'. Retry at a later time. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 500 - this code should be used only if there is catastrophic error and there is not a more appropriate code i.e. 'internal_server_error'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
/schools/{schoolSourcedId}/classes/{classSourcedId}/teachers GET
  • 200 - the request was successfully completed and a collection has been returned. This would be accompanied by the 'codeMajor/severity' values of 'success/status' and for a REST binding a HTTP code of '200'. The payload is defined by the structure UserSetDType.
  • 400 - either an invalid selection field or invalid filter selection was supplied and data filtering on the selection criteria was not possible i.e. 'invalid_selection_field' or 'invalid_filter_field' respectively. This is accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 401 - the request was not correctly authorised i.e. 'unauthorisedrequest'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 403 - this is used to indicate that the server can be reached and process the request but refuses to take any further action i.e. 'forbidden'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 422 - this error condition may occur if a JSON request body contains well-formed (i.e. syntactically correct), but semantically erroneous, JSON instructions. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 429 - the server is receiving too many requests i.e. 'server_busy'. Retry at a later time. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 500 - this code should be used only if there is catastrophic error and there is not a more appropriate code i.e. 'internal_server_error'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
/schools/{schoolSourcedId}/enrollments GET
  • 200 - the request was successfully completed and a collection has been returned. This would be accompanied by the 'codeMajor/severity' values of 'success/status' and for a REST binding a HTTP code of '200'. The payload is defined by the structure EnrollmentSetDType.
  • 400 - either an invalid selection field or invalid filter selection was supplied and data filtering on the selection criteria was not possible i.e. 'invalid_selection_field' or 'invalid_filter_field' respectively. This is accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 401 - the request was not correctly authorised i.e. 'unauthorisedrequest'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 403 - this is used to indicate that the server can be reached and process the request but refuses to take any further action i.e. 'forbidden'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 422 - this error condition may occur if a JSON request body contains well-formed (i.e. syntactically correct), but semantically erroneous, JSON instructions. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 429 - the server is receiving too many requests i.e. 'server_busy'. Retry at a later time. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 500 - this code should be used only if there is catastrophic error and there is not a more appropriate code i.e. 'internal_server_error'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
/schools/{schoolSourcedId}/students GET
  • 200 - the request was successfully completed and a collection has been returned. This would be accompanied by the 'codeMajor/severity' values of 'success/status' and for a REST binding a HTTP code of '200'. The payload is defined by the structure UserSetDType.
  • 400 - either an invalid selection field or invalid filter selection was supplied and data filtering on the selection criteria was not possible i.e. 'invalid_selection_field' or 'invalid_filter_field' respectively. This is accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 401 - the request was not correctly authorised i.e. 'unauthorisedrequest'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 403 - this is used to indicate that the server can be reached and process the request but refuses to take any further action i.e. 'forbidden'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 422 - this error condition may occur if a JSON request body contains well-formed (i.e. syntactically correct), but semantically erroneous, JSON instructions. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 429 - the server is receiving too many requests i.e. 'server_busy'. Retry at a later time. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 500 - this code should be used only if there is catastrophic error and there is not a more appropriate code i.e. 'internal_server_error'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
/schools/{schoolSourcedId}/teachers GET
  • 200 - the request was successfully completed and a collection has been returned. This would be accompanied by the 'codeMajor/severity' values of 'success/status' and for a REST binding a HTTP code of '200'. The payload is defined by the structure UserSetDType.
  • 400 - either an invalid selection field or invalid filter selection was supplied and data filtering on the selection criteria was not possible i.e. 'invalid_selection_field' or 'invalid_filter_field' respectively. This is accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 401 - the request was not correctly authorised i.e. 'unauthorisedrequest'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 403 - this is used to indicate that the server can be reached and process the request but refuses to take any further action i.e. 'forbidden'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 422 - this error condition may occur if a JSON request body contains well-formed (i.e. syntactically correct), but semantically erroneous, JSON instructions. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 429 - the server is receiving too many requests i.e. 'server_busy'. Retry at a later time. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 500 - this code should be used only if there is catastrophic error and there is not a more appropriate code i.e. 'internal_server_error'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
/schools/{schoolSourcedId}/terms GET
  • 200 - the request was successfully completed and a collection has been returned. This would be accompanied by the 'codeMajor/severity' values of 'success/status' and for a REST binding a HTTP code of '200'. The payload is defined by the structure AcademicSessionSetDType.
  • 400 - either an invalid selection field or invalid filter selection was supplied and data filtering on the selection criteria was not possible i.e. 'invalid_selection_field' or 'invalid_filter_field' respectively. This is accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 401 - the request was not correctly authorised i.e. 'unauthorisedrequest'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 403 - this is used to indicate that the server can be reached and process the request but refuses to take any further action i.e. 'forbidden'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 422 - this error condition may occur if a JSON request body contains well-formed (i.e. syntactically correct), but semantically erroneous, JSON instructions. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 429 - the server is receiving too many requests i.e. 'server_busy'. Retry at a later time. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 500 - this code should be used only if there is catastrophic error and there is not a more appropriate code i.e. 'internal_server_error'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
/schools/{schoolSourcedId}/classes GET
  • 200 - the request was successfully completed and a collection has been returned. This would be accompanied by the 'codeMajor/severity' values of 'success/status' and for a REST binding a HTTP code of '200'. The payload is defined by the structure ClassSetDType.
  • 400 - either an invalid selection field or invalid filter selection was supplied and data filtering on the selection criteria was not possible i.e. 'invalid_selection_field' or 'invalid_filter_field' respectively. This is accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 401 - the request was not correctly authorised i.e. 'unauthorisedrequest'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 403 - this is used to indicate that the server can be reached and process the request but refuses to take any further action i.e. 'forbidden'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 422 - this error condition may occur if a JSON request body contains well-formed (i.e. syntactically correct), but semantically erroneous, JSON instructions. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 429 - the server is receiving too many requests i.e. 'server_busy'. Retry at a later time. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 500 - this code should be used only if there is catastrophic error and there is not a more appropriate code i.e. 'internal_server_error'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
/students GET
  • 200 - the request was successfully completed and a collection has been returned. This would be accompanied by the 'codeMajor/severity' values of 'success/status' and for a REST binding a HTTP code of '200'. The payload is defined by the structure UserSetDType.
  • 400 - either an invalid selection field or invalid filter selection was supplied and data filtering on the selection criteria was not possible i.e. 'invalid_selection_field' or 'invalid_filter_field' respectively. This is accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 401 - the request was not correctly authorised i.e. 'unauthorisedrequest'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 403 - this is used to indicate that the server can be reached and process the request but refuses to take any further action i.e. 'forbidden'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 422 - this error condition may occur if a JSON request body contains well-formed (i.e. syntactically correct), but semantically erroneous, JSON instructions. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 429 - the server is receiving too many requests i.e. 'server_busy'. Retry at a later time. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 500 - this code should be used only if there is catastrophic error and there is not a more appropriate code i.e. 'internal_server_error'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
/students/{sourcedId} GET
  • 200 - the request was successfully completed and a record has been returned. This would be accompanied by the 'codeMajor/severity' values of 'success/status' and for a REST binding a HTTP code of '200'. The payload is defined by the structure SingleUserDType.
  • 400 - either an invalid selection field or invalid filter selection was supplied and data filtering on the selection criteria was not possible i.e. 'invalid_selection_field' or 'invalid_filter_field' respectively. This is accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 401 - the request was not correctly authorised i.e. 'unauthorisedrequest'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 403 - this is used to indicate that the server can be reached and process the request but refuses to take any further action i.e. 'forbidden'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 404 - either the supplied identifier is unknown in the Service Provider and so the object could not be changed or an invalid GUID has been supplied. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The statement 'Unknown Object' should also be presented. The payload is defined by the structure imsx_StatusInfoDType.
  • 422 - this error condition may occur if a JSON request body contains well-formed (i.e. syntactically correct), but semantically erroneous, JSON instructions. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 429 - the server is receiving too many requests i.e. 'server_busy'. Retry at a later time. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 500 - this code should be used only if there is catastrophic error and there is not a more appropriate code i.e. 'internal_server_error'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
/students/{studentSourcedId}/classes GET
  • 200 - the request was successfully completed and a collection has been returned. This would be accompanied by the 'codeMajor/severity' values of 'success/status' and for a REST binding a HTTP code of '200'. The payload is defined by the structure ClassSetDType.
  • 400 - either an invalid selection field or invalid filter selection was supplied and data filtering on the selection criteria was not possible i.e. 'invalid_selection_field' or 'invalid_filter_field' respectively. This is accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 401 - the request was not correctly authorised i.e. 'unauthorisedrequest'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 403 - this is used to indicate that the server can be reached and process the request but refuses to take any further action i.e. 'forbidden'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 422 - this error condition may occur if a JSON request body contains well-formed (i.e. syntactically correct), but semantically erroneous, JSON instructions. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 429 - the server is receiving too many requests i.e. 'server_busy'. Retry at a later time. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 500 - this code should be used only if there is catastrophic error and there is not a more appropriate code i.e. 'internal_server_error'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
/teachers GET
  • 200 - the request was successfully completed and a collection has been returned. This would be accompanied by the 'codeMajor/severity' values of 'success/status' and for a REST binding a HTTP code of '200'. The payload is defined by the structure UserSetDType.
  • 400 - either an invalid selection field or invalid filter selection was supplied and data filtering on the selection criteria was not possible i.e. 'invalid_selection_field' or 'invalid_filter_field' respectively. This is accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 401 - the request was not correctly authorised i.e. 'unauthorisedrequest'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 403 - this is used to indicate that the server can be reached and process the request but refuses to take any further action i.e. 'forbidden'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 422 - this error condition may occur if a JSON request body contains well-formed (i.e. syntactically correct), but semantically erroneous, JSON instructions. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 429 - the server is receiving too many requests i.e. 'server_busy'. Retry at a later time. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 500 - this code should be used only if there is catastrophic error and there is not a more appropriate code i.e. 'internal_server_error'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
/teachers/{sourcedId} GET
  • 200 - the request was successfully completed and a record has been returned. This would be accompanied by the 'codeMajor/severity' values of 'success/status' and for a REST binding a HTTP code of '200'. The payload is defined by the structure SingleUserDType.
  • 400 - either an invalid selection field or invalid filter selection was supplied and data filtering on the selection criteria was not possible i.e. 'invalid_selection_field' or 'invalid_filter_field' respectively. This is accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 401 - the request was not correctly authorised i.e. 'unauthorisedrequest'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 403 - this is used to indicate that the server can be reached and process the request but refuses to take any further action i.e. 'forbidden'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 404 - either the supplied identifier is unknown in the Service Provider and so the object could not be changed or an invalid GUID has been supplied. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The statement 'Unknown Object' should also be presented. The payload is defined by the structure imsx_StatusInfoDType.
  • 422 - this error condition may occur if a JSON request body contains well-formed (i.e. syntactically correct), but semantically erroneous, JSON instructions. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 429 - the server is receiving too many requests i.e. 'server_busy'. Retry at a later time. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 500 - this code should be used only if there is catastrophic error and there is not a more appropriate code i.e. 'internal_server_error'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
/teachers/{teacherSourcedId}/classes GET
  • 200 - the request was successfully completed and a collection has been returned. This would be accompanied by the 'codeMajor/severity' values of 'success/status' and for a REST binding a HTTP code of '200'. The payload is defined by the structure ClassSetDType.
  • 400 - either an invalid selection field or invalid filter selection was supplied and data filtering on the selection criteria was not possible i.e. 'invalid_selection_field' or 'invalid_filter_field' respectively. This is accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 401 - the request was not correctly authorised i.e. 'unauthorisedrequest'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 403 - this is used to indicate that the server can be reached and process the request but refuses to take any further action i.e. 'forbidden'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 422 - this error condition may occur if a JSON request body contains well-formed (i.e. syntactically correct), but semantically erroneous, JSON instructions. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 429 - the server is receiving too many requests i.e. 'server_busy'. Retry at a later time. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 500 - this code should be used only if there is catastrophic error and there is not a more appropriate code i.e. 'internal_server_error'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
/terms GET
  • 200 - the request was successfully completed and a collection has been returned. This would be accompanied by the 'codeMajor/severity' values of 'success/status' and for a REST binding a HTTP code of '200'. The payload is defined by the structure AcademicSessionSetDType.
  • 400 - either an invalid selection field or invalid filter selection was supplied and data filtering on the selection criteria was not possible i.e. 'invalid_selection_field' or 'invalid_filter_field' respectively. This is accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 401 - the request was not correctly authorised i.e. 'unauthorisedrequest'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 403 - this is used to indicate that the server can be reached and process the request but refuses to take any further action i.e. 'forbidden'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 422 - this error condition may occur if a JSON request body contains well-formed (i.e. syntactically correct), but semantically erroneous, JSON instructions. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 429 - the server is receiving too many requests i.e. 'server_busy'. Retry at a later time. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 500 - this code should be used only if there is catastrophic error and there is not a more appropriate code i.e. 'internal_server_error'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
/terms/{sourcedId} GET
  • 200 - the request was successfully completed and a record has been returned. This would be accompanied by the 'codeMajor/severity' values of 'success/status' and for a REST binding a HTTP code of '200'. The payload is defined by the structure SingleAcademicSessionDType.
  • 400 - either an invalid selection field or invalid filter selection was supplied and data filtering on the selection criteria was not possible i.e. 'invalid_selection_field' or 'invalid_filter_field' respectively. This is accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 401 - the request was not correctly authorised i.e. 'unauthorisedrequest'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 403 - this is used to indicate that the server can be reached and process the request but refuses to take any further action i.e. 'forbidden'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 404 - either the supplied identifier is unknown in the Service Provider and so the object could not be changed or an invalid GUID has been supplied. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The statement 'Unknown Object' should also be presented. The payload is defined by the structure imsx_StatusInfoDType.
  • 422 - this error condition may occur if a JSON request body contains well-formed (i.e. syntactically correct), but semantically erroneous, JSON instructions. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 429 - the server is receiving too many requests i.e. 'server_busy'. Retry at a later time. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 500 - this code should be used only if there is catastrophic error and there is not a more appropriate code i.e. 'internal_server_error'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
/terms/{termSourcedId}/classes GET
  • 200 - the request was successfully completed and a collection has been returned. This would be accompanied by the 'codeMajor/severity' values of 'success/status' and for a REST binding a HTTP code of '200'. The payload is defined by the structure ClassSetDType.
  • 400 - either an invalid selection field or invalid filter selection was supplied and data filtering on the selection criteria was not possible i.e. 'invalid_selection_field' or 'invalid_filter_field' respectively. This is accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 401 - the request was not correctly authorised i.e. 'unauthorisedrequest'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 403 - this is used to indicate that the server can be reached and process the request but refuses to take any further action i.e. 'forbidden'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 422 - this error condition may occur if a JSON request body contains well-formed (i.e. syntactically correct), but semantically erroneous, JSON instructions. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 429 - the server is receiving too many requests i.e. 'server_busy'. Retry at a later time. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 500 - this code should be used only if there is catastrophic error and there is not a more appropriate code i.e. 'internal_server_error'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
/terms/{termSourcedId}/gradingPeriods GET
  • 200 - the request was successfully completed and a collection has been returned. This would be accompanied by the 'codeMajor/severity' values of 'success/status' and for a REST binding a HTTP code of '200'. The payload is defined by the structure AcademicSessionSetDType.
  • 400 - either an invalid selection field or invalid filter selection was supplied and data filtering on the selection criteria was not possible i.e. 'invalid_selection_field' or 'invalid_filter_field' respectively. This is accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 401 - the request was not correctly authorised i.e. 'unauthorisedrequest'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 403 - this is used to indicate that the server can be reached and process the request but refuses to take any further action i.e. 'forbidden'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 422 - this error condition may occur if a JSON request body contains well-formed (i.e. syntactically correct), but semantically erroneous, JSON instructions. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 429 - the server is receiving too many requests i.e. 'server_busy'. Retry at a later time. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 500 - this code should be used only if there is catastrophic error and there is not a more appropriate code i.e. 'internal_server_error'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
/users GET
  • 200 - the request was successfully completed and a collection has been returned. This would be accompanied by the 'codeMajor/severity' values of 'success/status' and for a REST binding a HTTP code of '200'. The payload is defined by the structure UserSetDType.
  • 400 - either an invalid selection field or invalid filter selection was supplied and data filtering on the selection criteria was not possible i.e. 'invalid_selection_field' or 'invalid_filter_field' respectively. This is accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 401 - the request was not correctly authorised i.e. 'unauthorisedrequest'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 403 - this is used to indicate that the server can be reached and process the request but refuses to take any further action i.e. 'forbidden'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 422 - this error condition may occur if a JSON request body contains well-formed (i.e. syntactically correct), but semantically erroneous, JSON instructions. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 429 - the server is receiving too many requests i.e. 'server_busy'. Retry at a later time. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 500 - this code should be used only if there is catastrophic error and there is not a more appropriate code i.e. 'internal_server_error'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
/users/{sourcedId} GET
  • 200 - the request was successfully completed and a record has been returned. This would be accompanied by the 'codeMajor/severity' values of 'success/status' and for a REST binding a HTTP code of '200'. The payload is defined by the structure SingleUserDType.
  • 400 - either an invalid selection field or invalid filter selection was supplied and data filtering on the selection criteria was not possible i.e. 'invalid_selection_field' or 'invalid_filter_field' respectively. This is accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 401 - the request was not correctly authorised i.e. 'unauthorisedrequest'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 403 - this is used to indicate that the server can be reached and process the request but refuses to take any further action i.e. 'forbidden'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 404 - either the supplied identifier is unknown in the Service Provider and so the object could not be changed or an invalid GUID has been supplied. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The statement 'Unknown Object' should also be presented. The payload is defined by the structure imsx_StatusInfoDType.
  • 422 - this error condition may occur if a JSON request body contains well-formed (i.e. syntactically correct), but semantically erroneous, JSON instructions. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 429 - the server is receiving too many requests i.e. 'server_busy'. Retry at a later time. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 500 - this code should be used only if there is catastrophic error and there is not a more appropriate code i.e. 'internal_server_error'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
/users/{userSourcedId}/classes GET
  • 200 - the request was successfully completed and a collection has been returned. This would be accompanied by the 'codeMajor/severity' values of 'success/status' and for a REST binding a HTTP code of '200'. The payload is defined by the structure ClassSetDType.
  • 400 - either an invalid selection field or invalid filter selection was supplied and data filtering on the selection criteria was not possible i.e. 'invalid_selection_field' or 'invalid_filter_field' respectively. This is accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 401 - the request was not correctly authorised i.e. 'unauthorisedrequest'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 403 - this is used to indicate that the server can be reached and process the request but refuses to take any further action i.e. 'forbidden'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 422 - this error condition may occur if a JSON request body contains well-formed (i.e. syntactically correct), but semantically erroneous, JSON instructions. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 429 - the server is receiving too many requests i.e. 'server_busy'. Retry at a later time. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.
  • 500 - this code should be used only if there is catastrophic error and there is not a more appropriate code i.e. 'internal_server_error'. This would be accompanied by the 'codeMajor/severity' values of 'failure/error'. The payload is defined by the structure imsx_StatusInfoDType.

2.5 Service Discovery

A Service Provider MUST provide a localized version of the OpenAPI file (version 3 JSON file format) to enable service discovery [Security, 21].

This file MUST be located at: "...hostname.../ims/oneroster/rostering/v1p2/discovery/".

The OpenAPI file MUST have the name: "onerosterv1p2rostersservice_openapi3_v1p0.json".

Therefore the full URL for this service discovery file is: ...hostname.../ims/oneroster/rostering/v1p2/discovery/onerosterv1p2rostersservice_openapi3_v1p0.json

toc | top

3. Using the Endpoint Parameters

This Section is NOT NORMATIVE.

3.1. Pagination

For requests of collections i.e. the response for the 'getAllUsers()' call, there is a danger of data overload. To avoid this, implementations should adopt a pagination mechanism. Pagination is controlled via two parameters that are appended to the request:

An example of a request to return the first 10 resources in a collection of students:

    GET https://imsglobal.org/ims/oneroster/rostering/v1p2/users?limit=10

An example of a request to return the second 10 users in a collection of users:

    GET https://imsglobal.org/ims/oneroster/rostering/v1p2/users?limit=10&offset=10

It is RECOMMENDED that implementations pass the total resource count in collection back to the requester. This MUST be provided in the custom HTTP header: X-Total-Count.

It is RECOMMENDED that implementers pass back next, previous, first and last links in the HTTP Link Header.

Consider the requests for the example where 503 resources exist in the collection. The pagination is in units of 10.

    Link:

    <https://imsglobal.org/ims/oneroster/rostering/v1p2/users?limit=10&offset=20>; rel="next",
    <https://imsglobal.org/ims/oneroster/rostering/v1p2/users?limit=3&offset=500>; rel="last",
    <https://imsglobal.org/ims/oneroster/rostering/v1p2/users?limit=10&offset=0>; rel="first",
    <https://imsglobal.org/ims/oneroster/rostering/v1p2/users?limit=10&offset=0>; rel="prev"

3.2. Sorting

It should be possible for collections, i.e. the response for the 'getAllUsers()' call etc. to be returned in a sorted order. It should be possible to sort the collection based on any single data element in the core description of the resource. Sort requests MUST make use of the reserved word "sort" (?sort= data_field), and optionally the reserved word orderBy for which:

An example of a request to ask for a list of users sorted into ascending lastName order:

    GET https://imsglobal.org/ims/oneroster/rostering/v1p2/users?sort=lastName&orderBy=asc

Sorting should conform to the use of the Unicode Collation Algorithm [UNICODE, 16] when using the relevant comparisons.

If the consumer requests that the data is to be sorted by a non-existent field, data MAY be returned in the service provider's default sort order or an error response MAY be returned.

When sorting/ordering is requested on a property that is an array, the first value in the array is used as the basis of the sorting/ordering.

To sort/order on the properties of nested objects, (for example, with metadata properties), a dot-notation approach MUST be used. The format for this is:

    ?sort=<Nested_Object>.<Property>

3.3. Filtering

For the calls that request collections e.g. 'getAllUsers()' call, it should be possible to filter collections for elements matching a certain criteria. It should be possible to filter collections based on any data element in the core description of the resource.Filter requests MUST take the form:

    ?filter=<data_field><predicate><value>

or

    ?filter=<data_field><predicate><value><logical><data_field><predicate><value>

The data fields that can be used are those present in the class definition being filtered. So for example in 'users', it MUST be possible to filter on: 'firstName', 'lastName', 'dateLastModified', etc.

Predicates MUST be chosen from those listed below:

Values MUST be enclosed within single quotes and they MUST be handled as case insensitive. When the response is returned it is the receiving system that should consider whether or not case-sensitivity is important.

The <logical> parameters allow more complex queries to be created. For version 1.2, it is RECOMMENDED that logical operations are limited to " AND " and " OR " (note the surrounding white space at each side) and that there is only one such operator used in any filter i.e. a single 'AND' or a single 'OR' in the filter. A single white space must occur before and after the parameter.

To query on the properties of nested objects, (for example, with metadata properties), a dot-notation approach MUST be used. The format for this is:

    ?filter=<Nested_Object>.<Property>

Note then when querying on metadata, the property is loosely typed. An example or a request to find users with a 'lastName' of 'Smythe' is:

    GET https://imsglobal.org/ims/oneroster/rostering/v1p2/users?filter=lastName='Smythe'

URL encoded as:

    GET https://imsglobal.org/ims/oneroster/rostering/v1p2/users?filter=lastName%3D%27Smythe%27

Filter queries MUST be URL encoded.

An example of a complex query for all users with a lastName='Smythe' AND dateLastModified>'2016-12-12T00:00:00Z' is:

    GET https://imsglobal.org/ims/oneroster/rostering/v1p2/users?filter=lastName%3D%27Smythe%27%20AND%20dateLastModified%3E%272016%3D12%3D12T00%3A00%3A00Z%27

When filtering on objects that are arrays the application of the filter depends on the nature of the comparison. So in the case of filtering on the 'preferredName' field when the value of the field is 'name1,name2,name3' the following filters would return:

This means filtering using the '=' has 'AND' semantics and the '~' has 'OR' semantics. Filtering rules should conform to the use of the Unicode Collation Algorithm [UNICODE, 16] when using the relevant comparisons.

If the consumer requests that data be filtered by a non-existent field, NO data is returned and the server must provide the associated transaction status code information of:

3.4. Field Selection

For the read collection calls, such as 'getAllUsers()', it should be possible for requesters to select the range of fields to be returned. By default, all mandatory and optional fields from the core description of the resource MUST be returned. If any fields are specified in the request then the implementation should return those fields AND ONLY those fields i.e. the multiplicity rules for an element are overridden. Any field or fields from the Data Model MAY be requested.

Field selection request MUST make use of the reserved word 'fields'. The value of fields is a comma delimited list of the fields to return. An example of a request message to ask for a list of Users returning only the 'firstname' and 'lastname':

    GET https://imsglobal.org/ims/oneroster/rostering/v1p2/users?fields=firstname,lastname

If the consumer requests that data be selected using non-existent field, ALL data for the record is returned. If the consumer requests that data be selected using a blank field the request will be treated as an invalid request. The server must provide the associated transaction status code information of:

toc | top

4. Security Framework

This Section is NORMATIVE.

The information in this section is taken from the IMS Security Framework [Security, 21]: that document describes the security approaches to be adopted in all IMS specifications.

4.1. Transport Security

As the service will be exposing personal data related to students and their grades, it is important that only authorized users have access to that data. Further, data exchanges should be encrypted to ensure that packet sniffing cannot be used to read the data in transit.

All Requests and Responses MUST be sent using Transport Layer Security (TLS). Exchange of the signed certificates for endpoints between clients and servers is beyond the scope of this specification. Implementers of clients and servers are advised to look at the various 3rd party certificate signing services in order to obtain signed certificates.

Support for TLS 1.2 and/or TLS 1.3 is REQUIRED and SSL MUST NOT be used.

4.2. Authorization

The use of OAuth 2.0 Client Credentials with the Bearer Token obtained using the mechanism described in [RFC 6749] (Section 4.4) is REQUIRED. Details of this are given in the IMS Security Framework [Security, 19].

Authorization will use the OAuth 2.0 Client Credentials Grant mechanism. In this mechanism the client can request an access token using only its client credentials (using the consumer key and secret information) when the client is requesting access to the protected resources under its control, or those of another resource owner that have been previously arranged with the authorization server. In this approach the client issues a client authentication request and receives in response an access token. Issuing of an access token is defined in Section 5 of [RFC 6749].

The request for an access token, including three scopes (scopename1, scopename2 and scopenamex) takes the form of (this uses TLS):

        POST /token HTTP/1.1
        Host: server.example.com
        Authorization: Basic czZCaGRSa3F0MzpnWDFmQmF0M2JW
        Content-Type: application/x-www-form-urlencoded

        grant_type=client_credentials&scope=scopename1%20scopename2%20scopenamex
        

The inclusion of scopes is REQUIRED and the set of scopes available for this service are defined in the following subsection. The authorization encoding is produced using the consumer key and secret. Note that the request for an access token MAY use a HTTP GET request.

The authorization encoding is produced using the consumer key and secret. Success results in the granting of the access token with a response of:

        HTTP/1.1 200 OK
        Content-Type: application/json;charset=UTF-8
        Cache-Control: no-store
        Pragma: no-cache

        {
            "access_token" : "2YotnFZFEjr1zCsicMWpAA",
            "token_type" : "bearer",
            "expires_in" : 3600,
            "scope" : "scopename1 scopename2 scopenamex"
        }
        

The recommended default value for the "expires_in" is 3600s. The authorization server MUST provide the scopes which are made available (either all or a subset of the scopes supplied in the request).

The client utilizes the access token to authenticate with the resource using the HTTP "Authorization" request header field [RFC 2617] with an authentication scheme defined by the specification of the access token type used, such as [RFC 6750]. An example of the use of the bearer token is:

        GET /resource/1 HTTP/1.1
        Host: provider.example.com
        Authorization: Bearer 2YotnFZFEjr1zCsicMWpAA
        

NOTE: This exchange assumes that TLS is used to secure the link.

4.3. Scopes

The set of scopes available in this service are listed in the following Tables.

4.3.1 "http://purl.imsglobal.org/spec/or/v1p2/scope/roster-core.readonly" Scope

The core set of read operations to enable information about collections or a single object to be obtained. The set of service operations covered by this scope are listed in Table 4.3.1.

Table 4.3.1 Service Operations for the "http://purl.imsglobal.org/spec/or/v1p2/scope/roster-core.readonly" Scope.
Operation HTTP Verb Endpoint
getAcademicSession GET /academicSessions/{sourcedId}
getAllAcademicSessions GET /academicSessions
getAllClasses GET /classes
getAllCourses GET /courses
getAllEnrollments GET /enrollments
getAllGradingPeriods GET /gradingPeriods
getAllOrgs GET /orgs
getAllSchools GET /schools
getAllStudents GET /students
getAllTeachers GET /teachers
getAllTerms GET /terms
getAllUsers GET /users
getClass GET /classes/{sourcedId}
getCourse GET /courses/{sourcedId}
getEnrollment GET /enrollments/{sourcedId}
getGradingPeriod GET /gradingPeriods/{sourcedId}
getOrg GET /orgs/{sourcedId}
getSchool GET /schools/{sourcedId}
getStudent GET /students/{sourcedId}
getTeacher GET /teachers/{sourcedId}
getTerm GET /terms/{sourcedId}
getUser GET /users/{sourcedId}

4.3.2 "http://purl.imsglobal.org/spec/or/v1p2/scope/roster-demographics.readonly" Scope

The read operations to provide all demographics or a single demographics object to be obtained. The set of service operations covered by this scope are listed in Table 4.3.2.

Table 4.3.2 Service Operations for the "http://purl.imsglobal.org/spec/or/v1p2/scope/roster-demographics.readonly" Scope.
Operation HTTP Verb Endpoint
getAllDemographics GET /demographics
getDemographics GET /demographics/{sourcedId}

4.3.3 "http://purl.imsglobal.org/spec/or/v1p2/scope/roster.readonly" Scope

Support for all of the read operations (excluding demographics) to enable information about collections or a single object to be obtained. The set of service operations covered by this scope are listed in Table 4.3.3.

Table 4.3.3 Service Operations for the "http://purl.imsglobal.org/spec/or/v1p2/scope/roster.readonly" Scope.
Operation HTTP Verb Endpoint
getAcademicSession GET /academicSessions/{sourcedId}
getAllAcademicSessions GET /academicSessions
getAllClasses GET /classes
getAllCourses GET /courses
getAllEnrollments GET /enrollments
getAllGradingPeriods GET /gradingPeriods
getAllOrgs GET /orgs
getAllSchools GET /schools
getAllStudents GET /students
getAllTeachers GET /teachers
getAllTerms GET /terms
getAllUsers GET /users
getClass GET /classes/{sourcedId}
getClassesForCourse GET /courses/{courseSourcedId}/classes
getClassesForSchool GET /schools/{schoolSourcedId}/classes
getClassesForStudent GET /students/{studentSourcedId}/classes
getClassesForTeacher GET /teachers/{teacherSourcedId}/classes
getClassesForTerm GET /terms/{termSourcedId}/classes
getClassesForUser GET /users/{userSourcedId}/classes
getCourse GET /courses/{sourcedId}
getCoursesForSchool GET /schools/{schoolSourcedId}/courses
getEnrollment GET /enrollments/{sourcedId}
getEnrollmentsForClassInSchool GET /schools/{schoolSourcedId}/classes/{classSourcedId}/enrollments
getEnrollmentsForSchool GET /schools/{schoolSourcedId}/enrollments
getGradingPeriod GET /gradingPeriods/{sourcedId}
getGradingPeriodsForTerm GET /terms/{termSourcedId}/gradingPeriods
getOrg GET /orgs/{sourcedId}
getSchool GET /schools/{sourcedId}
getStudent GET /students/{sourcedId}
getStudentsForClass GET /classes/{classSourcedId}/students
getStudentsForClassInSchool GET /schools/{schoolSourcedId}/classes/{classSourcedId}/students
getStudentsForSchool GET /schools/{schoolSourcedId}/students
getTeacher GET /teachers/{sourcedId}
getTeachersForClass GET /classes/{classSourcedId}/teachers
getTeachersForClassInSchool GET /schools/{schoolSourcedId}/classes/{classSourcedId}/teachers
getTeachersForSchool GET /schools/{schoolSourcedId}/teachers
getTerm GET /terms/{sourcedId}
getTermsForSchool GET /schools/{schoolSourcedId}/terms
getUser GET /users/{sourcedId}

toc | top

5. UML to JSON Payload Mapping

This Section is NOT NORMATIVE.

5.1 Service Parameter Payload Properties UML/JSON Mapping

The UML/JSON Mapping for the Service Parameters (excluding those service parameters passed as query parameters on the endpoint URL) to the JSON Payload Properties is given in Table 5.1. The syntax and semantics for this representation is described in Appendix A2.1.

Table 5.1 UML/JSON Mapping for the Service Parameters.
Operation Name Parameter Name UML Class JSON Name JSON Type JSON Schema Data Type
getAcademicSession academicSession SingleAcademicSession academicSession Object SingleAcademicSessionDType
getAllAcademicSessions academicSessions AcademicSessionSet academicSessions Array of Objects AcademicSessionSetDType
getAllClasses classes ClassSet classes Array of Objects ClassSetDType
getAllCourses courses CourseSet courses Array of Objects CourseSetDType
getAllDemographics demographics DemographicsSet demographics Array of Objects DemographicsSetDType
getAllEnrollments enrollments EnrollmentSet enrollments Array of Objects EnrollmentSetDType
getAllGradingPeriods academicSessions AcademicSessionSet academicSessions Array of Objects AcademicSessionSetDType
getAllOrgs orgs OrgSet orgs Array of Objects OrgSetDType
getAllSchools orgs OrgSet orgs Array of Objects OrgSetDType
getAllStudents users UserSet users Array of Objects UserSetDType
getAllTeachers users UserSet users Array of Objects UserSetDType
getAllTerms academicSessions AcademicSessionSet academicSessions Array of Objects AcademicSessionSetDType
getAllUsers users UserSet users Array of Objects UserSetDType
getClass class SingleClass class Object SingleClassDType
getClassesForCourse classes ClassSet classes Array of Objects ClassSetDType
getClassesForSchool classes ClassSet classes Array of Objects ClassSetDType
getClassesForStudent classes ClassSet classes Array of Objects ClassSetDType
getClassesForTeacher classes ClassSet classes Array of Objects ClassSetDType
getClassesForTerm classes ClassSet classes Array of Objects ClassSetDType
getClassesForUser classes ClassSet classes Array of Objects ClassSetDType
getCourse course SingleCourse course Object SingleCourseDType
getCoursesForSchool courses CourseSet courses Array of Objects CourseSetDType
getDemographics demographics SingleDemographics demographics Object SingleDemographicsDType
getEnrollment enrollment SingleEnrollment enrollment Object SingleEnrollmentDType
getEnrollmentsForClassInSchool enrollments EnrollmentSet enrollments Array of Objects EnrollmentSetDType
getEnrollmentsForSchool enrollments EnrollmentSet enrollments Array of Objects EnrollmentSetDType
getGradingPeriod academicSession SingleAcademicSession academicSession Object SingleAcademicSessionDType
getGradingPeriodsForTerm academicSessions AcademicSessionSet academicSessions Array of Objects AcademicSessionSetDType
getOrg org SingleOrg org Object SingleOrgDType
getSchool org SingleOrg org Object SingleOrgDType
getStudent user SingleUser user Object SingleUserDType
getStudentsForClass users UserSet users Array of Objects UserSetDType
getStudentsForClassInSchool users UserSet users Array of Objects UserSetDType
getStudentsForSchool users UserSet users Array of Objects UserSetDType
getTeacher user SingleUser user Object SingleUserDType
getTeachersForClass users UserSet users Array of Objects UserSetDType
getTeachersForClassInSchool users UserSet users Array of Objects UserSetDType
getTeachersForSchool users UserSet users Array of Objects UserSetDType
getTerm academicSession SingleAcademicSession academicSession Object SingleAcademicSessionDType
getTermsForSchool academicSessions AcademicSessionSet academicSessions Array of Objects AcademicSessionSetDType
getUser user SingleUser user Object SingleUserDType

5.2 Service Parameter Payload Class UML/JSON Mapping

The syntax and semantics for the Root Class UML/JSON mapping representations is described in Appendix A2.2.

5.2.1 OrgSet Service Parameter Payload Class Mapping

The UML/JSON Mapping for the "OrgSet" Service Parameter Payload Class is given in Table 5.2.1.

Table 5.2.1 UML/JSON Mapping for the "OrgSet" Service Parameter Payload Class.
Information Model Details JSON Binding Details
Name UML Artefact Data Type Multiplicity Name Type
OrgSet Payload Parameter Container [ Sequence ] - N/A - OrgSetDType Object
  • orgs
Attribute Org [0.. *] orgs Array of Properties

5.2.2 SingleOrg Service Parameter Payload Class Mapping

The UML/JSON Mapping for the "SingleOrg" Service Parameter Payload Class is given in Table 5.2.2.

Table 5.2.2 UML/JSON Mapping for the "SingleOrg" Service Parameter Payload Class.
Information Model Details JSON Binding Details
Name UML Artefact Data Type Multiplicity Name Type
SingleOrg Payload Parameter Container [ Sequence ] - N/A - SingleOrgDType Object
  • org
Attribute Org [1] org Property

5.2.3 CourseSet Service Parameter Payload Class Mapping

The UML/JSON Mapping for the "CourseSet" Service Parameter Payload Class is given in Table 5.2.3.

Table 5.2.3 UML/JSON Mapping for the "CourseSet" Service Parameter Payload Class.
Information Model Details JSON Binding Details
Name UML Artefact Data Type Multiplicity Name Type
CourseSet Payload Parameter Container [ Sequence ] - N/A - CourseSetDType Object
  • courses
Attribute Course [0.. *] courses Array of Properties

5.2.4 SingleCourse Service Parameter Payload Class Mapping

The UML/JSON Mapping for the "SingleCourse" Service Parameter Payload Class is given in Table 5.2.4.

Table 5.2.4 UML/JSON Mapping for the "SingleCourse" Service Parameter Payload Class.
Information Model Details JSON Binding Details
Name UML Artefact Data Type Multiplicity Name Type
SingleCourse Payload Parameter Container [ Sequence ] - N/A - SingleCourseDType Object
  • course
Attribute Course [1] course Property

5.2.5 ClassSet Service Parameter Payload Class Mapping

The UML/JSON Mapping for the "ClassSet" Service Parameter Payload Class is given in Table 5.2.5.

Table 5.2.5 UML/JSON Mapping for the "ClassSet" Service Parameter Payload Class.
Information Model Details JSON Binding Details
Name UML Artefact Data Type Multiplicity Name Type
ClassSet Payload Parameter Container [ Sequence ] - N/A - ClassSetDType Object
  • classes
Attribute Class [0.. *] classes Array of Properties

5.2.6 SingleClass Service Parameter Payload Class Mapping

The UML/JSON Mapping for the "SingleClass" Service Parameter Payload Class is given in Table 5.2.6.

Table 5.2.6 UML/JSON Mapping for the "SingleClass" Service Parameter Payload Class.
Information Model Details JSON Binding Details
Name UML Artefact Data Type Multiplicity Name Type
SingleClass Payload Parameter Container [ Sequence ] - N/A - SingleClassDType Object
  • class
Attribute Class [1] class Property

5.2.7 UserSet Service Parameter Payload Class Mapping

The UML/JSON Mapping for the "UserSet" Service Parameter Payload Class is given in Table 5.2.7.

Table 5.2.7 UML/JSON Mapping for the "UserSet" Service Parameter Payload Class.
Information Model Details JSON Binding Details
Name UML Artefact Data Type Multiplicity Name Type
UserSet Payload Parameter Container [ Sequence ] - N/A - UserSetDType Object
  • users
Attribute User [0.. *] users Array of Properties

5.2.8 EnrollmentSet Service Parameter Payload Class Mapping

The UML/JSON Mapping for the "EnrollmentSet" Service Parameter Payload Class is given in Table 5.2.8.

Table 5.2.8 UML/JSON Mapping for the "EnrollmentSet" Service Parameter Payload Class.
Information Model Details JSON Binding Details
Name UML Artefact Data Type Multiplicity Name Type
EnrollmentSet Payload Parameter Container [ Sequence ] - N/A - EnrollmentSetDType Object
  • enrollments
Attribute Enrollment [0.. *] enrollments Array of Properties

5.2.9 SingleEnrollment Service Parameter Payload Class Mapping

The UML/JSON Mapping for the "SingleEnrollment" Service Parameter Payload Class is given in Table 5.2.9.

Table 5.2.9 UML/JSON Mapping for the "SingleEnrollment" Service Parameter Payload Class.
Information Model Details JSON Binding Details
Name UML Artefact Data Type Multiplicity Name Type
SingleEnrollment Payload Parameter Container [ Sequence ] - N/A - SingleEnrollmentDType Object
  • enrollment
Attribute Enrollment [1] enrollment Property

5.2.10 DemographicsSet Service Parameter Payload Class Mapping

The UML/JSON Mapping for the "DemographicsSet" Service Parameter Payload Class is given in Table 5.2.10.

Table 5.2.10 UML/JSON Mapping for the "DemographicsSet" Service Parameter Payload Class.
Information Model Details JSON Binding Details
Name UML Artefact Data Type Multiplicity Name Type
DemographicsSet Payload Parameter Container [ Sequence ] - N/A - DemographicsSetDType Object
  • demographics
Attribute Demographics [0.. *] demographics Array of Properties

5.2.11 SingleDemographics Service Parameter Payload Class Mapping

The UML/JSON Mapping for the "SingleDemographics" Service Parameter Payload Class is given in Table 5.2.11.

Table 5.2.11 UML/JSON Mapping for the "SingleDemographics" Service Parameter Payload Class.
Information Model Details JSON Binding Details
Name UML Artefact Data Type Multiplicity Name Type
SingleDemographics Payload Parameter Container [ Sequence ] - N/A - SingleDemographicsDType Object
  • demographics
Attribute Demographics [1] demographics Property

5.2.12 AcademicSessionSet Service Parameter Payload Class Mapping

The UML/JSON Mapping for the "AcademicSessionSet" Service Parameter Payload Class is given in Table 5.2.12.

Table 5.2.12 UML/JSON Mapping for the "AcademicSessionSet" Service Parameter Payload Class.
Information Model Details JSON Binding Details
Name UML Artefact Data Type Multiplicity Name Type
AcademicSessionSet Payload Parameter Container [ Sequence ] - N/A - AcademicSessionSetDType Object
  • academicSessions
Attribute AcademicSession [0.. *] academicSessions Array of Properties

5.2.13 SingleAcademicSession Service Parameter Payload Class Mapping

The UML/JSON Mapping for the "SingleAcademicSession" Service Parameter Payload Class is given in Table 5.2.13.

Table 5.2.13 UML/JSON Mapping for the "SingleAcademicSession" Service Parameter Payload Class.
Information Model Details JSON Binding Details
Name UML Artefact Data Type Multiplicity Name Type
SingleAcademicSession Payload Parameter Container [ Sequence ] - N/A - SingleAcademicSessionDType Object
  • academicSession
Attribute AcademicSession [1] academicSession Property

5.2.14 SingleUser Service Parameter Payload Class Mapping

The UML/JSON Mapping for the "SingleUser" Service Parameter Payload Class is given in Table 5.2.14.

Table 5.2.14 UML/JSON Mapping for the "SingleUser" Service Parameter Payload Class.
Information Model Details JSON Binding Details
Name UML Artefact Data Type Multiplicity Name Type
SingleUser Payload Parameter Container [ Sequence ] - N/A - SingleUserDType Object
  • user
Attribute User [1] user Property

5.3 Payload Classes UML/JSON Mapping

The syntax and semantics for the Data Class UML/JSON mapping representations is described in Appendix A2.2.

5.3.1 AcadSessionGUIDRef Payload Class Mapping

The Payload UML/JSON Mapping for the "AcadSessionGUIDRef" Class is given in Table 5.3.1.

Table 5.3.1 Payload UML/JSON Mapping for the "AcadSessionGUIDRef" Class.
Information Model Details JSON Binding Details
Name UML Artefact Data Type Multiplicity Name Type
AcadSessionGUIDRef Core Container [ Sequence ] AND Inherits [ GUIDRef ] - N/A - AcadSessionGUIDRefDType
Object
  • href
    [ INHERITED ]
Attribute PT: AnyURI [1] href Property
  • sourcedId
    [ INHERITED ]
Attribute DT: GUID (PT: String) [1] sourcedId Property
  • type
Attribute [ Enumeration (AcadSessionGUIDRefTypeEnum) ] [1] type Property

5.3.2 AcademicSession Payload Class Mapping

The Payload UML/JSON Mapping for the "AcademicSession" Class is given in Table 5.3.2.

Table 5.3.2 Payload UML/JSON Mapping for the "AcademicSession" Class.
Information Model Details JSON Binding Details
Name UML Artefact Data Type Multiplicity Name Type
AcademicSession Core Container [ Unordered ] AND Inherits [ Base ] - N/A - AcademicSessionDType
Object
  • sourcedId
    [ INHERITED ]
Attribute DT: GUID (PT: String) [1] sourcedId Property
  • status
    [ INHERITED ]
Attribute [ Enumeration (BaseStatusEnum) ] [1] status Property
  • dateLastModified
    [ INHERITED ]
Attribute PT: DateTime [1] dateLastModified Property
  • metadata
    [ INHERITED ]
Attribute Metadata [0..1] metadata Property
  • title
Attribute PT: NormalizedString [1] title Property
  • startDate
Attribute PT: Date [1] startDate Property
  • endDate
Attribute PT: Date [1] endDate Property
  • type
Attribute [ Union (SessionTypeEnumExt) ] [1] type Property
  • parent
Attribute AcadSessionGUIDRef [0..1] parent Property
  • children
Attribute AcadSessionGUIDRef [0.. *] children Array of Properties
  • schoolYear
Attribute PT: NormalizedString [1] schoolYear Property

5.3.3 Base Payload Class Mapping

The Payload UML/JSON Mapping for the "Base" Class is given in Table 5.3.3.

Table 5.3.3 Payload UML/JSON Mapping for the "Base" Class.
Information Model Details JSON Binding Details
Name UML Artefact Data Type Multiplicity Name Type
Base Core Container [ Sequence ] - N/A - BaseDType Object
  • sourcedId
Attribute DT: GUID (PT: String) [1] sourcedId Property
  • status
Attribute [ Enumeration (BaseStatusEnum) ] [1] status Property
  • dateLastModified
Attribute PT: DateTime [1] dateLastModified Property
  • metadata
Attribute Metadata [0..1] metadata Property

5.3.4 Class Payload Class Mapping

The Payload UML/JSON Mapping for the "Class" Class is given in Table 5.3.4.

Table 5.3.4 Payload UML/JSON Mapping for the "Class" Class.
Information Model Details JSON Binding Details
Name UML Artefact Data Type Multiplicity Name Type
Class Core Container [ Unordered ] AND Inherits [ Base ] - N/A - ClassDType
Object
  • sourcedId
    [ INHERITED ]
Attribute DT: GUID (PT: String) [1] sourcedId Property
  • status
    [ INHERITED ]
Attribute [ Enumeration (BaseStatusEnum) ] [1] status Property
  • dateLastModified
    [ INHERITED ]
Attribute PT: DateTime [1] dateLastModified Property
  • metadata
    [ INHERITED ]
Attribute Metadata [0..1] metadata Property
  • title
Attribute PT: NormalizedString [1] title Property
  • classCode
Attribute PT: NormalizedString [0..1] classCode Property
  • classType
Attribute [ Union (ClassTypeEnumExt) ] [0..1] classType Property
  • location
Attribute PT: NormalizedString [0..1] location Property
  • grades
Attribute PT: NormalizedString [0.. *] grades Array of Properties
  • subjects
Attribute PT: NormalizedString [0.. *] subjects Array of Properties
  • course
Attribute CourseGUIDRef [1] course Property
  • school
Attribute OrgGUIDRef [1] school Property
  • terms
Attribute AcadSessionGUIDRef [1.. *] terms Array of Properties
  • subjectCodes
Attribute PT: NormalizedString [0.. *] subjectCodes Array of Properties
  • periods
Attribute PT: NormalizedString [0.. *] periods Array of Properties
  • resources
Attribute ResourceGUIDRef [0.. *] resources Array of Properties

5.3.5 ClassGUIDRef Payload Class Mapping

The Payload UML/JSON Mapping for the "ClassGUIDRef" Class is given in Table 5.3.5.

Table 5.3.5 Payload UML/JSON Mapping for the "ClassGUIDRef" Class.
Information Model Details JSON Binding Details
Name UML Artefact Data Type Multiplicity Name Type
ClassGUIDRef Core Container [ Sequence ] AND Inherits [ GUIDRef ] - N/A - ClassGUIDRefDType
Object
  • href
    [ INHERITED ]
Attribute PT: AnyURI [1] href Property
  • sourcedId
    [ INHERITED ]
Attribute DT: GUID (PT: String) [1] sourcedId Property
  • type
Attribute [ Enumeration (ClassGUIDRefTypeEnum) ] [1] type Property

5.3.6 Course Payload Class Mapping

The Payload UML/JSON Mapping for the "Course" Class is given in Table 5.3.6.

Table 5.3.6 Payload UML/JSON Mapping for the "Course" Class.
Information Model Details JSON Binding Details
Name UML Artefact Data Type Multiplicity Name Type
Course Core Container [ Unordered ] AND Inherits [ Base ] - N/A - CourseDType
Object
  • sourcedId
    [ INHERITED ]
Attribute DT: GUID (PT: String) [1] sourcedId Property
  • status
    [ INHERITED ]
Attribute [ Enumeration (BaseStatusEnum) ] [1] status Property
  • dateLastModified
    [ INHERITED ]
Attribute PT: DateTime [1] dateLastModified Property
  • metadata
    [ INHERITED ]
Attribute Metadata [0..1] metadata Property
  • title
Attribute PT: NormalizedString [1] title Property
  • schoolYear
Attribute AcadSessionGUIDRef [0..1] schoolYear Property
  • courseCode
Attribute PT: NormalizedString [1] courseCode Property
  • grades
Attribute PT: NormalizedString [0.. *] grades Array of Properties
  • subjects
Attribute PT: NormalizedString [0.. *] subjects Array of Properties
  • org
Attribute OrgGUIDRef [0..1] org Property
  • subjectCodes
Attribute PT: NormalizedString [0.. *] subjectCodes Array of Properties
  • resources
Attribute ResourceGUIDRef [0.. *] resources Array of Properties

5.3.7 CourseGUIDRef Payload Class Mapping

The Payload UML/JSON Mapping for the "CourseGUIDRef" Class is given in Table 5.3.7.

Table 5.3.7 Payload UML/JSON Mapping for the "CourseGUIDRef" Class.
Information Model Details JSON Binding Details
Name UML Artefact Data Type Multiplicity Name Type
CourseGUIDRef Core Container [ Sequence ] AND Inherits [ GUIDRef ] - N/A - CourseGUIDRefDType
Object
  • href
    [ INHERITED ]
Attribute PT: AnyURI [1] href Property
  • sourcedId
    [ INHERITED ]
Attribute DT: GUID (PT: String) [1] sourcedId Property
  • type
Attribute [ Enumeration (CourseGUIDRefTypeEnum) ] [1] type Property

5.3.8 Credential Payload Class Mapping

The Payload UML/JSON Mapping for the "Credential" Class is given in Table 5.3.8.

Table 5.3.8 Payload UML/JSON Mapping for the "Credential" Class.
Information Model Details JSON Binding Details
Name UML Artefact Data Type Multiplicity Name Type
Credential Core Container [ Unordered ] - N/A - CredentialDType Object
  • type
Attribute PT: String [1] type Property
  • username
Attribute PT: NormalizedString [1] username Property
  • password
Attribute PT: String [0..1] password Property
  • extensions
Attribute PT: Namespace [0.. *] Set of Proprietary Properties Set of Proprietary Properties

5.3.9 Demographics Payload Class Mapping

The Payload UML/JSON Mapping for the "Demographics" Class is given in Table 5.3.9.

Table 5.3.9 Payload UML/JSON Mapping for the "Demographics" Class.
Information Model Details JSON Binding Details
Name UML Artefact Data Type Multiplicity Name Type
Demographics Core Container [ Unordered ] AND Inherits [ Base ] - N/A - DemographicsDType
Object
  • sourcedId
    [ INHERITED ]
Attribute DT: GUID (PT: String) [1] sourcedId Property
  • status
    [ INHERITED ]
Attribute [ Enumeration (BaseStatusEnum) ] [1] status Property
  • dateLastModified
    [ INHERITED ]
Attribute PT: DateTime [1] dateLastModified Property
  • metadata
    [ INHERITED ]
Attribute Metadata [0..1] metadata Property
  • birthDate
Attribute PT: Date [0..1] birthDate Property
  • sex
Attribute [ Union (GenderEnumExt) ] [0..1] sex Property
  • americanIndianOrAlaskaNative
Attribute [ Enumeration (TrueFalseEnum) ] [0..1] americanIndianOrAlaskaNative Property
  • asian
Attribute [ Enumeration (TrueFalseEnum) ] [0..1] asian Property
  • blackOrAfricanAmerican
Attribute [ Enumeration (TrueFalseEnum) ] [0..1] blackOrAfricanAmerican Property
  • nativeHawaiianOrOtherPacificIslander
Attribute [ Enumeration (TrueFalseEnum) ] [0..1] nativeHawaiianOrOtherPacificIslander Property
  • white
Attribute [ Enumeration (TrueFalseEnum) ] [0..1] white Property
  • demographicRaceTwoOrMoreRaces
Attribute [ Enumeration (TrueFalseEnum) ] [0..1] demographicRaceTwoOrMoreRaces Property
  • hispanicOrLatinoEthnicity
Attribute [ Enumeration (TrueFalseEnum) ] [0..1] hispanicOrLatinoEthnicity Property
  • countryOfBirthCode
Attribute PT: NormalizedString [0..1] countryOfBirthCode Property
  • stateOfBirthAbbreviation
Attribute PT: NormalizedString [0..1] stateOfBirthAbbreviation Property
  • cityOfBirth
Attribute PT: NormalizedString [0..1] cityOfBirth Property
  • publicSchoolResidenceStatus
Attribute PT: NormalizedString [0..1] publicSchoolResidenceStatus Property

5.3.10 Enrollment Payload Class Mapping

The Payload UML/JSON Mapping for the "Enrollment" Class is given in Table 5.3.10.

Table 5.3.10 Payload UML/JSON Mapping for the "Enrollment" Class.
Information Model Details JSON Binding Details
Name UML Artefact Data Type Multiplicity Name Type
Enrollment Core Container [ Unordered ] AND Inherits [ Base ] - N/A - EnrollmentDType
Object
  • sourcedId
    [ INHERITED ]
Attribute DT: GUID (PT: String) [1] sourcedId Property
  • status
    [ INHERITED ]
Attribute [ Enumeration (BaseStatusEnum) ] [1] status Property
  • dateLastModified
    [ INHERITED ]
Attribute PT: DateTime [1] dateLastModified Property
  • metadata
    [ INHERITED ]
Attribute Metadata [0..1] metadata Property
  • user
Attribute UserGUIDRef [1] user Property
  • class
Attribute ClassGUIDRef [1] class Property
  • school
Attribute OrgGUIDRef [1] school Property
  • role
Attribute [ Union (RoleEnumExt) ] [1] role Property
  • primary
Attribute [ Enumeration (TrueFalseEnum) ] [0..1] primary Property
  • beginDate
Attribute PT: Date [0..1] beginDate Property
  • endDate
Attribute PT: Date [0..1] endDate Property

5.3.11 GUIDRef Payload Class Mapping

The Payload UML/JSON Mapping for the "GUIDRef" Class is given in Table 5.3.11.

Table 5.3.11 Payload UML/JSON Mapping for the "GUIDRef" Class.
Information Model Details JSON Binding Details
Name UML Artefact Data Type Multiplicity Name Type
GUIDRef Core Container [ Sequence ] - N/A - GUIDRefDType Object
  • href
Attribute PT: AnyURI [1] href Property
  • sourcedId
Attribute DT: GUID (PT: String) [1] sourcedId Property

5.3.12 Metadata Payload Class Mapping

The Payload UML/JSON Mapping for the "Metadata" Class is given in Table 5.3.12.

Table 5.3.12 Payload UML/JSON Mapping for the "Metadata" Class.
Information Model Details JSON Binding Details
Name UML Artefact Data Type Multiplicity Name Type
Metadata Core Container [ Sequence ] - N/A - MetadataDType Object
  • extensions
Attribute PT: Namespace [0.. *] Set of Proprietary Properties Set of Proprietary Properties

5.3.13 Org Payload Class Mapping

The Payload UML/JSON Mapping for the "Org" Class is given in Table 5.3.13.

Table 5.3.13 Payload UML/JSON Mapping for the "Org" Class.
Information Model Details JSON Binding Details
Name UML Artefact Data Type Multiplicity Name Type
Org Core Container [ Unordered ] AND Inherits [ Base ] - N/A - OrgDType
Object
  • sourcedId
    [ INHERITED ]
Attribute DT: GUID (PT: String) [1] sourcedId Property
  • status
    [ INHERITED ]
Attribute [ Enumeration (BaseStatusEnum) ] [1] status Property
  • dateLastModified
    [ INHERITED ]
Attribute PT: DateTime [1] dateLastModified Property
  • metadata
    [ INHERITED ]
Attribute Metadata [0..1] metadata Property
  • name
Attribute PT: NormalizedString [1] name Property
  • type
Attribute [ Union (OrgTypeEnumExt) ] [1] type Property
  • identifier
Attribute DT: Identifier (PT: String) [1] identifier Property
  • parent
Attribute OrgGUIDRef [0..1] parent Property
  • children
Attribute OrgGUIDRef [0.. *] children Array of Properties

5.3.14 OrgGUIDRef Payload Class Mapping

The Payload UML/JSON Mapping for the "OrgGUIDRef" Class is given in Table 5.3.14.

Table 5.3.14 Payload UML/JSON Mapping for the "OrgGUIDRef" Class.
Information Model Details JSON Binding Details
Name UML Artefact Data Type Multiplicity Name Type
OrgGUIDRef Core Container [ Sequence ] AND Inherits [ GUIDRef ] - N/A - OrgGUIDRefDType
Object
  • href
    [ INHERITED ]
Attribute PT: AnyURI [1] href Property
  • sourcedId
    [ INHERITED ]
Attribute DT: GUID (PT: String) [1] sourcedId Property
  • type
Attribute [ Enumeration (OrgGUIDRefTypeEnum) ] [1] type Property

5.3.15 ResourceGUIDRef Payload Class Mapping

The Payload UML/JSON Mapping for the "ResourceGUIDRef" Class is given in Table 5.3.15.

Table 5.3.15 Payload UML/JSON Mapping for the "ResourceGUIDRef" Class.
Information Model Details JSON Binding Details
Name UML Artefact Data Type Multiplicity Name Type
ResourceGUIDRef Core Container [ Sequence ] AND Inherits [ GUIDRef ] - N/A - ResourceGUIDRefDType
Object
  • href
    [ INHERITED ]
Attribute PT: AnyURI [1] href Property
  • sourcedId
    [ INHERITED ]
Attribute DT: GUID (PT: String) [1] sourcedId Property
  • type
Attribute [ Enumeration (ResourceGUIDRefTypeEnum) ] [1] type Property

5.3.16 Role Payload Class Mapping

The Payload UML/JSON Mapping for the "Role" Class is given in Table 5.3.16.

Table 5.3.16 Payload UML/JSON Mapping for the "Role" Class.
Information Model Details JSON Binding Details
Name UML Artefact Data Type Multiplicity Name Type
Role Core Container [ Unordered ] - N/A - RoleDType Object
  • roleType
Attribute [ Enumeration (RoleTypeEnum) ] [1] roleType Property
  • role
Attribute [ Union (RoleEnumExt) ] [1] role Property
  • org
Attribute OrgGUIDRef [1] org Property
  • userProfile
Attribute PT: AnyURI [0..1] userProfile Property
  • beginDate
Attribute PT: Date [0..1] beginDate Property
  • endDate
Attribute PT: Date [0..1] endDate Property

5.3.17 User Payload Class Mapping

The Payload UML/JSON Mapping for the "User" Class is given in Table 5.3.17.

Table 5.3.17 Payload UML/JSON Mapping for the "User" Class.
Information Model Details JSON Binding Details
Name UML Artefact Data Type Multiplicity Name Type
User Core Container [ Unordered ] AND Inherits [ Base ] - N/A - UserDType
Object
  • sourcedId
    [ INHERITED ]
Attribute DT: GUID (PT: String) [1] sourcedId Property
  • status
    [ INHERITED ]
Attribute [ Enumeration (BaseStatusEnum) ] [1] status Property
  • dateLastModified
    [ INHERITED ]
Attribute PT: DateTime [1] dateLastModified Property
  • metadata
    [ INHERITED ]
Attribute Metadata [0..1] metadata Property
  • userMasterIdentifier
Attribute PT: NormalizedString [0..1] userMasterIdentifier Property
  • username
Attribute PT: NormalizedString [0..1] username Property
  • userIds
Attribute UserId [0.. *] userIds Array of Properties
  • enabledUser
Attribute [ Enumeration (TrueFalseEnum) ] [1] enabledUser Property
  • givenName
Attribute PT: NormalizedString [1] givenName Property
  • familyName
Attribute PT: NormalizedString [1] familyName Property
  • middleName
Attribute PT: NormalizedString [0..1] middleName Property
  • preferredFirstName
Attribute PT: NormalizedString [0..1] preferredFirstName Property
  • preferredMiddleName
Attribute PT: NormalizedString [0..1] preferredMiddleName Property
  • preferredLastName
Attribute PT: NormalizedString [0..1] preferredLastName Property
  • roles
Attribute Role [1.. *] roles Array of Properties
  • userProfiles
Attribute UserProfile [0.. *] userProfiles Array of Properties
  • primaryOrg
Attribute OrgGUIDRef [0..1] primaryOrg Property
  • identifier
Attribute DT: Identifier (PT: String) [0..1] identifier Property
  • email
Attribute PT: NormalizedString [0..1] email Property
  • sms
Attribute PT: NormalizedString [0..1] sms Property
  • phone
Attribute PT: NormalizedString [0..1] phone Property
  • agents
Attribute UserGUIDRef [0.. *] agents Array of Properties
  • grades
Attribute PT: NormalizedString [0.. *] grades Array of Properties
  • password
Attribute PT: String [0..1] password Property
  • resources
Attribute ResourceGUIDRef [0.. *] resources Array of Properties

5.3.18 UserGUIDRef Payload Class Mapping

The Payload UML/JSON Mapping for the "UserGUIDRef" Class is given in Table 5.3.18.

Table 5.3.18 Payload UML/JSON Mapping for the "UserGUIDRef" Class.
Information Model Details JSON Binding Details
Name UML Artefact Data Type Multiplicity Name Type
UserGUIDRef Core Container [ Sequence ] AND Inherits [ GUIDRef ] - N/A - UserGUIDRefDType
Object
  • href
    [ INHERITED ]
Attribute PT: AnyURI [1] href Property
  • sourcedId
    [ INHERITED ]
Attribute DT: GUID (PT: String) [1] sourcedId Property
  • type
Attribute [ Enumeration (UserGUIDRefTypeEnum) ] [1] type Property

5.3.19 UserId Payload Class Mapping

The Payload UML/JSON Mapping for the "UserId" Class is given in Table 5.3.19.

Table 5.3.19 Payload UML/JSON Mapping for the "UserId" Class.
Information Model Details JSON Binding Details
Name UML Artefact Data Type Multiplicity Name Type
UserId Core Container [ Sequence ] - N/A - UserIdDType Object
  • type
Attribute PT: NormalizedString [1] type Property
  • identifier
Attribute DT: Identifier (PT: String) [1] identifier Property

5.3.20 UserProfile Payload Class Mapping

The Payload UML/JSON Mapping for the "UserProfile" Class is given in Table 5.3.20.

Table 5.3.20 Payload UML/JSON Mapping for the "UserProfile" Class.
Information Model Details JSON Binding Details
Name UML Artefact Data Type Multiplicity Name Type
UserProfile Core Container [ Unordered ] - N/A - UserProfileDType Object
  • profileId
Attribute PT: AnyURI [1] profileId Property
  • profileType
Attribute PT: NormalizedString [1] profileType Property
  • vendorId
Attribute PT: NormalizedString [1] vendorId Property
  • applicationId
Attribute PT: NormalizedString [0..1] applicationId Property
  • description
Attribute PT: String [0..1] description Property
  • credentials
Attribute Credential [0.. *] credentials Array of Properties

5.3.21 imsx_CodeMinor Payload Class Mapping

The Payload UML/JSON Mapping for the "imsx_CodeMinor" Class is given in Table 5.3.21.

Table 5.3.21 Payload UML/JSON Mapping for the "imsx_CodeMinor" Class.
Information Model Details JSON Binding Details
Name UML Artefact Data Type Multiplicity Name Type
imsx_CodeMinor Core Container [ Sequence ] - N/A - imsx_CodeMinorDType Object
  • imsx_codeMinorField
Attribute imsx_CodeMinorField [1.. *] imsx_codeMinorField Array of Properties

5.3.22 imsx_CodeMinorField Payload Class Mapping

The Payload UML/JSON Mapping for the "imsx_CodeMinorField" Class is given in Table 5.3.22.

Table 5.3.22 Payload UML/JSON Mapping for the "imsx_CodeMinorField" Class.
Information Model Details JSON Binding Details
Name UML Artefact Data Type Multiplicity Name Type
imsx_CodeMinorField Core Container [ Sequence ] - N/A - imsx_CodeMinorFieldDType Object
  • imsx_codeMinorFieldName
Attribute PT: NormalizedString [1] imsx_codeMinorFieldName Property
  • imsx_codeMinorFieldValue
Attribute [ Enumeration (imsx_CodeMinorValueEnum) ] [1] imsx_codeMinorFieldValue Property

5.3.23 imsx_StatusInfo Payload Class Mapping

The Payload UML/JSON Mapping for the "imsx_StatusInfo" Class is given in Table 5.3.23.

Table 5.3.23 Payload UML/JSON Mapping for the "imsx_StatusInfo" Class.
Information Model Details JSON Binding Details
Name UML Artefact Data Type Multiplicity Name Type
imsx_StatusInfo Core Container [ Sequence ] - N/A - imsx_StatusInfoDType Object
  • imsx_codeMajor
Attribute [ Enumeration (imsx_CodeMajorEnum) ] [1] imsx_codeMajor Property
  • imsx_severity
Attribute [ Enumeration (imsx_SeverityEnum) ] [1] imsx_severity Property
  • imsx_description
Attribute PT: String [0..1] imsx_description Property
  • imsx_CodeMinor
Attribute imsx_CodeMinor [0..1] imsx_CodeMinor Property

5.4 Enumerated Class UML/JSON Mapping

The definition of the set of enumerated data-types used in this specification is given in Table 5.4. The syntax and semantics for the Enumerated Class UML/JSON mapping representations is described in Appendix A2.3.

Table 5.4 The UML/JSON Map Enumerated Class Definitions.
Enumeration Class Name Description
AcadSessionGUIDRefTypeEnum Enumerated value set of: { academicSession }.
BaseStatusEnum Enumerated value set of: { active | tobedeleted }.
ClassGUIDRefTypeEnum Enumerated value set of: { class }.
ClassTypeEnum Enumerated value set of: { homeroom | scheduled }.
CourseGUIDRefTypeEnum Enumerated value set of: { course }.
GenderEnum Enumerated value set of: { male | female | unspecified | other }.
ImportanceEnum Enumerated value set of: { primary | secondary }.
OrgGUIDRefTypeEnum Enumerated value set of: { org }.
OrgTypeEnum Enumerated value set of: { department | district | local | national | school | state }.
ResourceGUIDRefTypeEnum Enumerated value set of: { resource }.
RoleEnum Enumerated value set of: { aide | counselor | districtAdministrator | guardian | parent | principal | proctor | relative | siteAdministrator | student | systemAdministrator | teacher }.
RoleTypeEnum Enumerated value set of: { primary | secondary }.
SessionTypeEnum Enumerated value set of: { gradingPeriod | semester | schoolYear | term }.
TrueFalseEnum Enumerated value set of: { true | false }.
UserGUIDRefTypeEnum Enumerated value set of: { user }.
imsx_CodeMajorEnum Enumerated value set of: { success | processing | failure | unsupported }.
imsx_CodeMinorValueEnum Enumerated value set of: { fullsuccess | invalid_filter_field | invalid_selection_field | invaliddata | unauthorisedrequest | forbidden | server_busy | unknownobject | internal_server_error }.
imsx_SeverityEnum Enumerated value set of: { status | warning | error }.

5.5 Enumerated List Class UML/JSON Mapping

There are no enumerated list class definitions.

5.6 Union Class UML/JSON Mapping

The definition of the set of union data-types used in this specification is given in Table 5.6. The syntax and semantics for the Union Class UML/JSON mapping representations is described in Appendix A2.4.

Table 5.6 The UML/JSON Map Union Class Definitions.
Union Class Name Description
ClassTypeEnumExt This is a value from one of the set of data-types: ClassTypeEnum, EnumExtString
GenderEnumExt This is a value from one of the set of data-types: GenderEnum, EnumExtString
OrgTypeEnumExt This is a value from one of the set of data-types: OrgTypeEnum, EnumExtString
RoleEnumExt This is a value from one of the set of data-types: RoleEnum, EnumExtString
SessionTypeEnumExt This is a value from one of the set of data-types: SessionTypeEnum, EnumExtString

5.7 Primitive Type UML/JSON Mapping

The definition of the set of primitive data-types used in this specification is given in Table 5.7. The syntax and semantics for the Primitive Type UML/JSON mapping representations is described in Appendix A2.4.

Table 5.7 The UML/JSON Map Primitive Type Definitions.
Primitive Type Name Description
AnyURI This is mapped to the JSON "string" data-type with the format of "uri".
Date This is mapped to the JSON "string" data-type with the format of "date".
DateTime This is mapped to the JSON "string" data-type with the format of "dateTime".
Namespace This denotes an extension facility. The class is permitted to have proprietary JSON properties i.e. "additionalProperties: true".
NormalizedString This is mapped to the JSON "string" data-type.
String This is mapped to the JSON "string" data-type.

toc | top

6. JSON Payloads

This Section is NOT NORMATIVE.

6.1 "getAcademicSession" Request Payload

There is no payload for this request.

6.2 "getAcademicSession" Response Payloads

6.2.1 Response Payloads for the HTTP Codes (default, 400, 401, 403, 404, 422, 429, 500)

A tabular description of the response payload is shown in the Table below.

Table 6.2.1 - Tabular representation of the JSON payload for "default, 400, 401, 403, 404, 422, 429, 500" response messages for a "getAcademicSession" operation.
Property Name Multiplicity JSON Data-type Description
    imsx_codeMajor [1..1] Enumeration The code major value (from the corresponding enumerated vocabulary). See Appendix B for further information on the interpretation of this set of codes. The permitted vocabulary for the values for the CodeMajor field.
    imsx_severity [1..1] Enumeration The severity value (from the corresponding enumerated vocabulary). See Appendix B for further information on the interpretation of this set of codes.
    imsx_description [0..1] String A human readable description supplied by the entity creating the status code information.
    imsx_CodeMinor [0..1] Object The set of reported code minor status codes. See Appendix B for further information on the interpretation of this set of codes.
            imsx_codeMinorField [1..*] Array [ Object ] Each reported code minor status code.
                    imsx_codeMinorFieldName [1..1] String This should contain the identity of the system that has produced the code minor status code report. In most cases this will be the target service provider denoted as 'TargetEndSystem'.
                    imsx_codeMinorFieldValue [1..1] Enumeration The code minor status code (this is a value from the corresponding enumerated vocabulary).

An example of the response JSON payload is shown in the code block below. The JSON Schema file that can be used to validate this payload is given in Appendix C1.1b.

Code 6.2.1 - JSON payload example for "default, 400, 401, 403, 404, 422, 429, 500" response messages for a "getAcademicSession" operation.
    {
        "imsx_codeMajor" : "success"|"processing"|"failure"|"unsupported",
        "imsx_severity" : "status"|"warning"|"error",
        "imsx_description" : "..String..",
        "imsx_CodeMinor" : {
            "imsx_codeMinorField" : [
                {
                    "imsx_codeMinorFieldName" : "..NormalizedString..",
                    "imsx_codeMinorFieldValue" : "fullsuccess"|"invalid_filter_field"|"invalid_selection_field"|"invaliddata"|"unauthorisedrequest"|"forbidden"|"server_busy"|"unknownobject"|"internal_server_error"
                },
                {...},
                {...}
            ]
        }
    }
                        

6.2.2 Response Payloads for the HTTP Codes (200)

A tabular description of the response payload is shown in the Table below.

Table 6.2.2 - Tabular representation of the JSON payload for "200" response messages for a "getAcademicSession" operation.
Property Name Multiplicity JSON Data-type Description
    academicSession [1..1] Object The instance of the single academicSession for a message payload. There must be a data payload otherwise an error report payload for the record not being located should be returned.
            sourcedId [1..1] String The sourcedId of the object. All objects MUST be identified by a Source Identifier. This is a GUID System ID for an object. This is the GUID that SYSTEMS will refer to when making API calls, or when needing to identify an object. It is RECOMMENDED that systems are able to map whichever local ids (e.g. database key fields) they use to SourcedId. The sourcedId of an object is considered an addressable property of an entity and as such will not be treated as Personally Identifiable Information (PII) by certified products. Therefore, as a part of certification, vendors will be required to declare that they will notify customers via documentation or other formal and documented agreement that sourcedIds should never contain PII in general, but particularly users. This means that if a customer includes a student name in an enrollment.sourcedId, it will not fall to any certified product to protect the enrollment.sourcedId as PII, or even the userSourcedId field in the enrollment record.
            status [1..1] Enumeration All objects MUST BE either 'active' or 'tobedeleted'. Something which is flagged 'tobedeleted' is to be considered safe to delete. Systems can delete records that are flagged as such if they wish, but they are not under any compulsion to do so. In v1.1 the enumeration value of 'inactive' was removed and so for backwards compatibility all such marked objects should be interpreted as 'tobedeleted'.
            dateLastModified [1..1] String (Format: date-time) All objects MUST be annotated with the dateTime upon which they were last modified. This enables requesters to query for just the latest objects. DateTimes MUST be expressed in W3C profile of [ISO 8601] and MUST contain the UTC timezone.
            metadata [0..1] Object All objects CAN be extended using the Metadata class. This specification is silent on what implementers may consider to be appropriate extensions. The form of the extension is dependent on the binding technology being used.
                    extensions [0..*] Set of Proprietary Properties The form of the extension is dependent on the binding technology being used. This specification is silent on what implementers may consider to be appropriate extensions.
            title [1..1] String The title/label for the academic session.
            startDate [1..1] String (Format: date) The start date for the academic session. The start date is included in the academic session. This is in [ISO 8601] format of 'YYYY-MM-DD'.
            endDate [1..1] String (Format: date) The end date for the academic session. The end date is excluded from the academic session. This is in [ISO 8601] format of 'YYYY-MM-DD'.
            type [1..1] Union(SessionTypeEnumExt) The type of academic session. This is based upon an enumerated vocabulary.
            parent [0..1] Object The link to parent AcademicSession i.e. an AcademicSession 'sourcedId'.
                    href [1..1] String (Format: uri) The URI for the type of object being referenced.
                    sourcedId [1..1] String The globally unique identifier of the object being referenced.
                    type [1..1] Enumeration The type of object being referenced i.e. an 'academicSession'.
            children [0..*] Array [ Object ] The set of links to the child AcademicSessions i.e. a set of AcademicSession 'sourcedIds'.
                    href [1..1] String (Format: uri) The URI for the type of object being referenced.
                    sourcedId [1..1] String The globally unique identifier of the object being referenced.
                    type [1..1] Enumeration The type of object being referenced i.e. an 'academicSession'.
            schoolYear [1..1] String The school year for the academic session. This year should include the school year end e.g. 2014. This is in the [ISO 8601] format of 'YYYY'.

An example of the response JSON payload is shown in the code block below. The JSON Schema file that can be used to validate this payload is given in Appendix C1.1c.

Code 6.2.2 - JSON payload example for "200" response messages for a "getAcademicSession" operation.
    {
        "academicSession" : {
            "sourcedId" : "..String..",
            "status" : "active"|"tobedeleted",
            "dateLastModified" : "..Date/Time..",
            "metadata" : {
                "..permitted extension point.." : "..user defined value.."
            },
            "title" : "..NormalizedString..",
            "startDate" : "..String(Date)..",
            "endDate" : "..String(Date)..",
            "type" : "..select from Union..",
            "parent" : {
                "href" : "..URI..",
                "sourcedId" : "..String..",
                "type" : "academicSession"
            },
            "children" : [
                {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "academicSession"
                },
                {...},
                {...}
            ],
            "schoolYear" : "..NormalizedString.."
        }
    }
                        

6.3 "getAllAcademicSessions" Request Payload

There is no payload for this request.

6.4 "getAllAcademicSessions" Response Payloads

6.4.1 Response Payloads for the HTTP Codes (default, 400, 401, 403, 422, 429, 500)

A tabular description of the response payload is shown in the Table below.

Table 6.4.1 - Tabular representation of the JSON payload for "default, 400, 401, 403, 422, 429, 500" response messages for a "getAllAcademicSessions" operation.
Property Name Multiplicity JSON Data-type Description
    imsx_codeMajor [1..1] Enumeration The code major value (from the corresponding enumerated vocabulary). See Appendix B for further information on the interpretation of this set of codes. The permitted vocabulary for the values for the CodeMajor field.
    imsx_severity [1..1] Enumeration The severity value (from the corresponding enumerated vocabulary). See Appendix B for further information on the interpretation of this set of codes.
    imsx_description [0..1] String A human readable description supplied by the entity creating the status code information.
    imsx_CodeMinor [0..1] Object The set of reported code minor status codes. See Appendix B for further information on the interpretation of this set of codes.
            imsx_codeMinorField [1..*] Array [ Object ] Each reported code minor status code.
                    imsx_codeMinorFieldName [1..1] String This should contain the identity of the system that has produced the code minor status code report. In most cases this will be the target service provider denoted as 'TargetEndSystem'.
                    imsx_codeMinorFieldValue [1..1] Enumeration The code minor status code (this is a value from the corresponding enumerated vocabulary).

An example of the response JSON payload is shown in the code block below. The JSON Schema file that can be used to validate this payload is given in Appendix C1.2b.

Code 6.4.1 - JSON payload example for "default, 400, 401, 403, 422, 429, 500" response messages for a "getAllAcademicSessions" operation.
    {
        "imsx_codeMajor" : "success"|"processing"|"failure"|"unsupported",
        "imsx_severity" : "status"|"warning"|"error",
        "imsx_description" : "..String..",
        "imsx_CodeMinor" : {
            "imsx_codeMinorField" : [
                {
                    "imsx_codeMinorFieldName" : "..NormalizedString..",
                    "imsx_codeMinorFieldValue" : "fullsuccess"|"invalid_filter_field"|"invalid_selection_field"|"invaliddata"|"unauthorisedrequest"|"forbidden"|"server_busy"|"unknownobject"|"internal_server_error"
                },
                {...},
                {...}
            ]
        }
    }
                        

6.4.2 Response Payloads for the HTTP Codes (200)

A tabular description of the response payload is shown in the Table below.

Table 6.4.2 - Tabular representation of the JSON payload for "200" response messages for a "getAllAcademicSessions" operation.
Property Name Multiplicity JSON Data-type Description
    academicSessions [0..*] Array [ Object ] The collection of academicSession instances. The order is not significant. The corresponding query constraints may result in no instances being returned.
            sourcedId [1..1] String The sourcedId of the object. All objects MUST be identified by a Source Identifier. This is a GUID System ID for an object. This is the GUID that SYSTEMS will refer to when making API calls, or when needing to identify an object. It is RECOMMENDED that systems are able to map whichever local ids (e.g. database key fields) they use to SourcedId. The sourcedId of an object is considered an addressable property of an entity and as such will not be treated as Personally Identifiable Information (PII) by certified products. Therefore, as a part of certification, vendors will be required to declare that they will notify customers via documentation or other formal and documented agreement that sourcedIds should never contain PII in general, but particularly users. This means that if a customer includes a student name in an enrollment.sourcedId, it will not fall to any certified product to protect the enrollment.sourcedId as PII, or even the userSourcedId field in the enrollment record.
            status [1..1] Enumeration All objects MUST BE either 'active' or 'tobedeleted'. Something which is flagged 'tobedeleted' is to be considered safe to delete. Systems can delete records that are flagged as such if they wish, but they are not under any compulsion to do so. In v1.1 the enumeration value of 'inactive' was removed and so for backwards compatibility all such marked objects should be interpreted as 'tobedeleted'.
            dateLastModified [1..1] String (Format: date-time) All objects MUST be annotated with the dateTime upon which they were last modified. This enables requesters to query for just the latest objects. DateTimes MUST be expressed in W3C profile of [ISO 8601] and MUST contain the UTC timezone.
            metadata [0..1] Object All objects CAN be extended using the Metadata class. This specification is silent on what implementers may consider to be appropriate extensions. The form of the extension is dependent on the binding technology being used.
                    extensions [0..*] Set of Proprietary Properties The form of the extension is dependent on the binding technology being used. This specification is silent on what implementers may consider to be appropriate extensions.
            title [1..1] String The title/label for the academic session.
            startDate [1..1] String (Format: date) The start date for the academic session. The start date is included in the academic session. This is in [ISO 8601] format of 'YYYY-MM-DD'.
            endDate [1..1] String (Format: date) The end date for the academic session. The end date is excluded from the academic session. This is in [ISO 8601] format of 'YYYY-MM-DD'.
            type [1..1] Union(SessionTypeEnumExt) The type of academic session. This is based upon an enumerated vocabulary.
            parent [0..1] Object The link to parent AcademicSession i.e. an AcademicSession 'sourcedId'.
                    href [1..1] String (Format: uri) The URI for the type of object being referenced.
                    sourcedId [1..1] String The globally unique identifier of the object being referenced.
                    type [1..1] Enumeration The type of object being referenced i.e. an 'academicSession'.
            children [0..*] Array [ Object ] The set of links to the child AcademicSessions i.e. a set of AcademicSession 'sourcedIds'.
                    href [1..1] String (Format: uri) The URI for the type of object being referenced.
                    sourcedId [1..1] String The globally unique identifier of the object being referenced.
                    type [1..1] Enumeration The type of object being referenced i.e. an 'academicSession'.
            schoolYear [1..1] String The school year for the academic session. This year should include the school year end e.g. 2014. This is in the [ISO 8601] format of 'YYYY'.

An example of the response JSON payload is shown in the code block below. The JSON Schema file that can be used to validate this payload is given in Appendix C1.2c.

Code 6.4.2 - JSON payload example for "200" response messages for a "getAllAcademicSessions" operation.
    {
        "academicSessions" : [
            {
                "sourcedId" : "..String..",
                "status" : "active"|"tobedeleted",
                "dateLastModified" : "..Date/Time..",
                "metadata" : {
                    "..permitted extension point.." : "..user defined value.."
                },
                "title" : "..NormalizedString..",
                "startDate" : "..String(Date)..",
                "endDate" : "..String(Date)..",
                "type" : "..select from Union..",
                "parent" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "academicSession"
                },
                "children" : [
                    {
                        "href" : "..URI..",
                        "sourcedId" : "..String..",
                        "type" : "academicSession"
                    },
                    {...},
                    {...}
                ],
                "schoolYear" : "..NormalizedString.."
            },
            {...},
            {...}
        ]
    }
                        

6.5 "getAllClasses" Request Payload

There is no payload for this request.

6.6 "getAllClasses" Response Payloads

6.6.1 Response Payloads for the HTTP Codes (default, 400, 401, 403, 422, 429, 500)

A tabular description of the response payload is shown in the Table below.

Table 6.6.1 - Tabular representation of the JSON payload for "default, 400, 401, 403, 422, 429, 500" response messages for a "getAllClasses" operation.
Property Name Multiplicity JSON Data-type Description
    imsx_codeMajor [1..1] Enumeration The code major value (from the corresponding enumerated vocabulary). See Appendix B for further information on the interpretation of this set of codes. The permitted vocabulary for the values for the CodeMajor field.
    imsx_severity [1..1] Enumeration The severity value (from the corresponding enumerated vocabulary). See Appendix B for further information on the interpretation of this set of codes.
    imsx_description [0..1] String A human readable description supplied by the entity creating the status code information.
    imsx_CodeMinor [0..1] Object The set of reported code minor status codes. See Appendix B for further information on the interpretation of this set of codes.
            imsx_codeMinorField [1..*] Array [ Object ] Each reported code minor status code.
                    imsx_codeMinorFieldName [1..1] String This should contain the identity of the system that has produced the code minor status code report. In most cases this will be the target service provider denoted as 'TargetEndSystem'.
                    imsx_codeMinorFieldValue [1..1] Enumeration The code minor status code (this is a value from the corresponding enumerated vocabulary).

An example of the response JSON payload is shown in the code block below. The JSON Schema file that can be used to validate this payload is given in Appendix C1.3b.

Code 6.6.1 - JSON payload example for "default, 400, 401, 403, 422, 429, 500" response messages for a "getAllClasses" operation.
    {
        "imsx_codeMajor" : "success"|"processing"|"failure"|"unsupported",
        "imsx_severity" : "status"|"warning"|"error",
        "imsx_description" : "..String..",
        "imsx_CodeMinor" : {
            "imsx_codeMinorField" : [
                {
                    "imsx_codeMinorFieldName" : "..NormalizedString..",
                    "imsx_codeMinorFieldValue" : "fullsuccess"|"invalid_filter_field"|"invalid_selection_field"|"invaliddata"|"unauthorisedrequest"|"forbidden"|"server_busy"|"unknownobject"|"internal_server_error"
                },
                {...},
                {...}
            ]
        }
    }
                        

6.6.2 Response Payloads for the HTTP Codes (200)

A tabular description of the response payload is shown in the Table below.

Table 6.6.2 - Tabular representation of the JSON payload for "200" response messages for a "getAllClasses" operation.
Property Name Multiplicity JSON Data-type Description
    classes [0..*] Array [ Object ] The collection of class instances. The order is not significant. The corresponding query constraints may result in no instances being returned.
            sourcedId [1..1] String The sourcedId of the object. All objects MUST be identified by a Source Identifier. This is a GUID System ID for an object. This is the GUID that SYSTEMS will refer to when making API calls, or when needing to identify an object. It is RECOMMENDED that systems are able to map whichever local ids (e.g. database key fields) they use to SourcedId. The sourcedId of an object is considered an addressable property of an entity and as such will not be treated as Personally Identifiable Information (PII) by certified products. Therefore, as a part of certification, vendors will be required to declare that they will notify customers via documentation or other formal and documented agreement that sourcedIds should never contain PII in general, but particularly users. This means that if a customer includes a student name in an enrollment.sourcedId, it will not fall to any certified product to protect the enrollment.sourcedId as PII, or even the userSourcedId field in the enrollment record.
            status [1..1] Enumeration All objects MUST BE either 'active' or 'tobedeleted'. Something which is flagged 'tobedeleted' is to be considered safe to delete. Systems can delete records that are flagged as such if they wish, but they are not under any compulsion to do so. In v1.1 the enumeration value of 'inactive' was removed and so for backwards compatibility all such marked objects should be interpreted as 'tobedeleted'.
            dateLastModified [1..1] String (Format: date-time) All objects MUST be annotated with the dateTime upon which they were last modified. This enables requesters to query for just the latest objects. DateTimes MUST be expressed in W3C profile of [ISO 8601] and MUST contain the UTC timezone.
            metadata [0..1] Object All objects CAN be extended using the Metadata class. This specification is silent on what implementers may consider to be appropriate extensions. The form of the extension is dependent on the binding technology being used.
                    extensions [0..*] Set of Proprietary Properties The form of the extension is dependent on the binding technology being used. This specification is silent on what implementers may consider to be appropriate extensions.
            title [1..1] String The tile/label for the class.
            classCode [0..1] String The class code.
            classType [0..1] Union(ClassTypeEnumExt) The type of class. This is based upon an enumerated vocabulary.
            location [0..1] String The location for the class e.g. 'Room 19'.
            grades [0..*] Array [ String ] The grade(s) who attend the class. The permitted vocabulary should be defined as part of the adoption and deployment process. See the Implementation Guide [OR-IMPL-12] for more details on how to define/use such a vocabulary.
            subjects [0..*] Array [ String ] The set of subjects addressed by this class e.g. 'chemistry'.
            course [1..1] Object The link to the associated course i.e. the Course 'sourcedId'.
                    href [1..1] String (Format: uri) The URI for the type of object being referenced.
                    sourcedId [1..1] String The globally unique identifier of the object being referenced.
                    type [1..1] Enumeration The type of object being referenced i.e. a 'course'.
            school [1..1] Object The link to the associated school i.e. the School 'sourcedId'.
                    href [1..1] String (Format: uri) The URI for the type of object being referenced.
                    sourcedId [1..1] String The globally unique identifier of the object being referenced.
                    type [1..1] Enumeration The type of object being referenced i.e. an 'org'.
            terms [1..*] Array [ Object ] The links to the set of terms or semesters (academicSession) i.e. the set of 'sourcedIds' for the terms within the associated school year.
                    href [1..1] String (Format: uri) The URI for the type of object being referenced.
                    sourcedId [1..1] String The globally unique identifier of the object being referenced.
                    type [1..1] Enumeration The type of object being referenced i.e. an 'academicSession'.
            subjectCodes [0..*] Array [ String ] This is a machine readable set of codes and the number should match the associated 'subjects' attribute. The vocabulary for this characteristic should be defined as part of the local addition of this specification (see the Implementation Guide [OR-IMPL-12] for more details).
            periods [0..*] Array [ String ] The time slots in the day that the class will be given. Examples are 1 or a list of 1, 3, 5, etc.
            resources [0..*] Array [ Object ] The links to the set of associated resources i.e. the Resource 'sourcedIds'.
                    href [1..1] String (Format: uri) The URI for the type of object being referenced.
                    sourcedId [1..1] String The globally unique identifier of the object being referenced.
                    type [1..1] Enumeration The type of object being referenced i.e. a 'resource'.

An example of the response JSON payload is shown in the code block below. The JSON Schema file that can be used to validate this payload is given in Appendix C1.3c.

Code 6.6.2 - JSON payload example for "200" response messages for a "getAllClasses" operation.
    {
        "classes" : [
            {
                "sourcedId" : "..String..",
                "status" : "active"|"tobedeleted",
                "dateLastModified" : "..Date/Time..",
                "metadata" : {
                    "..permitted extension point.." : "..user defined value.."
                },
                "title" : "..NormalizedString..",
                "classCode" : "..NormalizedString..",
                "classType" : "..select from Union..",
                "location" : "..NormalizedString..",
                "grades" : [ "..NormalizedString..", ..., "..NormalizedString.." ],
                "subjects" : [ "..NormalizedString..", ..., "..NormalizedString.." ],
                "course" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "course"
                },
                "school" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "org"
                },
                "terms" : [
                    {
                        "href" : "..URI..",
                        "sourcedId" : "..String..",
                        "type" : "academicSession"
                    },
                    {...},
                    {...}
                ],
                "subjectCodes" : [ "..NormalizedString..", ..., "..NormalizedString.." ],
                "periods" : [ "..NormalizedString..", ..., "..NormalizedString.." ],
                "resources" : [
                    {
                        "href" : "..URI..",
                        "sourcedId" : "..String..",
                        "type" : "resource"
                    },
                    {...},
                    {...}
                ]
            },
            {...},
            {...}
        ]
    }
                        

6.7 "getAllCourses" Request Payload

There is no payload for this request.

6.8 "getAllCourses" Response Payloads

6.8.1 Response Payloads for the HTTP Codes (default, 400, 401, 403, 429, 500, 422)

A tabular description of the response payload is shown in the Table below.

Table 6.8.1 - Tabular representation of the JSON payload for "default, 400, 401, 403, 429, 500, 422" response messages for a "getAllCourses" operation.
Property Name Multiplicity JSON Data-type Description
    imsx_codeMajor [1..1] Enumeration The code major value (from the corresponding enumerated vocabulary). See Appendix B for further information on the interpretation of this set of codes. The permitted vocabulary for the values for the CodeMajor field.
    imsx_severity [1..1] Enumeration The severity value (from the corresponding enumerated vocabulary). See Appendix B for further information on the interpretation of this set of codes.
    imsx_description [0..1] String A human readable description supplied by the entity creating the status code information.
    imsx_CodeMinor [0..1] Object The set of reported code minor status codes. See Appendix B for further information on the interpretation of this set of codes.
            imsx_codeMinorField [1..*] Array [ Object ] Each reported code minor status code.
                    imsx_codeMinorFieldName [1..1] String This should contain the identity of the system that has produced the code minor status code report. In most cases this will be the target service provider denoted as 'TargetEndSystem'.
                    imsx_codeMinorFieldValue [1..1] Enumeration The code minor status code (this is a value from the corresponding enumerated vocabulary).

An example of the response JSON payload is shown in the code block below. The JSON Schema file that can be used to validate this payload is given in Appendix C1.4b.

Code 6.8.1 - JSON payload example for "default, 400, 401, 403, 429, 500, 422" response messages for a "getAllCourses" operation.
    {
        "imsx_codeMajor" : "success"|"processing"|"failure"|"unsupported",
        "imsx_severity" : "status"|"warning"|"error",
        "imsx_description" : "..String..",
        "imsx_CodeMinor" : {
            "imsx_codeMinorField" : [
                {
                    "imsx_codeMinorFieldName" : "..NormalizedString..",
                    "imsx_codeMinorFieldValue" : "fullsuccess"|"invalid_filter_field"|"invalid_selection_field"|"invaliddata"|"unauthorisedrequest"|"forbidden"|"server_busy"|"unknownobject"|"internal_server_error"
                },
                {...},
                {...}
            ]
        }
    }
                        

6.8.2 Response Payloads for the HTTP Codes (200)

A tabular description of the response payload is shown in the Table below.

Table 6.8.2 - Tabular representation of the JSON payload for "200" response messages for a "getAllCourses" operation.
Property Name Multiplicity JSON Data-type Description
    courses [0..*] Array [ Object ] The collection of course instances. The order is not significant. The corresponding query constraints may result in no instances being returned.
            sourcedId [1..1] String The sourcedId of the object. All objects MUST be identified by a Source Identifier. This is a GUID System ID for an object. This is the GUID that SYSTEMS will refer to when making API calls, or when needing to identify an object. It is RECOMMENDED that systems are able to map whichever local ids (e.g. database key fields) they use to SourcedId. The sourcedId of an object is considered an addressable property of an entity and as such will not be treated as Personally Identifiable Information (PII) by certified products. Therefore, as a part of certification, vendors will be required to declare that they will notify customers via documentation or other formal and documented agreement that sourcedIds should never contain PII in general, but particularly users. This means that if a customer includes a student name in an enrollment.sourcedId, it will not fall to any certified product to protect the enrollment.sourcedId as PII, or even the userSourcedId field in the enrollment record.
            status [1..1] Enumeration All objects MUST BE either 'active' or 'tobedeleted'. Something which is flagged 'tobedeleted' is to be considered safe to delete. Systems can delete records that are flagged as such if they wish, but they are not under any compulsion to do so. In v1.1 the enumeration value of 'inactive' was removed and so for backwards compatibility all such marked objects should be interpreted as 'tobedeleted'.
            dateLastModified [1..1] String (Format: date-time) All objects MUST be annotated with the dateTime upon which they were last modified. This enables requesters to query for just the latest objects. DateTimes MUST be expressed in W3C profile of [ISO 8601] and MUST contain the UTC timezone.
            metadata [0..1] Object All objects CAN be extended using the Metadata class. This specification is silent on what implementers may consider to be appropriate extensions. The form of the extension is dependent on the binding technology being used.
                    extensions [0..*] Set of Proprietary Properties The form of the extension is dependent on the binding technology being used. This specification is silent on what implementers may consider to be appropriate extensions.
            title [1..1] String The title of the course.
            schoolYear [0..1] Object The link to academicSession i.e. the AcademicSession 'sourcedId'.
                    href [1..1] String (Format: uri) The URI for the type of object being referenced.
                    sourcedId [1..1] String The globally unique identifier of the object being referenced.
                    type [1..1] Enumeration The type of object being referenced i.e. an 'academicSession'.
            courseCode [1..1] String The assigned course code.
            grades [0..*] Array [ String ] Grade(s) for which the class is attended. The permitted vocabulary should be defined as part of the adoption and deployment process. See the Implementation Guide [OR-IMPL-12] for more details on how to define/use such a vocabulary.
            subjects [0..*] Array [ String ] The set of subjects addresse by this course. This is a set of human readable strings.
            org [0..1] Object The link to org i.e. the 'sourcedId' of the org.
                    href [1..1] String (Format: uri) The URI for the type of object being referenced.
                    sourcedId [1..1] String The globally unique identifier of the object being referenced.
                    type [1..1] Enumeration The type of object being referenced i.e. an 'org'.
            subjectCodes [0..*] Array [ String ] This is a machine readable set of codes and the number should match the associated 'subjects' attribute. The vocabulary for this characteristic should be defined as part of the local addition of this specification (see the Implementation Guide [OR-IMPL-12] for more details).
            resources [0..*] Array [ Object ] The links to the associated resources if applicable i.e. the resource 'sourcedIds'.
                    href [1..1] String (Format: uri) The URI for the type of object being referenced.
                    sourcedId [1..1] String The globally unique identifier of the object being referenced.
                    type [1..1] Enumeration The type of object being referenced i.e. a 'resource'.

An example of the response JSON payload is shown in the code block below. The JSON Schema file that can be used to validate this payload is given in Appendix C1.4c.

Code 6.8.2 - JSON payload example for "200" response messages for a "getAllCourses" operation.
    {
        "courses" : [
            {
                "sourcedId" : "..String..",
                "status" : "active"|"tobedeleted",
                "dateLastModified" : "..Date/Time..",
                "metadata" : {
                    "..permitted extension point.." : "..user defined value.."
                },
                "title" : "..NormalizedString..",
                "schoolYear" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "academicSession"
                },
                "courseCode" : "..NormalizedString..",
                "grades" : [ "..NormalizedString..", ..., "..NormalizedString.." ],
                "subjects" : [ "..NormalizedString..", ..., "..NormalizedString.." ],
                "org" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "org"
                },
                "subjectCodes" : [ "..NormalizedString..", ..., "..NormalizedString.." ],
                "resources" : [
                    {
                        "href" : "..URI..",
                        "sourcedId" : "..String..",
                        "type" : "resource"
                    },
                    {...},
                    {...}
                ]
            },
            {...},
            {...}
        ]
    }
                        

6.9 "getAllDemographics" Request Payload

There is no payload for this request.

6.10 "getAllDemographics" Response Payloads

6.10.1 Response Payloads for the HTTP Codes (default, 400, 401, 403, 422, 429, 500)

A tabular description of the response payload is shown in the Table below.

Table 6.10.1 - Tabular representation of the JSON payload for "default, 400, 401, 403, 422, 429, 500" response messages for a "getAllDemographics" operation.
Property Name Multiplicity JSON Data-type Description
    imsx_codeMajor [1..1] Enumeration The code major value (from the corresponding enumerated vocabulary). See Appendix B for further information on the interpretation of this set of codes. The permitted vocabulary for the values for the CodeMajor field.
    imsx_severity [1..1] Enumeration The severity value (from the corresponding enumerated vocabulary). See Appendix B for further information on the interpretation of this set of codes.
    imsx_description [0..1] String A human readable description supplied by the entity creating the status code information.
    imsx_CodeMinor [0..1] Object The set of reported code minor status codes. See Appendix B for further information on the interpretation of this set of codes.
            imsx_codeMinorField [1..*] Array [ Object ] Each reported code minor status code.
                    imsx_codeMinorFieldName [1..1] String This should contain the identity of the system that has produced the code minor status code report. In most cases this will be the target service provider denoted as 'TargetEndSystem'.
                    imsx_codeMinorFieldValue [1..1] Enumeration The code minor status code (this is a value from the corresponding enumerated vocabulary).

An example of the response JSON payload is shown in the code block below. The JSON Schema file that can be used to validate this payload is given in Appendix C1.5b.

Code 6.10.1 - JSON payload example for "default, 400, 401, 403, 422, 429, 500" response messages for a "getAllDemographics" operation.
    {
        "imsx_codeMajor" : "success"|"processing"|"failure"|"unsupported",
        "imsx_severity" : "status"|"warning"|"error",
        "imsx_description" : "..String..",
        "imsx_CodeMinor" : {
            "imsx_codeMinorField" : [
                {
                    "imsx_codeMinorFieldName" : "..NormalizedString..",
                    "imsx_codeMinorFieldValue" : "fullsuccess"|"invalid_filter_field"|"invalid_selection_field"|"invaliddata"|"unauthorisedrequest"|"forbidden"|"server_busy"|"unknownobject"|"internal_server_error"
                },
                {...},
                {...}
            ]
        }
    }
                        

6.10.2 Response Payloads for the HTTP Codes (200)

A tabular description of the response payload is shown in the Table below.

Table 6.10.2 - Tabular representation of the JSON payload for "200" response messages for a "getAllDemographics" operation.
Property Name Multiplicity JSON Data-type Description
    demographics [0..*] Array [ Object ] The collection of demographics instances. The order is not significant. The corresponding query constraints may result in no instances being returned.
            sourcedId [1..1] String The sourcedId of the object. All objects MUST be identified by a Source Identifier. This is a GUID System ID for an object. This is the GUID that SYSTEMS will refer to when making API calls, or when needing to identify an object. It is RECOMMENDED that systems are able to map whichever local ids (e.g. database key fields) they use to SourcedId. The sourcedId of an object is considered an addressable property of an entity and as such will not be treated as Personally Identifiable Information (PII) by certified products. Therefore, as a part of certification, vendors will be required to declare that they will notify customers via documentation or other formal and documented agreement that sourcedIds should never contain PII in general, but particularly users. This means that if a customer includes a student name in an enrollment.sourcedId, it will not fall to any certified product to protect the enrollment.sourcedId as PII, or even the userSourcedId field in the enrollment record.
            status [1..1] Enumeration All objects MUST BE either 'active' or 'tobedeleted'. Something which is flagged 'tobedeleted' is to be considered safe to delete. Systems can delete records that are flagged as such if they wish, but they are not under any compulsion to do so. In v1.1 the enumeration value of 'inactive' was removed and so for backwards compatibility all such marked objects should be interpreted as 'tobedeleted'.
            dateLastModified [1..1] String (Format: date-time) All objects MUST be annotated with the dateTime upon which they were last modified. This enables requesters to query for just the latest objects. DateTimes MUST be expressed in W3C profile of [ISO 8601] and MUST contain the UTC timezone.
            metadata [0..1] Object All objects CAN be extended using the Metadata class. This specification is silent on what implementers may consider to be appropriate extensions. The form of the extension is dependent on the binding technology being used.
                    extensions [0..*] Set of Proprietary Properties The form of the extension is dependent on the binding technology being used. This specification is silent on what implementers may consider to be appropriate extensions.
            birthDate [0..1] String (Format: date) the date of birth. The format is [ISO 8601] of 'YYYY-MM-DD'.
            sex [0..1] Union(GenderEnumExt) The sex of the individual. The permitted values are from an enumerated list.
            americanIndianOrAlaskaNative [0..1] Enumeration Identification of whether or not the user is an American Indian or Alaska Native ethnicity.
            asian [0..1] Enumeration Identification of whether or not the user is of Asian ethnicity.
            blackOrAfricanAmerican [0..1] Enumeration Identification of whether or not the user is black or African American ethnicity.
            nativeHawaiianOrOtherPacificIslander [0..1] Enumeration Identification of whether or not the user is Native Hawaiian or Other Pacific Islander ethnicity.
            white [0..1] Enumeration Identification of whether or not the user is of white ethnicity.
            demographicRaceTwoOrMoreRaces [0..1] Enumeration Identification of whether or not the user has a demographic of two or more race ethnicities.
            hispanicOrLatinoEthnicity [0..1] Enumeration Identification of whether or not the user is Hispanic or of Latino ethnicity.
            countryOfBirthCode [0..1] String The country of birth code. The permitted vocabulary should be defined as part of the adoption and deployment process. See the Implementation Guide [OR-IMPL-12] for more details on how to define/use such a vocabulary.
            stateOfBirthAbbreviation [0..1] String The abbreviation for the name of the state (within the United States) or extra-state jurisdiction in which a person was born. The permitted vocabulary should be defined as part of the adoption and deployment process. See the Implementation Guide [OR-IMPL-12] for more details on how to define/use such a vocabulary.
            cityOfBirth [0..1] String The name of the city in which the user was born.
            publicSchoolResidenceStatus [0..1] String An indication of the location of a person's legal residence relative to (within or outside) the boundaries of the public school attended and its administrative unit. The permitted vocabulary should be defined as part of the adoption and deployment process. See the Implementation Guide [OR-IMPL-12] for more details on how to define/use such a vocabulary.

An example of the response JSON payload is shown in the code block below. The JSON Schema file that can be used to validate this payload is given in Appendix C1.5c.

Code 6.10.2 - JSON payload example for "200" response messages for a "getAllDemographics" operation.
    {
        "demographics" : [
            {
                "sourcedId" : "..String..",
                "status" : "active"|"tobedeleted",
                "dateLastModified" : "..Date/Time..",
                "metadata" : {
                    "..permitted extension point.." : "..user defined value.."
                },
                "birthDate" : "..String(Date)..",
                "sex" : "..select from Union..",
                "americanIndianOrAlaskaNative" : "true"|"false",
                "asian" : "true"|"false",
                "blackOrAfricanAmerican" : "true"|"false",
                "nativeHawaiianOrOtherPacificIslander" : "true"|"false",
                "white" : "true"|"false",
                "demographicRaceTwoOrMoreRaces" : "true"|"false",
                "hispanicOrLatinoEthnicity" : "true"|"false",
                "countryOfBirthCode" : "..NormalizedString..",
                "stateOfBirthAbbreviation" : "..NormalizedString..",
                "cityOfBirth" : "..NormalizedString..",
                "publicSchoolResidenceStatus" : "..NormalizedString.."
            },
            {...},
            {...}
        ]
    }
                        

6.11 "getAllEnrollments" Request Payload

There is no payload for this request.

6.12 "getAllEnrollments" Response Payloads

6.12.1 Response Payloads for the HTTP Codes (default, 400, 401, 403, 422, 429, 500)

A tabular description of the response payload is shown in the Table below.

Table 6.12.1 - Tabular representation of the JSON payload for "default, 400, 401, 403, 422, 429, 500" response messages for a "getAllEnrollments" operation.
Property Name Multiplicity JSON Data-type Description
    imsx_codeMajor [1..1] Enumeration The code major value (from the corresponding enumerated vocabulary). See Appendix B for further information on the interpretation of this set of codes. The permitted vocabulary for the values for the CodeMajor field.
    imsx_severity [1..1] Enumeration The severity value (from the corresponding enumerated vocabulary). See Appendix B for further information on the interpretation of this set of codes.
    imsx_description [0..1] String A human readable description supplied by the entity creating the status code information.
    imsx_CodeMinor [0..1] Object The set of reported code minor status codes. See Appendix B for further information on the interpretation of this set of codes.
            imsx_codeMinorField [1..*] Array [ Object ] Each reported code minor status code.
                    imsx_codeMinorFieldName [1..1] String This should contain the identity of the system that has produced the code minor status code report. In most cases this will be the target service provider denoted as 'TargetEndSystem'.
                    imsx_codeMinorFieldValue [1..1] Enumeration The code minor status code (this is a value from the corresponding enumerated vocabulary).

An example of the response JSON payload is shown in the code block below. The JSON Schema file that can be used to validate this payload is given in Appendix C1.6b.

Code 6.12.1 - JSON payload example for "default, 400, 401, 403, 422, 429, 500" response messages for a "getAllEnrollments" operation.
    {
        "imsx_codeMajor" : "success"|"processing"|"failure"|"unsupported",
        "imsx_severity" : "status"|"warning"|"error",
        "imsx_description" : "..String..",
        "imsx_CodeMinor" : {
            "imsx_codeMinorField" : [
                {
                    "imsx_codeMinorFieldName" : "..NormalizedString..",
                    "imsx_codeMinorFieldValue" : "fullsuccess"|"invalid_filter_field"|"invalid_selection_field"|"invaliddata"|"unauthorisedrequest"|"forbidden"|"server_busy"|"unknownobject"|"internal_server_error"
                },
                {...},
                {...}
            ]
        }
    }
                        

6.12.2 Response Payloads for the HTTP Codes (200)

A tabular description of the response payload is shown in the Table below.

Table 6.12.2 - Tabular representation of the JSON payload for "200" response messages for a "getAllEnrollments" operation.
Property Name Multiplicity JSON Data-type Description
    enrollments [0..*] Array [ Object ] The collection of enrollment instances. The order is not significant. The corresponding query constraints may result in no instances being returned.
            sourcedId [1..1] String The sourcedId of the object. All objects MUST be identified by a Source Identifier. This is a GUID System ID for an object. This is the GUID that SYSTEMS will refer to when making API calls, or when needing to identify an object. It is RECOMMENDED that systems are able to map whichever local ids (e.g. database key fields) they use to SourcedId. The sourcedId of an object is considered an addressable property of an entity and as such will not be treated as Personally Identifiable Information (PII) by certified products. Therefore, as a part of certification, vendors will be required to declare that they will notify customers via documentation or other formal and documented agreement that sourcedIds should never contain PII in general, but particularly users. This means that if a customer includes a student name in an enrollment.sourcedId, it will not fall to any certified product to protect the enrollment.sourcedId as PII, or even the userSourcedId field in the enrollment record.
            status [1..1] Enumeration All objects MUST BE either 'active' or 'tobedeleted'. Something which is flagged 'tobedeleted' is to be considered safe to delete. Systems can delete records that are flagged as such if they wish, but they are not under any compulsion to do so. In v1.1 the enumeration value of 'inactive' was removed and so for backwards compatibility all such marked objects should be interpreted as 'tobedeleted'.
            dateLastModified [1..1] String (Format: date-time) All objects MUST be annotated with the dateTime upon which they were last modified. This enables requesters to query for just the latest objects. DateTimes MUST be expressed in W3C profile of [ISO 8601] and MUST contain the UTC timezone.
            metadata [0..1] Object All objects CAN be extended using the Metadata class. This specification is silent on what implementers may consider to be appropriate extensions. The form of the extension is dependent on the binding technology being used.
                    extensions [0..*] Set of Proprietary Properties The form of the extension is dependent on the binding technology being used. This specification is silent on what implementers may consider to be appropriate extensions.
            user [1..1] Object The link to the enrolled User i.e. the User 'sourcedId'.
                    href [1..1] String (Format: uri) The URI for the type of object being referenced.
                    sourcedId [1..1] String The globally unique identifier of the object being referenced.
                    type [1..1] Enumeration The type of object being referenced i.e. a 'user'.
            class [1..1] Object The link to the class on which the user is enrolled i.e. the Class 'sourcedId'.
                    href [1..1] String (Format: uri) The URI for the type of object being referenced.
                    sourcedId [1..1] String The globally unique identifier of the object being referenced.
                    type [1..1] Enumeration The type of object being referenced i.e. a 'class'.
            school [1..1] Object The link to the school at which the class is being provided i.e. an Org 'sourcedId'.
                    href [1..1] String (Format: uri) The URI for the type of object being referenced.
                    sourcedId [1..1] String The globally unique identifier of the object being referenced.
                    type [1..1] Enumeration The type of object being referenced i.e. an 'org'.
            role [1..1] Union(RoleEnumExt) The role of the user for this class in the school e.g teacher, student, etc. This is from an enumerated vocabulary.
            primary [0..1] Enumeration Applicable only to teachers. Only one teacher should be designated as the primary teacher for a class (this value set as 'true') in the period defined by the begin/end dates.
            beginDate [0..1] String (Format: date) The start date for the enrollment (inclusive). This date must be within the period of the associated Academic Session for the class (Term/Semester/SchoolYear). Use the [ISO 8601] format of 'YYYY-MM-DD'.
            endDate [0..1] String (Format: date) The end date for the enrollment (exclusive). This date must be within the period of the associated Academic Session for the class (Term/Semester/SchoolYear). Use the [ISO 8601] format of 'YYYY-MM-DD'.

An example of the response JSON payload is shown in the code block below. The JSON Schema file that can be used to validate this payload is given in Appendix C1.6c.

Code 6.12.2 - JSON payload example for "200" response messages for a "getAllEnrollments" operation.
    {
        "enrollments" : [
            {
                "sourcedId" : "..String..",
                "status" : "active"|"tobedeleted",
                "dateLastModified" : "..Date/Time..",
                "metadata" : {
                    "..permitted extension point.." : "..user defined value.."
                },
                "user" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "user"
                },
                "class" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "class"
                },
                "school" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "org"
                },
                "role" : "..select from Union..",
                "primary" : "true"|"false",
                "beginDate" : "..String(Date)..",
                "endDate" : "..String(Date).."
            },
            {...},
            {...}
        ]
    }
                        

6.13 "getAllGradingPeriods" Request Payload

There is no payload for this request.

6.14 "getAllGradingPeriods" Response Payloads

6.14.1 Response Payloads for the HTTP Codes (default, 400, 401, 403, 422, 429, 500)

A tabular description of the response payload is shown in the Table below.

Table 6.14.1 - Tabular representation of the JSON payload for "default, 400, 401, 403, 422, 429, 500" response messages for a "getAllGradingPeriods" operation.
Property Name Multiplicity JSON Data-type Description
    imsx_codeMajor [1..1] Enumeration The code major value (from the corresponding enumerated vocabulary). See Appendix B for further information on the interpretation of this set of codes. The permitted vocabulary for the values for the CodeMajor field.
    imsx_severity [1..1] Enumeration The severity value (from the corresponding enumerated vocabulary). See Appendix B for further information on the interpretation of this set of codes.
    imsx_description [0..1] String A human readable description supplied by the entity creating the status code information.
    imsx_CodeMinor [0..1] Object The set of reported code minor status codes. See Appendix B for further information on the interpretation of this set of codes.
            imsx_codeMinorField [1..*] Array [ Object ] Each reported code minor status code.
                    imsx_codeMinorFieldName [1..1] String This should contain the identity of the system that has produced the code minor status code report. In most cases this will be the target service provider denoted as 'TargetEndSystem'.
                    imsx_codeMinorFieldValue [1..1] Enumeration The code minor status code (this is a value from the corresponding enumerated vocabulary).

An example of the response JSON payload is shown in the code block below. The JSON Schema file that can be used to validate this payload is given in Appendix C1.7b.

Code 6.14.1 - JSON payload example for "default, 400, 401, 403, 422, 429, 500" response messages for a "getAllGradingPeriods" operation.
    {
        "imsx_codeMajor" : "success"|"processing"|"failure"|"unsupported",
        "imsx_severity" : "status"|"warning"|"error",
        "imsx_description" : "..String..",
        "imsx_CodeMinor" : {
            "imsx_codeMinorField" : [
                {
                    "imsx_codeMinorFieldName" : "..NormalizedString..",
                    "imsx_codeMinorFieldValue" : "fullsuccess"|"invalid_filter_field"|"invalid_selection_field"|"invaliddata"|"unauthorisedrequest"|"forbidden"|"server_busy"|"unknownobject"|"internal_server_error"
                },
                {...},
                {...}
            ]
        }
    }
                        

6.14.2 Response Payloads for the HTTP Codes (200)

A tabular description of the response payload is shown in the Table below.

Table 6.14.2 - Tabular representation of the JSON payload for "200" response messages for a "getAllGradingPeriods" operation.
Property Name Multiplicity JSON Data-type Description
    academicSessions [0..*] Array [ Object ] The collection of academicSession instances. The order is not significant. The corresponding query constraints may result in no instances being returned.
            sourcedId [1..1] String The sourcedId of the object. All objects MUST be identified by a Source Identifier. This is a GUID System ID for an object. This is the GUID that SYSTEMS will refer to when making API calls, or when needing to identify an object. It is RECOMMENDED that systems are able to map whichever local ids (e.g. database key fields) they use to SourcedId. The sourcedId of an object is considered an addressable property of an entity and as such will not be treated as Personally Identifiable Information (PII) by certified products. Therefore, as a part of certification, vendors will be required to declare that they will notify customers via documentation or other formal and documented agreement that sourcedIds should never contain PII in general, but particularly users. This means that if a customer includes a student name in an enrollment.sourcedId, it will not fall to any certified product to protect the enrollment.sourcedId as PII, or even the userSourcedId field in the enrollment record.
            status [1..1] Enumeration All objects MUST BE either 'active' or 'tobedeleted'. Something which is flagged 'tobedeleted' is to be considered safe to delete. Systems can delete records that are flagged as such if they wish, but they are not under any compulsion to do so. In v1.1 the enumeration value of 'inactive' was removed and so for backwards compatibility all such marked objects should be interpreted as 'tobedeleted'.
            dateLastModified [1..1] String (Format: date-time) All objects MUST be annotated with the dateTime upon which they were last modified. This enables requesters to query for just the latest objects. DateTimes MUST be expressed in W3C profile of [ISO 8601] and MUST contain the UTC timezone.
            metadata [0..1] Object All objects CAN be extended using the Metadata class. This specification is silent on what implementers may consider to be appropriate extensions. The form of the extension is dependent on the binding technology being used.
                    extensions [0..*] Set of Proprietary Properties The form of the extension is dependent on the binding technology being used. This specification is silent on what implementers may consider to be appropriate extensions.
            title [1..1] String The title/label for the academic session.
            startDate [1..1] String (Format: date) The start date for the academic session. The start date is included in the academic session. This is in [ISO 8601] format of 'YYYY-MM-DD'.
            endDate [1..1] String (Format: date) The end date for the academic session. The end date is excluded from the academic session. This is in [ISO 8601] format of 'YYYY-MM-DD'.
            type [1..1] Union(SessionTypeEnumExt) The type of academic session. This is based upon an enumerated vocabulary.
            parent [0..1] Object The link to parent AcademicSession i.e. an AcademicSession 'sourcedId'.
                    href [1..1] String (Format: uri) The URI for the type of object being referenced.
                    sourcedId [1..1] String The globally unique identifier of the object being referenced.
                    type [1..1] Enumeration The type of object being referenced i.e. an 'academicSession'.
            children [0..*] Array [ Object ] The set of links to the child AcademicSessions i.e. a set of AcademicSession 'sourcedIds'.
                    href [1..1] String (Format: uri) The URI for the type of object being referenced.
                    sourcedId [1..1] String The globally unique identifier of the object being referenced.
                    type [1..1] Enumeration The type of object being referenced i.e. an 'academicSession'.
            schoolYear [1..1] String The school year for the academic session. This year should include the school year end e.g. 2014. This is in the [ISO 8601] format of 'YYYY'.

An example of the response JSON payload is shown in the code block below. The JSON Schema file that can be used to validate this payload is given in Appendix C1.7c.

Code 6.14.2 - JSON payload example for "200" response messages for a "getAllGradingPeriods" operation.
    {
        "academicSessions" : [
            {
                "sourcedId" : "..String..",
                "status" : "active"|"tobedeleted",
                "dateLastModified" : "..Date/Time..",
                "metadata" : {
                    "..permitted extension point.." : "..user defined value.."
                },
                "title" : "..NormalizedString..",
                "startDate" : "..String(Date)..",
                "endDate" : "..String(Date)..",
                "type" : "..select from Union..",
                "parent" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "academicSession"
                },
                "children" : [
                    {
                        "href" : "..URI..",
                        "sourcedId" : "..String..",
                        "type" : "academicSession"
                    },
                    {...},
                    {...}
                ],
                "schoolYear" : "..NormalizedString.."
            },
            {...},
            {...}
        ]
    }
                        

6.15 "getAllOrgs" Request Payload

There is no payload for this request.

6.16 "getAllOrgs" Response Payloads

6.16.1 Response Payloads for the HTTP Codes (default, 400, 401, 403, 422, 429, 500)

A tabular description of the response payload is shown in the Table below.

Table 6.16.1 - Tabular representation of the JSON payload for "default, 400, 401, 403, 422, 429, 500" response messages for a "getAllOrgs" operation.
Property Name Multiplicity JSON Data-type Description
    imsx_codeMajor [1..1] Enumeration The code major value (from the corresponding enumerated vocabulary). See Appendix B for further information on the interpretation of this set of codes. The permitted vocabulary for the values for the CodeMajor field.
    imsx_severity [1..1] Enumeration The severity value (from the corresponding enumerated vocabulary). See Appendix B for further information on the interpretation of this set of codes.
    imsx_description [0..1] String A human readable description supplied by the entity creating the status code information.
    imsx_CodeMinor [0..1] Object The set of reported code minor status codes. See Appendix B for further information on the interpretation of this set of codes.
            imsx_codeMinorField [1..*] Array [ Object ] Each reported code minor status code.
                    imsx_codeMinorFieldName [1..1] String This should contain the identity of the system that has produced the code minor status code report. In most cases this will be the target service provider denoted as 'TargetEndSystem'.
                    imsx_codeMinorFieldValue [1..1] Enumeration The code minor status code (this is a value from the corresponding enumerated vocabulary).

An example of the response JSON payload is shown in the code block below. The JSON Schema file that can be used to validate this payload is given in Appendix C1.8b.

Code 6.16.1 - JSON payload example for "default, 400, 401, 403, 422, 429, 500" response messages for a "getAllOrgs" operation.
    {
        "imsx_codeMajor" : "success"|"processing"|"failure"|"unsupported",
        "imsx_severity" : "status"|"warning"|"error",
        "imsx_description" : "..String..",
        "imsx_CodeMinor" : {
            "imsx_codeMinorField" : [
                {
                    "imsx_codeMinorFieldName" : "..NormalizedString..",
                    "imsx_codeMinorFieldValue" : "fullsuccess"|"invalid_filter_field"|"invalid_selection_field"|"invaliddata"|"unauthorisedrequest"|"forbidden"|"server_busy"|"unknownobject"|"internal_server_error"
                },
                {...},
                {...}
            ]
        }
    }
                        

6.16.2 Response Payloads for the HTTP Codes (200)

A tabular description of the response payload is shown in the Table below.

Table 6.16.2 - Tabular representation of the JSON payload for "200" response messages for a "getAllOrgs" operation.
Property Name Multiplicity JSON Data-type Description
    orgs [0..*] Array [ Object ] The collection of org instances. The order is not significant. The corresponding query constraints may result in no instances being returned.
            sourcedId [1..1] String The sourcedId of the object. All objects MUST be identified by a Source Identifier. This is a GUID System ID for an object. This is the GUID that SYSTEMS will refer to when making API calls, or when needing to identify an object. It is RECOMMENDED that systems are able to map whichever local ids (e.g. database key fields) they use to SourcedId. The sourcedId of an object is considered an addressable property of an entity and as such will not be treated as Personally Identifiable Information (PII) by certified products. Therefore, as a part of certification, vendors will be required to declare that they will notify customers via documentation or other formal and documented agreement that sourcedIds should never contain PII in general, but particularly users. This means that if a customer includes a student name in an enrollment.sourcedId, it will not fall to any certified product to protect the enrollment.sourcedId as PII, or even the userSourcedId field in the enrollment record.
            status [1..1] Enumeration All objects MUST BE either 'active' or 'tobedeleted'. Something which is flagged 'tobedeleted' is to be considered safe to delete. Systems can delete records that are flagged as such if they wish, but they are not under any compulsion to do so. In v1.1 the enumeration value of 'inactive' was removed and so for backwards compatibility all such marked objects should be interpreted as 'tobedeleted'.
            dateLastModified [1..1] String (Format: date-time) All objects MUST be annotated with the dateTime upon which they were last modified. This enables requesters to query for just the latest objects. DateTimes MUST be expressed in W3C profile of [ISO 8601] and MUST contain the UTC timezone.
            metadata [0..1] Object All objects CAN be extended using the Metadata class. This specification is silent on what implementers may consider to be appropriate extensions. The form of the extension is dependent on the binding technology being used.
                    extensions [0..*] Set of Proprietary Properties The form of the extension is dependent on the binding technology being used. This specification is silent on what implementers may consider to be appropriate extensions.
            name [1..1] String The name of the organization.
            type [1..1] Union(OrgTypeEnumExt) The type of organization. This uses a predefined vocabulary.
            identifier [1..1] String Human readable identifier for this org e.g. NCES ID.
            parent [0..1] Object The 'sourcedId' of the parent organization.
                    href [1..1] String (Format: uri) The URI for the type of object being referenced.
                    sourcedId [1..1] String The globally unique identifier of the object being referenced.
                    type [1..1] Enumeration The type of object being referenced i.e. an 'org'.
            children [0..*] Array [ Object ] The 'sourcedIds' for the set of child organizations.
                    href [1..1] String (Format: uri) The URI for the type of object being referenced.
                    sourcedId [1..1] String The globally unique identifier of the object being referenced.
                    type [1..1] Enumeration The type of object being referenced i.e. an 'org'.

An example of the response JSON payload is shown in the code block below. The JSON Schema file that can be used to validate this payload is given in Appendix C1.8c.

Code 6.16.2 - JSON payload example for "200" response messages for a "getAllOrgs" operation.
    {
        "orgs" : [
            {
                "sourcedId" : "..String..",
                "status" : "active"|"tobedeleted",
                "dateLastModified" : "..Date/Time..",
                "metadata" : {
                    "..permitted extension point.." : "..user defined value.."
                },
                "name" : "..NormalizedString..",
                "type" : "..select from Union..",
                "identifier" : "..String..",
                "parent" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "org"
                },
                "children" : [
                    {
                        "href" : "..URI..",
                        "sourcedId" : "..String..",
                        "type" : "org"
                    },
                    {...},
                    {...}
                ]
            },
            {...},
            {...}
        ]
    }
                        

6.17 "getAllSchools" Request Payload

There is no payload for this request.

6.18 "getAllSchools" Response Payloads

6.18.1 Response Payloads for the HTTP Codes (default, 400, 401, 403, 422, 429, 500)

A tabular description of the response payload is shown in the Table below.

Table 6.18.1 - Tabular representation of the JSON payload for "default, 400, 401, 403, 422, 429, 500" response messages for a "getAllSchools" operation.
Property Name Multiplicity JSON Data-type Description
    imsx_codeMajor [1..1] Enumeration The code major value (from the corresponding enumerated vocabulary). See Appendix B for further information on the interpretation of this set of codes. The permitted vocabulary for the values for the CodeMajor field.
    imsx_severity [1..1] Enumeration The severity value (from the corresponding enumerated vocabulary). See Appendix B for further information on the interpretation of this set of codes.
    imsx_description [0..1] String A human readable description supplied by the entity creating the status code information.
    imsx_CodeMinor [0..1] Object The set of reported code minor status codes. See Appendix B for further information on the interpretation of this set of codes.
            imsx_codeMinorField [1..*] Array [ Object ] Each reported code minor status code.
                    imsx_codeMinorFieldName [1..1] String This should contain the identity of the system that has produced the code minor status code report. In most cases this will be the target service provider denoted as 'TargetEndSystem'.
                    imsx_codeMinorFieldValue [1..1] Enumeration The code minor status code (this is a value from the corresponding enumerated vocabulary).

An example of the response JSON payload is shown in the code block below. The JSON Schema file that can be used to validate this payload is given in Appendix C1.9b.

Code 6.18.1 - JSON payload example for "default, 400, 401, 403, 422, 429, 500" response messages for a "getAllSchools" operation.
    {
        "imsx_codeMajor" : "success"|"processing"|"failure"|"unsupported",
        "imsx_severity" : "status"|"warning"|"error",
        "imsx_description" : "..String..",
        "imsx_CodeMinor" : {
            "imsx_codeMinorField" : [
                {
                    "imsx_codeMinorFieldName" : "..NormalizedString..",
                    "imsx_codeMinorFieldValue" : "fullsuccess"|"invalid_filter_field"|"invalid_selection_field"|"invaliddata"|"unauthorisedrequest"|"forbidden"|"server_busy"|"unknownobject"|"internal_server_error"
                },
                {...},
                {...}
            ]
        }
    }
                        

6.18.2 Response Payloads for the HTTP Codes (200)

A tabular description of the response payload is shown in the Table below.

Table 6.18.2 - Tabular representation of the JSON payload for "200" response messages for a "getAllSchools" operation.
Property Name Multiplicity JSON Data-type Description
    orgs [0..*] Array [ Object ] The collection of org instances. The order is not significant. The corresponding query constraints may result in no instances being returned.
            sourcedId [1..1] String The sourcedId of the object. All objects MUST be identified by a Source Identifier. This is a GUID System ID for an object. This is the GUID that SYSTEMS will refer to when making API calls, or when needing to identify an object. It is RECOMMENDED that systems are able to map whichever local ids (e.g. database key fields) they use to SourcedId. The sourcedId of an object is considered an addressable property of an entity and as such will not be treated as Personally Identifiable Information (PII) by certified products. Therefore, as a part of certification, vendors will be required to declare that they will notify customers via documentation or other formal and documented agreement that sourcedIds should never contain PII in general, but particularly users. This means that if a customer includes a student name in an enrollment.sourcedId, it will not fall to any certified product to protect the enrollment.sourcedId as PII, or even the userSourcedId field in the enrollment record.
            status [1..1] Enumeration All objects MUST BE either 'active' or 'tobedeleted'. Something which is flagged 'tobedeleted' is to be considered safe to delete. Systems can delete records that are flagged as such if they wish, but they are not under any compulsion to do so. In v1.1 the enumeration value of 'inactive' was removed and so for backwards compatibility all such marked objects should be interpreted as 'tobedeleted'.
            dateLastModified [1..1] String (Format: date-time) All objects MUST be annotated with the dateTime upon which they were last modified. This enables requesters to query for just the latest objects. DateTimes MUST be expressed in W3C profile of [ISO 8601] and MUST contain the UTC timezone.
            metadata [0..1] Object All objects CAN be extended using the Metadata class. This specification is silent on what implementers may consider to be appropriate extensions. The form of the extension is dependent on the binding technology being used.
                    extensions [0..*] Set of Proprietary Properties The form of the extension is dependent on the binding technology being used. This specification is silent on what implementers may consider to be appropriate extensions.
            name [1..1] String The name of the organization.
            type [1..1] Union(OrgTypeEnumExt) The type of organization. This uses a predefined vocabulary.
            identifier [1..1] String Human readable identifier for this org e.g. NCES ID.
            parent [0..1] Object The 'sourcedId' of the parent organization.
                    href [1..1] String (Format: uri) The URI for the type of object being referenced.
                    sourcedId [1..1] String The globally unique identifier of the object being referenced.
                    type [1..1] Enumeration The type of object being referenced i.e. an 'org'.
            children [0..*] Array [ Object ] The 'sourcedIds' for the set of child organizations.
                    href [1..1] String (Format: uri) The URI for the type of object being referenced.
                    sourcedId [1..1] String The globally unique identifier of the object being referenced.
                    type [1..1] Enumeration The type of object being referenced i.e. an 'org'.

An example of the response JSON payload is shown in the code block below. The JSON Schema file that can be used to validate this payload is given in Appendix C1.9c.

Code 6.18.2 - JSON payload example for "200" response messages for a "getAllSchools" operation.
    {
        "orgs" : [
            {
                "sourcedId" : "..String..",
                "status" : "active"|"tobedeleted",
                "dateLastModified" : "..Date/Time..",
                "metadata" : {
                    "..permitted extension point.." : "..user defined value.."
                },
                "name" : "..NormalizedString..",
                "type" : "..select from Union..",
                "identifier" : "..String..",
                "parent" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "org"
                },
                "children" : [
                    {
                        "href" : "..URI..",
                        "sourcedId" : "..String..",
                        "type" : "org"
                    },
                    {...},
                    {...}
                ]
            },
            {...},
            {...}
        ]
    }
                        

6.19 "getAllStudents" Request Payload

There is no payload for this request.

6.20 "getAllStudents" Response Payloads

6.20.1 Response Payloads for the HTTP Codes (default, 400, 401, 403, 422, 429, 500)

A tabular description of the response payload is shown in the Table below.

Table 6.20.1 - Tabular representation of the JSON payload for "default, 400, 401, 403, 422, 429, 500" response messages for a "getAllStudents" operation.
Property Name Multiplicity JSON Data-type Description
    imsx_codeMajor [1..1] Enumeration The code major value (from the corresponding enumerated vocabulary). See Appendix B for further information on the interpretation of this set of codes. The permitted vocabulary for the values for the CodeMajor field.
    imsx_severity [1..1] Enumeration The severity value (from the corresponding enumerated vocabulary). See Appendix B for further information on the interpretation of this set of codes.
    imsx_description [0..1] String A human readable description supplied by the entity creating the status code information.
    imsx_CodeMinor [0..1] Object The set of reported code minor status codes. See Appendix B for further information on the interpretation of this set of codes.
            imsx_codeMinorField [1..*] Array [ Object ] Each reported code minor status code.
                    imsx_codeMinorFieldName [1..1] String This should contain the identity of the system that has produced the code minor status code report. In most cases this will be the target service provider denoted as 'TargetEndSystem'.
                    imsx_codeMinorFieldValue [1..1] Enumeration The code minor status code (this is a value from the corresponding enumerated vocabulary).

An example of the response JSON payload is shown in the code block below. The JSON Schema file that can be used to validate this payload is given in Appendix C1.10b.

Code 6.20.1 - JSON payload example for "default, 400, 401, 403, 422, 429, 500" response messages for a "getAllStudents" operation.
    {
        "imsx_codeMajor" : "success"|"processing"|"failure"|"unsupported",
        "imsx_severity" : "status"|"warning"|"error",
        "imsx_description" : "..String..",
        "imsx_CodeMinor" : {
            "imsx_codeMinorField" : [
                {
                    "imsx_codeMinorFieldName" : "..NormalizedString..",
                    "imsx_codeMinorFieldValue" : "fullsuccess"|"invalid_filter_field"|"invalid_selection_field"|"invaliddata"|"unauthorisedrequest"|"forbidden"|"server_busy"|"unknownobject"|"internal_server_error"
                },
                {...},
                {...}
            ]
        }
    }
                        

6.20.2 Response Payloads for the HTTP Codes (200)

A tabular description of the response payload is shown in the Table below.

Table 6.20.2 - Tabular representation of the JSON payload for "200" response messages for a "getAllStudents" operation.
Property Name Multiplicity JSON Data-type Description
    users [0..*] Array [ Object ] The collection of user instances. The order is not significant. The corresponding query constraints may result in no instances being returned.
            sourcedId [1..1] String The sourcedId of the object. All objects MUST be identified by a Source Identifier. This is a GUID System ID for an object. This is the GUID that SYSTEMS will refer to when making API calls, or when needing to identify an object. It is RECOMMENDED that systems are able to map whichever local ids (e.g. database key fields) they use to SourcedId. The sourcedId of an object is considered an addressable property of an entity and as such will not be treated as Personally Identifiable Information (PII) by certified products. Therefore, as a part of certification, vendors will be required to declare that they will notify customers via documentation or other formal and documented agreement that sourcedIds should never contain PII in general, but particularly users. This means that if a customer includes a student name in an enrollment.sourcedId, it will not fall to any certified product to protect the enrollment.sourcedId as PII, or even the userSourcedId field in the enrollment record.
            status [1..1] Enumeration All objects MUST BE either 'active' or 'tobedeleted'. Something which is flagged 'tobedeleted' is to be considered safe to delete. Systems can delete records that are flagged as such if they wish, but they are not under any compulsion to do so. In v1.1 the enumeration value of 'inactive' was removed and so for backwards compatibility all such marked objects should be interpreted as 'tobedeleted'.
            dateLastModified [1..1] String (Format: date-time) All objects MUST be annotated with the dateTime upon which they were last modified. This enables requesters to query for just the latest objects. DateTimes MUST be expressed in W3C profile of [ISO 8601] and MUST contain the UTC timezone.
            metadata [0..1] Object All objects CAN be extended using the Metadata class. This specification is silent on what implementers may consider to be appropriate extensions. The form of the extension is dependent on the binding technology being used.
                    extensions [0..*] Set of Proprietary Properties The form of the extension is dependent on the binding technology being used. This specification is silent on what implementers may consider to be appropriate extensions.
            userMasterIdentifier [0..1] String The master unique identifier for this user. This is NOT the same as the user's interoperability 'sourcedId'. This should be used to ensure that all of the system identifiers/accounts etc. can be reconciled to the same user. How this identifier is assigned and its format is beyond the scope of this specification.
            username [0..1] String The user name assigned to the user. NOTE - This has been kept for backwards compatibility with OneRoster 1.1 and the new 'userProfiles' characteristic SHOULD be used instead.
            userIds [0..*] Array [ Object ] The set of external user identifiers that should be used for this user, if for some reason the sourcedId cannot be used. This might be an active directory id, an LTI id, or some other machine-readable identifier that is used for this person.
                    type [1..1] String The type of identifier. This is no predefined vocabuary.
                    identifier [1..1] String The user identifier.
            enabledUser [1..1] Enumeration This is used to determine whether or not the record is active in the local system. 'false' denotes that the record is active but system access is curtailed according to the local administration rules.
            givenName [1..1] String The given name. Also, known as the first name.
            familyName [1..1] String The family name. Also, known as the last name.
            middleName [0..1] String The set of middle names. If more than one middle name is needed separate using a space e.g. 'Wingarde Granville'.
            preferredFirstName [0..1] String The user's preferred first name. This attribute was added in version 1.2.
            preferredMiddleName [0..1] String The user's preferred middle name(s). This attribute was added in version 1.2.
            preferredLastName [0..1] String The user's preferred last name. This attribute was added in version 1.2.
            roles [1..*] Array [ Object ] The set of roles for each of the orgs to which the user is affilliated. This is expressed as a set of role/org tuples.
                    roleType [1..1] Enumeration Indicates if this role is the primary or secondary role for that org. There MUST be one, and only one, primary role for each org.
                    role [1..1] Union(RoleEnumExt) The role of the user in the org. The permitted values are from an enumerated list.
                    org [1..1] Object The link to the associated org i.e. the 'sourcedId' for the org.
                            href [1..1] String (Format: uri) The URI for the type of object being referenced.
                            sourcedId [1..1] String The globally unique identifier of the object being referenced.
                            type [1..1] Enumeration The type of object being referenced i.e. an 'org'.
                    userProfile [0..1] String (Format: uri) The identifier for the system/tool/app access account that is relevant to this role in the org. The equivalent UserProfile should exist with a 'profileId' equal to this identifier value.
                    beginDate [0..1] String (Format: date) The start date on which the role becomes active (inclusive).
                    endDate [0..1] String (Format: date) The end date on which the role becomes inactive (exclusive).
            userProfiles [0..*] Array [ Object ] The set of system/app/tool profiles for the user.
                    profileId [1..1] String (Format: uri) The unique identifier for the profile. This does not need to be a globally unique identifier but it must be unique within the scope of the user.
                    profileType [1..1] String The type of profile. This should be a human readable label that has some significance in the context of the related system, app, tool, etc.
                    vendorId [1..1] String The unique identifier for the vendor of the system, tool, app, etc. which requires the use of this profile.
                    applicationId [0..1] String Identifier for the application associated with the account. The nature, and how this identifier is assigned is not defined by this specification. This may have a value of 'default' to denote this account should be used for default access to all applications related to this vendor.
                    description [0..1] String A human readable description of the use of the profile. This should not contain any security information for access to the account.
                    credentials [0..*] Array [ Object ] The set of credentials that are available for access to this profile.
                            type [1..1] String The type of credentials for the profile. This should be indicative of when this specific credential should be used.
                            username [1..1] String The username.
                            password [0..1] String The password in this set of credentials. Care should be taken to ensure that no unencrypted value is revealed.
                            extensions [0..*] Set of Proprietary Properties The set of proprietary extensions to enable other important credential information to be supplied. This information will only be relevant in the context of the corresponding system/app/tool. The form of this information is dependent on the type of binding being used.
            primaryOrg [0..1] Object It is possible for a user to be a member of more than one organization and to have one or more roles in an organization. This attribute identifies the 'sourcedId' of the primary organization.
                    href [1..1] String (Format: uri) The URI for the type of object being referenced.
                    sourcedId [1..1] String The globally unique identifier of the object being referenced.
                    type [1..1] Enumeration The type of object being referenced i.e. an 'org'.
            identifier [0..1] String An identifier for the user. NOTE - This characteristic is kept for backwards compatibility with OneRoster 1.1/1.0. The 'userIds' characteristic SHOULD be used instead.
            email [0..1] String The email address for the user.
            sms [0..1] String The SMS number for the user.
            phone [0..1] String The phone number for the user.
            agents [0..*] Array [ Object ] The links to other people i.e. User 'sourcedIds'.
                    href [1..1] String (Format: uri) The URI for the type of object being referenced.
                    sourcedId [1..1] String The globally unique identifier of the object being referenced.
                    type [1..1] Enumeration The type of object being referenced i.e. a 'user'.
            grades [0..*] Array [ String ] Grade(s) for which a user with role 'student' is enrolled. The permitted vocabulary should be defined as part of the adoption and deployment process. See the Implementation Guide [OR-IMPL-12] for more details on how to define/use such a vocabulary.
            password [0..1] String A top-level password for the user. Care should be taken when using this field and the password SHOULD be encrypted.
            resources [0..*] Array [ Object ] The identifiers (GUIDs) for the set of resources that are to be made available to the user. These are the sourcedIds that should be used for obtaining the metadata about the resources using the OR 1.2 Resources Service [OR-RES-SM-12].
                    href [1..1] String (Format: uri) The URI for the type of object being referenced.
                    sourcedId [1..1] String The globally unique identifier of the object being referenced.
                    type [1..1] Enumeration The type of object being referenced i.e. a 'resource'.

An example of the response JSON payload is shown in the code block below. The JSON Schema file that can be used to validate this payload is given in Appendix C1.10c.

Code 6.20.2 - JSON payload example for "200" response messages for a "getAllStudents" operation.
    {
        "users" : [
            {
                "sourcedId" : "..String..",
                "status" : "active"|"tobedeleted",
                "dateLastModified" : "..Date/Time..",
                "metadata" : {
                    "..permitted extension point.." : "..user defined value.."
                },
                "userMasterIdentifier" : "..NormalizedString..",
                "username" : "..NormalizedString..",
                "userIds" : [
                    {
                        "type" : "..NormalizedString..",
                        "identifier" : "..String.."
                    },
                    {...},
                    {...}
                ],
                "enabledUser" : "true"|"false",
                "givenName" : "..NormalizedString..",
                "familyName" : "..NormalizedString..",
                "middleName" : "..NormalizedString..",
                "preferredFirstName" : "..NormalizedString..",
                "preferredMiddleName" : "..NormalizedString..",
                "preferredLastName" : "..NormalizedString..",
                "roles" : [
                    {
                        "roleType" : "primary"|"secondary",
                        "role" : "..select from Union..",
                        "org" : {
                            "href" : "..URI..",
                            "sourcedId" : "..String..",
                            "type" : "org"
                        },
                        "userProfile" : "..URI..",
                        "beginDate" : "..String(Date)..",
                        "endDate" : "..String(Date).."
                    },
                    {...},
                    {...}
                ],
                "userProfiles" : [
                    {
                        "profileId" : "..URI..",
                        "profileType" : "..NormalizedString..",
                        "vendorId" : "..NormalizedString..",
                        "applicationId" : "..NormalizedString..",
                        "description" : "..String..",
                        "credentials" : [
                            {
                                "type" : "..String..",
                                "username" : "..NormalizedString..",
                                "password" : "..String..",
                                "..permitted extension point.." : "..user defined value.."
                            },
                            {...},
                            {...}
                        ]
                    },
                    {...},
                    {...}
                ],
                "primaryOrg" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "org"
                },
                "identifier" : "..String..",
                "email" : "..NormalizedString..",
                "sms" : "..NormalizedString..",
                "phone" : "..NormalizedString..",
                "agents" : [
                    {
                        "href" : "..URI..",
                        "sourcedId" : "..String..",
                        "type" : "user"
                    },
                    {...},
                    {...}
                ],
                "grades" : [ "..NormalizedString..", ..., "..NormalizedString.." ],
                "password" : "..String..",
                "resources" : [
                    {
                        "href" : "..URI..",
                        "sourcedId" : "..String..",
                        "type" : "resource"
                    },
                    {...},
                    {...}
                ]
            },
            {...},
            {...}
        ]
    }
                        

6.21 "getAllTeachers" Request Payload

There is no payload for this request.

6.22 "getAllTeachers" Response Payloads

6.22.1 Response Payloads for the HTTP Codes (default, 400, 401, 403, 422, 429, 500)

A tabular description of the response payload is shown in the Table below.

Table 6.22.1 - Tabular representation of the JSON payload for "default, 400, 401, 403, 422, 429, 500" response messages for a "getAllTeachers" operation.
Property Name Multiplicity JSON Data-type Description
    imsx_codeMajor [1..1] Enumeration The code major value (from the corresponding enumerated vocabulary). See Appendix B for further information on the interpretation of this set of codes. The permitted vocabulary for the values for the CodeMajor field.
    imsx_severity [1..1] Enumeration The severity value (from the corresponding enumerated vocabulary). See Appendix B for further information on the interpretation of this set of codes.
    imsx_description [0..1] String A human readable description supplied by the entity creating the status code information.
    imsx_CodeMinor [0..1] Object The set of reported code minor status codes. See Appendix B for further information on the interpretation of this set of codes.
            imsx_codeMinorField [1..*] Array [ Object ] Each reported code minor status code.
                    imsx_codeMinorFieldName [1..1] String This should contain the identity of the system that has produced the code minor status code report. In most cases this will be the target service provider denoted as 'TargetEndSystem'.
                    imsx_codeMinorFieldValue [1..1] Enumeration The code minor status code (this is a value from the corresponding enumerated vocabulary).

An example of the response JSON payload is shown in the code block below. The JSON Schema file that can be used to validate this payload is given in Appendix C1.11b.

Code 6.22.1 - JSON payload example for "default, 400, 401, 403, 422, 429, 500" response messages for a "getAllTeachers" operation.
    {
        "imsx_codeMajor" : "success"|"processing"|"failure"|"unsupported",
        "imsx_severity" : "status"|"warning"|"error",
        "imsx_description" : "..String..",
        "imsx_CodeMinor" : {
            "imsx_codeMinorField" : [
                {
                    "imsx_codeMinorFieldName" : "..NormalizedString..",
                    "imsx_codeMinorFieldValue" : "fullsuccess"|"invalid_filter_field"|"invalid_selection_field"|"invaliddata"|"unauthorisedrequest"|"forbidden"|"server_busy"|"unknownobject"|"internal_server_error"
                },
                {...},
                {...}
            ]
        }
    }
                        

6.22.2 Response Payloads for the HTTP Codes (200)

A tabular description of the response payload is shown in the Table below.

Table 6.22.2 - Tabular representation of the JSON payload for "200" response messages for a "getAllTeachers" operation.
Property Name Multiplicity JSON Data-type Description
    users [0..*] Array [ Object ] The collection of user instances. The order is not significant. The corresponding query constraints may result in no instances being returned.
            sourcedId [1..1] String The sourcedId of the object. All objects MUST be identified by a Source Identifier. This is a GUID System ID for an object. This is the GUID that SYSTEMS will refer to when making API calls, or when needing to identify an object. It is RECOMMENDED that systems are able to map whichever local ids (e.g. database key fields) they use to SourcedId. The sourcedId of an object is considered an addressable property of an entity and as such will not be treated as Personally Identifiable Information (PII) by certified products. Therefore, as a part of certification, vendors will be required to declare that they will notify customers via documentation or other formal and documented agreement that sourcedIds should never contain PII in general, but particularly users. This means that if a customer includes a student name in an enrollment.sourcedId, it will not fall to any certified product to protect the enrollment.sourcedId as PII, or even the userSourcedId field in the enrollment record.
            status [1..1] Enumeration All objects MUST BE either 'active' or 'tobedeleted'. Something which is flagged 'tobedeleted' is to be considered safe to delete. Systems can delete records that are flagged as such if they wish, but they are not under any compulsion to do so. In v1.1 the enumeration value of 'inactive' was removed and so for backwards compatibility all such marked objects should be interpreted as 'tobedeleted'.
            dateLastModified [1..1] String (Format: date-time) All objects MUST be annotated with the dateTime upon which they were last modified. This enables requesters to query for just the latest objects. DateTimes MUST be expressed in W3C profile of [ISO 8601] and MUST contain the UTC timezone.
            metadata [0..1] Object All objects CAN be extended using the Metadata class. This specification is silent on what implementers may consider to be appropriate extensions. The form of the extension is dependent on the binding technology being used.
                    extensions [0..*] Set of Proprietary Properties The form of the extension is dependent on the binding technology being used. This specification is silent on what implementers may consider to be appropriate extensions.
            userMasterIdentifier [0..1] String The master unique identifier for this user. This is NOT the same as the user's interoperability 'sourcedId'. This should be used to ensure that all of the system identifiers/accounts etc. can be reconciled to the same user. How this identifier is assigned and its format is beyond the scope of this specification.
            username [0..1] String The user name assigned to the user. NOTE - This has been kept for backwards compatibility with OneRoster 1.1 and the new 'userProfiles' characteristic SHOULD be used instead.
            userIds [0..*] Array [ Object ] The set of external user identifiers that should be used for this user, if for some reason the sourcedId cannot be used. This might be an active directory id, an LTI id, or some other machine-readable identifier that is used for this person.
                    type [1..1] String The type of identifier. This is no predefined vocabuary.
                    identifier [1..1] String The user identifier.
            enabledUser [1..1] Enumeration This is used to determine whether or not the record is active in the local system. 'false' denotes that the record is active but system access is curtailed according to the local administration rules.
            givenName [1..1] String The given name. Also, known as the first name.
            familyName [1..1] String The family name. Also, known as the last name.
            middleName [0..1] String The set of middle names. If more than one middle name is needed separate using a space e.g. 'Wingarde Granville'.
            preferredFirstName [0..1] String The user's preferred first name. This attribute was added in version 1.2.
            preferredMiddleName [0..1] String The user's preferred middle name(s). This attribute was added in version 1.2.
            preferredLastName [0..1] String The user's preferred last name. This attribute was added in version 1.2.
            roles [1..*] Array [ Object ] The set of roles for each of the orgs to which the user is affilliated. This is expressed as a set of role/org tuples.
                    roleType [1..1] Enumeration Indicates if this role is the primary or secondary role for that org. There MUST be one, and only one, primary role for each org.
                    role [1..1] Union(RoleEnumExt) The role of the user in the org. The permitted values are from an enumerated list.
                    org [1..1] Object The link to the associated org i.e. the 'sourcedId' for the org.
                            href [1..1] String (Format: uri) The URI for the type of object being referenced.
                            sourcedId [1..1] String The globally unique identifier of the object being referenced.
                            type [1..1] Enumeration The type of object being referenced i.e. an 'org'.
                    userProfile [0..1] String (Format: uri) The identifier for the system/tool/app access account that is relevant to this role in the org. The equivalent UserProfile should exist with a 'profileId' equal to this identifier value.
                    beginDate [0..1] String (Format: date) The start date on which the role becomes active (inclusive).
                    endDate [0..1] String (Format: date) The end date on which the role becomes inactive (exclusive).
            userProfiles [0..*] Array [ Object ] The set of system/app/tool profiles for the user.
                    profileId [1..1] String (Format: uri) The unique identifier for the profile. This does not need to be a globally unique identifier but it must be unique within the scope of the user.
                    profileType [1..1] String The type of profile. This should be a human readable label that has some significance in the context of the related system, app, tool, etc.
                    vendorId [1..1] String The unique identifier for the vendor of the system, tool, app, etc. which requires the use of this profile.
                    applicationId [0..1] String Identifier for the application associated with the account. The nature, and how this identifier is assigned is not defined by this specification. This may have a value of 'default' to denote this account should be used for default access to all applications related to this vendor.
                    description [0..1] String A human readable description of the use of the profile. This should not contain any security information for access to the account.
                    credentials [0..*] Array [ Object ] The set of credentials that are available for access to this profile.
                            type [1..1] String The type of credentials for the profile. This should be indicative of when this specific credential should be used.
                            username [1..1] String The username.
                            password [0..1] String The password in this set of credentials. Care should be taken to ensure that no unencrypted value is revealed.
                            extensions [0..*] Set of Proprietary Properties The set of proprietary extensions to enable other important credential information to be supplied. This information will only be relevant in the context of the corresponding system/app/tool. The form of this information is dependent on the type of binding being used.
            primaryOrg [0..1] Object It is possible for a user to be a member of more than one organization and to have one or more roles in an organization. This attribute identifies the 'sourcedId' of the primary organization.
                    href [1..1] String (Format: uri) The URI for the type of object being referenced.
                    sourcedId [1..1] String The globally unique identifier of the object being referenced.
                    type [1..1] Enumeration The type of object being referenced i.e. an 'org'.
            identifier [0..1] String An identifier for the user. NOTE - This characteristic is kept for backwards compatibility with OneRoster 1.1/1.0. The 'userIds' characteristic SHOULD be used instead.
            email [0..1] String The email address for the user.
            sms [0..1] String The SMS number for the user.
            phone [0..1] String The phone number for the user.
            agents [0..*] Array [ Object ] The links to other people i.e. User 'sourcedIds'.
                    href [1..1] String (Format: uri) The URI for the type of object being referenced.
                    sourcedId [1..1] String The globally unique identifier of the object being referenced.
                    type [1..1] Enumeration The type of object being referenced i.e. a 'user'.
            grades [0..*] Array [ String ] Grade(s) for which a user with role 'student' is enrolled. The permitted vocabulary should be defined as part of the adoption and deployment process. See the Implementation Guide [OR-IMPL-12] for more details on how to define/use such a vocabulary.
            password [0..1] String A top-level password for the user. Care should be taken when using this field and the password SHOULD be encrypted.
            resources [0..*] Array [ Object ] The identifiers (GUIDs) for the set of resources that are to be made available to the user. These are the sourcedIds that should be used for obtaining the metadata about the resources using the OR 1.2 Resources Service [OR-RES-SM-12].
                    href [1..1] String (Format: uri) The URI for the type of object being referenced.
                    sourcedId [1..1] String The globally unique identifier of the object being referenced.
                    type [1..1] Enumeration The type of object being referenced i.e. a 'resource'.

An example of the response JSON payload is shown in the code block below. The JSON Schema file that can be used to validate this payload is given in Appendix C1.11c.

Code 6.22.2 - JSON payload example for "200" response messages for a "getAllTeachers" operation.
    {
        "users" : [
            {
                "sourcedId" : "..String..",
                "status" : "active"|"tobedeleted",
                "dateLastModified" : "..Date/Time..",
                "metadata" : {
                    "..permitted extension point.." : "..user defined value.."
                },
                "userMasterIdentifier" : "..NormalizedString..",
                "username" : "..NormalizedString..",
                "userIds" : [
                    {
                        "type" : "..NormalizedString..",
                        "identifier" : "..String.."
                    },
                    {...},
                    {...}
                ],
                "enabledUser" : "true"|"false",
                "givenName" : "..NormalizedString..",
                "familyName" : "..NormalizedString..",
                "middleName" : "..NormalizedString..",
                "preferredFirstName" : "..NormalizedString..",
                "preferredMiddleName" : "..NormalizedString..",
                "preferredLastName" : "..NormalizedString..",
                "roles" : [
                    {
                        "roleType" : "primary"|"secondary",
                        "role" : "..select from Union..",
                        "org" : {
                            "href" : "..URI..",
                            "sourcedId" : "..String..",
                            "type" : "org"
                        },
                        "userProfile" : "..URI..",
                        "beginDate" : "..String(Date)..",
                        "endDate" : "..String(Date).."
                    },
                    {...},
                    {...}
                ],
                "userProfiles" : [
                    {
                        "profileId" : "..URI..",
                        "profileType" : "..NormalizedString..",
                        "vendorId" : "..NormalizedString..",
                        "applicationId" : "..NormalizedString..",
                        "description" : "..String..",
                        "credentials" : [
                            {
                                "type" : "..String..",
                                "username" : "..NormalizedString..",
                                "password" : "..String..",
                                "..permitted extension point.." : "..user defined value.."
                            },
                            {...},
                            {...}
                        ]
                    },
                    {...},
                    {...}
                ],
                "primaryOrg" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "org"
                },
                "identifier" : "..String..",
                "email" : "..NormalizedString..",
                "sms" : "..NormalizedString..",
                "phone" : "..NormalizedString..",
                "agents" : [
                    {
                        "href" : "..URI..",
                        "sourcedId" : "..String..",
                        "type" : "user"
                    },
                    {...},
                    {...}
                ],
                "grades" : [ "..NormalizedString..", ..., "..NormalizedString.." ],
                "password" : "..String..",
                "resources" : [
                    {
                        "href" : "..URI..",
                        "sourcedId" : "..String..",
                        "type" : "resource"
                    },
                    {...},
                    {...}
                ]
            },
            {...},
            {...}
        ]
    }
                        

6.23 "getAllTerms" Request Payload

There is no payload for this request.

6.24 "getAllTerms" Response Payloads

6.24.1 Response Payloads for the HTTP Codes (default, 400, 401, 403, 422, 429, 500)

A tabular description of the response payload is shown in the Table below.

Table 6.24.1 - Tabular representation of the JSON payload for "default, 400, 401, 403, 422, 429, 500" response messages for a "getAllTerms" operation.
Property Name Multiplicity JSON Data-type Description
    imsx_codeMajor [1..1] Enumeration The code major value (from the corresponding enumerated vocabulary). See Appendix B for further information on the interpretation of this set of codes. The permitted vocabulary for the values for the CodeMajor field.
    imsx_severity [1..1] Enumeration The severity value (from the corresponding enumerated vocabulary). See Appendix B for further information on the interpretation of this set of codes.
    imsx_description [0..1] String A human readable description supplied by the entity creating the status code information.
    imsx_CodeMinor [0..1] Object The set of reported code minor status codes. See Appendix B for further information on the interpretation of this set of codes.
            imsx_codeMinorField [1..*] Array [ Object ] Each reported code minor status code.
                    imsx_codeMinorFieldName [1..1] String This should contain the identity of the system that has produced the code minor status code report. In most cases this will be the target service provider denoted as 'TargetEndSystem'.
                    imsx_codeMinorFieldValue [1..1] Enumeration The code minor status code (this is a value from the corresponding enumerated vocabulary).

An example of the response JSON payload is shown in the code block below. The JSON Schema file that can be used to validate this payload is given in Appendix C1.12b.

Code 6.24.1 - JSON payload example for "default, 400, 401, 403, 422, 429, 500" response messages for a "getAllTerms" operation.
    {
        "imsx_codeMajor" : "success"|"processing"|"failure"|"unsupported",
        "imsx_severity" : "status"|"warning"|"error",
        "imsx_description" : "..String..",
        "imsx_CodeMinor" : {
            "imsx_codeMinorField" : [
                {
                    "imsx_codeMinorFieldName" : "..NormalizedString..",
                    "imsx_codeMinorFieldValue" : "fullsuccess"|"invalid_filter_field"|"invalid_selection_field"|"invaliddata"|"unauthorisedrequest"|"forbidden"|"server_busy"|"unknownobject"|"internal_server_error"
                },
                {...},
                {...}
            ]
        }
    }
                        

6.24.2 Response Payloads for the HTTP Codes (200)

A tabular description of the response payload is shown in the Table below.

Table 6.24.2 - Tabular representation of the JSON payload for "200" response messages for a "getAllTerms" operation.
Property Name Multiplicity JSON Data-type Description
    academicSessions [0..*] Array [ Object ] The collection of academicSession instances. The order is not significant. The corresponding query constraints may result in no instances being returned.
            sourcedId [1..1] String The sourcedId of the object. All objects MUST be identified by a Source Identifier. This is a GUID System ID for an object. This is the GUID that SYSTEMS will refer to when making API calls, or when needing to identify an object. It is RECOMMENDED that systems are able to map whichever local ids (e.g. database key fields) they use to SourcedId. The sourcedId of an object is considered an addressable property of an entity and as such will not be treated as Personally Identifiable Information (PII) by certified products. Therefore, as a part of certification, vendors will be required to declare that they will notify customers via documentation or other formal and documented agreement that sourcedIds should never contain PII in general, but particularly users. This means that if a customer includes a student name in an enrollment.sourcedId, it will not fall to any certified product to protect the enrollment.sourcedId as PII, or even the userSourcedId field in the enrollment record.
            status [1..1] Enumeration All objects MUST BE either 'active' or 'tobedeleted'. Something which is flagged 'tobedeleted' is to be considered safe to delete. Systems can delete records that are flagged as such if they wish, but they are not under any compulsion to do so. In v1.1 the enumeration value of 'inactive' was removed and so for backwards compatibility all such marked objects should be interpreted as 'tobedeleted'.
            dateLastModified [1..1] String (Format: date-time) All objects MUST be annotated with the dateTime upon which they were last modified. This enables requesters to query for just the latest objects. DateTimes MUST be expressed in W3C profile of [ISO 8601] and MUST contain the UTC timezone.
            metadata [0..1] Object All objects CAN be extended using the Metadata class. This specification is silent on what implementers may consider to be appropriate extensions. The form of the extension is dependent on the binding technology being used.
                    extensions [0..*] Set of Proprietary Properties The form of the extension is dependent on the binding technology being used. This specification is silent on what implementers may consider to be appropriate extensions.
            title [1..1] String The title/label for the academic session.
            startDate [1..1] String (Format: date) The start date for the academic session. The start date is included in the academic session. This is in [ISO 8601] format of 'YYYY-MM-DD'.
            endDate [1..1] String (Format: date) The end date for the academic session. The end date is excluded from the academic session. This is in [ISO 8601] format of 'YYYY-MM-DD'.
            type [1..1] Union(SessionTypeEnumExt) The type of academic session. This is based upon an enumerated vocabulary.
            parent [0..1] Object The link to parent AcademicSession i.e. an AcademicSession 'sourcedId'.
                    href [1..1] String (Format: uri) The URI for the type of object being referenced.
                    sourcedId [1..1] String The globally unique identifier of the object being referenced.
                    type [1..1] Enumeration The type of object being referenced i.e. an 'academicSession'.
            children [0..*] Array [ Object ] The set of links to the child AcademicSessions i.e. a set of AcademicSession 'sourcedIds'.
                    href [1..1] String (Format: uri) The URI for the type of object being referenced.
                    sourcedId [1..1] String The globally unique identifier of the object being referenced.
                    type [1..1] Enumeration The type of object being referenced i.e. an 'academicSession'.
            schoolYear [1..1] String The school year for the academic session. This year should include the school year end e.g. 2014. This is in the [ISO 8601] format of 'YYYY'.

An example of the response JSON payload is shown in the code block below. The JSON Schema file that can be used to validate this payload is given in Appendix C1.12c.

Code 6.24.2 - JSON payload example for "200" response messages for a "getAllTerms" operation.
    {
        "academicSessions" : [
            {
                "sourcedId" : "..String..",
                "status" : "active"|"tobedeleted",
                "dateLastModified" : "..Date/Time..",
                "metadata" : {
                    "..permitted extension point.." : "..user defined value.."
                },
                "title" : "..NormalizedString..",
                "startDate" : "..String(Date)..",
                "endDate" : "..String(Date)..",
                "type" : "..select from Union..",
                "parent" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "academicSession"
                },
                "children" : [
                    {
                        "href" : "..URI..",
                        "sourcedId" : "..String..",
                        "type" : "academicSession"
                    },
                    {...},
                    {...}
                ],
                "schoolYear" : "..NormalizedString.."
            },
            {...},
            {...}
        ]
    }
                        

6.25 "getAllUsers" Request Payload

There is no payload for this request.

6.26 "getAllUsers" Response Payloads

6.26.1 Response Payloads for the HTTP Codes (default, 400, 401, 403, 422, 429, 500)

A tabular description of the response payload is shown in the Table below.

Table 6.26.1 - Tabular representation of the JSON payload for "default, 400, 401, 403, 422, 429, 500" response messages for a "getAllUsers" operation.
Property Name Multiplicity JSON Data-type Description
    imsx_codeMajor [1..1] Enumeration The code major value (from the corresponding enumerated vocabulary). See Appendix B for further information on the interpretation of this set of codes. The permitted vocabulary for the values for the CodeMajor field.
    imsx_severity [1..1] Enumeration The severity value (from the corresponding enumerated vocabulary). See Appendix B for further information on the interpretation of this set of codes.
    imsx_description [0..1] String A human readable description supplied by the entity creating the status code information.
    imsx_CodeMinor [0..1] Object The set of reported code minor status codes. See Appendix B for further information on the interpretation of this set of codes.
            imsx_codeMinorField [1..*] Array [ Object ] Each reported code minor status code.
                    imsx_codeMinorFieldName [1..1] String This should contain the identity of the system that has produced the code minor status code report. In most cases this will be the target service provider denoted as 'TargetEndSystem'.
                    imsx_codeMinorFieldValue [1..1] Enumeration The code minor status code (this is a value from the corresponding enumerated vocabulary).

An example of the response JSON payload is shown in the code block below. The JSON Schema file that can be used to validate this payload is given in Appendix C1.13b.

Code 6.26.1 - JSON payload example for "default, 400, 401, 403, 422, 429, 500" response messages for a "getAllUsers" operation.
    {
        "imsx_codeMajor" : "success"|"processing"|"failure"|"unsupported",
        "imsx_severity" : "status"|"warning"|"error",
        "imsx_description" : "..String..",
        "imsx_CodeMinor" : {
            "imsx_codeMinorField" : [
                {
                    "imsx_codeMinorFieldName" : "..NormalizedString..",
                    "imsx_codeMinorFieldValue" : "fullsuccess"|"invalid_filter_field"|"invalid_selection_field"|"invaliddata"|"unauthorisedrequest"|"forbidden"|"server_busy"|"unknownobject"|"internal_server_error"
                },
                {...},
                {...}
            ]
        }
    }
                        

6.26.2 Response Payloads for the HTTP Codes (200)

A tabular description of the response payload is shown in the Table below.

Table 6.26.2 - Tabular representation of the JSON payload for "200" response messages for a "getAllUsers" operation.
Property Name Multiplicity JSON Data-type Description
    users [0..*] Array [ Object ] The collection of user instances. The order is not significant. The corresponding query constraints may result in no instances being returned.
            sourcedId [1..1] String The sourcedId of the object. All objects MUST be identified by a Source Identifier. This is a GUID System ID for an object. This is the GUID that SYSTEMS will refer to when making API calls, or when needing to identify an object. It is RECOMMENDED that systems are able to map whichever local ids (e.g. database key fields) they use to SourcedId. The sourcedId of an object is considered an addressable property of an entity and as such will not be treated as Personally Identifiable Information (PII) by certified products. Therefore, as a part of certification, vendors will be required to declare that they will notify customers via documentation or other formal and documented agreement that sourcedIds should never contain PII in general, but particularly users. This means that if a customer includes a student name in an enrollment.sourcedId, it will not fall to any certified product to protect the enrollment.sourcedId as PII, or even the userSourcedId field in the enrollment record.
            status [1..1] Enumeration All objects MUST BE either 'active' or 'tobedeleted'. Something which is flagged 'tobedeleted' is to be considered safe to delete. Systems can delete records that are flagged as such if they wish, but they are not under any compulsion to do so. In v1.1 the enumeration value of 'inactive' was removed and so for backwards compatibility all such marked objects should be interpreted as 'tobedeleted'.
            dateLastModified [1..1] String (Format: date-time) All objects MUST be annotated with the dateTime upon which they were last modified. This enables requesters to query for just the latest objects. DateTimes MUST be expressed in W3C profile of [ISO 8601] and MUST contain the UTC timezone.
            metadata [0..1] Object All objects CAN be extended using the Metadata class. This specification is silent on what implementers may consider to be appropriate extensions. The form of the extension is dependent on the binding technology being used.
                    extensions [0..*] Set of Proprietary Properties The form of the extension is dependent on the binding technology being used. This specification is silent on what implementers may consider to be appropriate extensions.
            userMasterIdentifier [0..1] String The master unique identifier for this user. This is NOT the same as the user's interoperability 'sourcedId'. This should be used to ensure that all of the system identifiers/accounts etc. can be reconciled to the same user. How this identifier is assigned and its format is beyond the scope of this specification.
            username [0..1] String The user name assigned to the user. NOTE - This has been kept for backwards compatibility with OneRoster 1.1 and the new 'userProfiles' characteristic SHOULD be used instead.
            userIds [0..*] Array [ Object ] The set of external user identifiers that should be used for this user, if for some reason the sourcedId cannot be used. This might be an active directory id, an LTI id, or some other machine-readable identifier that is used for this person.
                    type [1..1] String The type of identifier. This is no predefined vocabuary.
                    identifier [1..1] String The user identifier.
            enabledUser [1..1] Enumeration This is used to determine whether or not the record is active in the local system. 'false' denotes that the record is active but system access is curtailed according to the local administration rules.
            givenName [1..1] String The given name. Also, known as the first name.
            familyName [1..1] String The family name. Also, known as the last name.
            middleName [0..1] String The set of middle names. If more than one middle name is needed separate using a space e.g. 'Wingarde Granville'.
            preferredFirstName [0..1] String The user's preferred first name. This attribute was added in version 1.2.
            preferredMiddleName [0..1] String The user's preferred middle name(s). This attribute was added in version 1.2.
            preferredLastName [0..1] String The user's preferred last name. This attribute was added in version 1.2.
            roles [1..*] Array [ Object ] The set of roles for each of the orgs to which the user is affilliated. This is expressed as a set of role/org tuples.
                    roleType [1..1] Enumeration Indicates if this role is the primary or secondary role for that org. There MUST be one, and only one, primary role for each org.
                    role [1..1] Union(RoleEnumExt) The role of the user in the org. The permitted values are from an enumerated list.
                    org [1..1] Object The link to the associated org i.e. the 'sourcedId' for the org.
                            href [1..1] String (Format: uri) The URI for the type of object being referenced.
                            sourcedId [1..1] String The globally unique identifier of the object being referenced.
                            type [1..1] Enumeration The type of object being referenced i.e. an 'org'.
                    userProfile [0..1] String (Format: uri) The identifier for the system/tool/app access account that is relevant to this role in the org. The equivalent UserProfile should exist with a 'profileId' equal to this identifier value.
                    beginDate [0..1] String (Format: date) The start date on which the role becomes active (inclusive).
                    endDate [0..1] String (Format: date) The end date on which the role becomes inactive (exclusive).
            userProfiles [0..*] Array [ Object ] The set of system/app/tool profiles for the user.
                    profileId [1..1] String (Format: uri) The unique identifier for the profile. This does not need to be a globally unique identifier but it must be unique within the scope of the user.
                    profileType [1..1] String The type of profile. This should be a human readable label that has some significance in the context of the related system, app, tool, etc.
                    vendorId [1..1] String The unique identifier for the vendor of the system, tool, app, etc. which requires the use of this profile.
                    applicationId [0..1] String Identifier for the application associated with the account. The nature, and how this identifier is assigned is not defined by this specification. This may have a value of 'default' to denote this account should be used for default access to all applications related to this vendor.
                    description [0..1] String A human readable description of the use of the profile. This should not contain any security information for access to the account.
                    credentials [0..*] Array [ Object ] The set of credentials that are available for access to this profile.
                            type [1..1] String The type of credentials for the profile. This should be indicative of when this specific credential should be used.
                            username [1..1] String The username.
                            password [0..1] String The password in this set of credentials. Care should be taken to ensure that no unencrypted value is revealed.
                            extensions [0..*] Set of Proprietary Properties The set of proprietary extensions to enable other important credential information to be supplied. This information will only be relevant in the context of the corresponding system/app/tool. The form of this information is dependent on the type of binding being used.
            primaryOrg [0..1] Object It is possible for a user to be a member of more than one organization and to have one or more roles in an organization. This attribute identifies the 'sourcedId' of the primary organization.
                    href [1..1] String (Format: uri) The URI for the type of object being referenced.
                    sourcedId [1..1] String The globally unique identifier of the object being referenced.
                    type [1..1] Enumeration The type of object being referenced i.e. an 'org'.
            identifier [0..1] String An identifier for the user. NOTE - This characteristic is kept for backwards compatibility with OneRoster 1.1/1.0. The 'userIds' characteristic SHOULD be used instead.
            email [0..1] String The email address for the user.
            sms [0..1] String The SMS number for the user.
            phone [0..1] String The phone number for the user.
            agents [0..*] Array [ Object ] The links to other people i.e. User 'sourcedIds'.
                    href [1..1] String (Format: uri) The URI for the type of object being referenced.
                    sourcedId [1..1] String The globally unique identifier of the object being referenced.
                    type [1..1] Enumeration The type of object being referenced i.e. a 'user'.
            grades [0..*] Array [ String ] Grade(s) for which a user with role 'student' is enrolled. The permitted vocabulary should be defined as part of the adoption and deployment process. See the Implementation Guide [OR-IMPL-12] for more details on how to define/use such a vocabulary.
            password [0..1] String A top-level password for the user. Care should be taken when using this field and the password SHOULD be encrypted.
            resources [0..*] Array [ Object ] The identifiers (GUIDs) for the set of resources that are to be made available to the user. These are the sourcedIds that should be used for obtaining the metadata about the resources using the OR 1.2 Resources Service [OR-RES-SM-12].
                    href [1..1] String (Format: uri) The URI for the type of object being referenced.
                    sourcedId [1..1] String The globally unique identifier of the object being referenced.
                    type [1..1] Enumeration The type of object being referenced i.e. a 'resource'.

An example of the response JSON payload is shown in the code block below. The JSON Schema file that can be used to validate this payload is given in Appendix C1.13c.

Code 6.26.2 - JSON payload example for "200" response messages for a "getAllUsers" operation.
    {
        "users" : [
            {
                "sourcedId" : "..String..",
                "status" : "active"|"tobedeleted",
                "dateLastModified" : "..Date/Time..",
                "metadata" : {
                    "..permitted extension point.." : "..user defined value.."
                },
                "userMasterIdentifier" : "..NormalizedString..",
                "username" : "..NormalizedString..",
                "userIds" : [
                    {
                        "type" : "..NormalizedString..",
                        "identifier" : "..String.."
                    },
                    {...},
                    {...}
                ],
                "enabledUser" : "true"|"false",
                "givenName" : "..NormalizedString..",
                "familyName" : "..NormalizedString..",
                "middleName" : "..NormalizedString..",
                "preferredFirstName" : "..NormalizedString..",
                "preferredMiddleName" : "..NormalizedString..",
                "preferredLastName" : "..NormalizedString..",
                "roles" : [
                    {
                        "roleType" : "primary"|"secondary",
                        "role" : "..select from Union..",
                        "org" : {
                            "href" : "..URI..",
                            "sourcedId" : "..String..",
                            "type" : "org"
                        },
                        "userProfile" : "..URI..",
                        "beginDate" : "..String(Date)..",
                        "endDate" : "..String(Date).."
                    },
                    {...},
                    {...}
                ],
                "userProfiles" : [
                    {
                        "profileId" : "..URI..",
                        "profileType" : "..NormalizedString..",
                        "vendorId" : "..NormalizedString..",
                        "applicationId" : "..NormalizedString..",
                        "description" : "..String..",
                        "credentials" : [
                            {
                                "type" : "..String..",
                                "username" : "..NormalizedString..",
                                "password" : "..String..",
                                "..permitted extension point.." : "..user defined value.."
                            },
                            {...},
                            {...}
                        ]
                    },
                    {...},
                    {...}
                ],
                "primaryOrg" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "org"
                },
                "identifier" : "..String..",
                "email" : "..NormalizedString..",
                "sms" : "..NormalizedString..",
                "phone" : "..NormalizedString..",
                "agents" : [
                    {
                        "href" : "..URI..",
                        "sourcedId" : "..String..",
                        "type" : "user"
                    },
                    {...},
                    {...}
                ],
                "grades" : [ "..NormalizedString..", ..., "..NormalizedString.." ],
                "password" : "..String..",
                "resources" : [
                    {
                        "href" : "..URI..",
                        "sourcedId" : "..String..",
                        "type" : "resource"
                    },
                    {...},
                    {...}
                ]
            },
            {...},
            {...}
        ]
    }
                        

6.27 "getClass" Request Payload

There is no payload for this request.

6.28 "getClass" Response Payloads

6.28.1 Response Payloads for the HTTP Codes (default, 400, 401, 403, 404, 422, 429, 500)

A tabular description of the response payload is shown in the Table below.

Table 6.28.1 - Tabular representation of the JSON payload for "default, 400, 401, 403, 404, 422, 429, 500" response messages for a "getClass" operation.
Property Name Multiplicity JSON Data-type Description
    imsx_codeMajor [1..1] Enumeration The code major value (from the corresponding enumerated vocabulary). See Appendix B for further information on the interpretation of this set of codes. The permitted vocabulary for the values for the CodeMajor field.
    imsx_severity [1..1] Enumeration The severity value (from the corresponding enumerated vocabulary). See Appendix B for further information on the interpretation of this set of codes.
    imsx_description [0..1] String A human readable description supplied by the entity creating the status code information.
    imsx_CodeMinor [0..1] Object The set of reported code minor status codes. See Appendix B for further information on the interpretation of this set of codes.
            imsx_codeMinorField [1..*] Array [ Object ] Each reported code minor status code.
                    imsx_codeMinorFieldName [1..1] String This should contain the identity of the system that has produced the code minor status code report. In most cases this will be the target service provider denoted as 'TargetEndSystem'.
                    imsx_codeMinorFieldValue [1..1] Enumeration The code minor status code (this is a value from the corresponding enumerated vocabulary).

An example of the response JSON payload is shown in the code block below. The JSON Schema file that can be used to validate this payload is given in Appendix C1.14b.

Code 6.28.1 - JSON payload example for "default, 400, 401, 403, 404, 422, 429, 500" response messages for a "getClass" operation.
    {
        "imsx_codeMajor" : "success"|"processing"|"failure"|"unsupported",
        "imsx_severity" : "status"|"warning"|"error",
        "imsx_description" : "..String..",
        "imsx_CodeMinor" : {
            "imsx_codeMinorField" : [
                {
                    "imsx_codeMinorFieldName" : "..NormalizedString..",
                    "imsx_codeMinorFieldValue" : "fullsuccess"|"invalid_filter_field"|"invalid_selection_field"|"invaliddata"|"unauthorisedrequest"|"forbidden"|"server_busy"|"unknownobject"|"internal_server_error"
                },
                {...},
                {...}
            ]
        }
    }
                        

6.28.2 Response Payloads for the HTTP Codes (200)

A tabular description of the response payload is shown in the Table below.

Table 6.28.2 - Tabular representation of the JSON payload for "200" response messages for a "getClass" operation.
Property Name Multiplicity JSON Data-type Description
    class [1..1] Object The instance of the single class for a message payload. There must be a data payload otherwise an error report payload for the record not being located should be returned.
            sourcedId [1..1] String The sourcedId of the object. All objects MUST be identified by a Source Identifier. This is a GUID System ID for an object. This is the GUID that SYSTEMS will refer to when making API calls, or when needing to identify an object. It is RECOMMENDED that systems are able to map whichever local ids (e.g. database key fields) they use to SourcedId. The sourcedId of an object is considered an addressable property of an entity and as such will not be treated as Personally Identifiable Information (PII) by certified products. Therefore, as a part of certification, vendors will be required to declare that they will notify customers via documentation or other formal and documented agreement that sourcedIds should never contain PII in general, but particularly users. This means that if a customer includes a student name in an enrollment.sourcedId, it will not fall to any certified product to protect the enrollment.sourcedId as PII, or even the userSourcedId field in the enrollment record.
            status [1..1] Enumeration All objects MUST BE either 'active' or 'tobedeleted'. Something which is flagged 'tobedeleted' is to be considered safe to delete. Systems can delete records that are flagged as such if they wish, but they are not under any compulsion to do so. In v1.1 the enumeration value of 'inactive' was removed and so for backwards compatibility all such marked objects should be interpreted as 'tobedeleted'.
            dateLastModified [1..1] String (Format: date-time) All objects MUST be annotated with the dateTime upon which they were last modified. This enables requesters to query for just the latest objects. DateTimes MUST be expressed in W3C profile of [ISO 8601] and MUST contain the UTC timezone.
            metadata [0..1] Object All objects CAN be extended using the Metadata class. This specification is silent on what implementers may consider to be appropriate extensions. The form of the extension is dependent on the binding technology being used.
                    extensions [0..*] Set of Proprietary Properties The form of the extension is dependent on the binding technology being used. This specification is silent on what implementers may consider to be appropriate extensions.
            title [1..1] String The tile/label for the class.
            classCode [0..1] String The class code.
            classType [0..1] Union(ClassTypeEnumExt) The type of class. This is based upon an enumerated vocabulary.
            location [0..1] String The location for the class e.g. 'Room 19'.
            grades [0..*] Array [ String ] The grade(s) who attend the class. The permitted vocabulary should be defined as part of the adoption and deployment process. See the Implementation Guide [OR-IMPL-12] for more details on how to define/use such a vocabulary.
            subjects [0..*] Array [ String ] The set of subjects addressed by this class e.g. 'chemistry'.
            course [1..1] Object The link to the associated course i.e. the Course 'sourcedId'.
                    href [1..1] String (Format: uri) The URI for the type of object being referenced.
                    sourcedId [1..1] String The globally unique identifier of the object being referenced.
                    type [1..1] Enumeration The type of object being referenced i.e. a 'course'.
            school [1..1] Object The link to the associated school i.e. the School 'sourcedId'.
                    href [1..1] String (Format: uri) The URI for the type of object being referenced.
                    sourcedId [1..1] String The globally unique identifier of the object being referenced.
                    type [1..1] Enumeration The type of object being referenced i.e. an 'org'.
            terms [1..*] Array [ Object ] The links to the set of terms or semesters (academicSession) i.e. the set of 'sourcedIds' for the terms within the associated school year.
                    href [1..1] String (Format: uri) The URI for the type of object being referenced.
                    sourcedId [1..1] String The globally unique identifier of the object being referenced.
                    type [1..1] Enumeration The type of object being referenced i.e. an 'academicSession'.
            subjectCodes [0..*] Array [ String ] This is a machine readable set of codes and the number should match the associated 'subjects' attribute. The vocabulary for this characteristic should be defined as part of the local addition of this specification (see the Implementation Guide [OR-IMPL-12] for more details).
            periods [0..*] Array [ String ] The time slots in the day that the class will be given. Examples are 1 or a list of 1, 3, 5, etc.
            resources [0..*] Array [ Object ] The links to the set of associated resources i.e. the Resource 'sourcedIds'.
                    href [1..1] String (Format: uri) The URI for the type of object being referenced.
                    sourcedId [1..1] String The globally unique identifier of the object being referenced.
                    type [1..1] Enumeration The type of object being referenced i.e. a 'resource'.

An example of the response JSON payload is shown in the code block below. The JSON Schema file that can be used to validate this payload is given in Appendix C1.14c.

Code 6.28.2 - JSON payload example for "200" response messages for a "getClass" operation.
    {
        "class" : {
            "sourcedId" : "..String..",
            "status" : "active"|"tobedeleted",
            "dateLastModified" : "..Date/Time..",
            "metadata" : {
                "..permitted extension point.." : "..user defined value.."
            },
            "title" : "..NormalizedString..",
            "classCode" : "..NormalizedString..",
            "classType" : "..select from Union..",
            "location" : "..NormalizedString..",
            "grades" : [ "..NormalizedString..", ..., "..NormalizedString.." ],
            "subjects" : [ "..NormalizedString..", ..., "..NormalizedString.." ],
            "course" : {
                "href" : "..URI..",
                "sourcedId" : "..String..",
                "type" : "course"
            },
            "school" : {
                "href" : "..URI..",
                "sourcedId" : "..String..",
                "type" : "org"
            },
            "terms" : [
                {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "academicSession"
                },
                {...},
                {...}
            ],
            "subjectCodes" : [ "..NormalizedString..", ..., "..NormalizedString.." ],
            "periods" : [ "..NormalizedString..", ..., "..NormalizedString.." ],
            "resources" : [
                {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "resource"
                },
                {...},
                {...}
            ]
        }
    }
                        

6.29 "getClassesForCourse" Request Payload

There is no payload for this request.

6.30 "getClassesForCourse" Response Payloads

6.30.1 Response Payloads for the HTTP Codes (default, 400, 401, 403, 422, 429, 500)

A tabular description of the response payload is shown in the Table below.

Table 6.30.1 - Tabular representation of the JSON payload for "default, 400, 401, 403, 422, 429, 500" response messages for a "getClassesForCourse" operation.
Property Name Multiplicity JSON Data-type Description
    imsx_codeMajor [1..1] Enumeration The code major value (from the corresponding enumerated vocabulary). See Appendix B for further information on the interpretation of this set of codes. The permitted vocabulary for the values for the CodeMajor field.
    imsx_severity [1..1] Enumeration The severity value (from the corresponding enumerated vocabulary). See Appendix B for further information on the interpretation of this set of codes.
    imsx_description [0..1] String A human readable description supplied by the entity creating the status code information.
    imsx_CodeMinor [0..1] Object The set of reported code minor status codes. See Appendix B for further information on the interpretation of this set of codes.
            imsx_codeMinorField [1..*] Array [ Object ] Each reported code minor status code.
                    imsx_codeMinorFieldName [1..1] String This should contain the identity of the system that has produced the code minor status code report. In most cases this will be the target service provider denoted as 'TargetEndSystem'.
                    imsx_codeMinorFieldValue [1..1] Enumeration The code minor status code (this is a value from the corresponding enumerated vocabulary).

An example of the response JSON payload is shown in the code block below. The JSON Schema file that can be used to validate this payload is given in Appendix C1.15b.

Code 6.30.1 - JSON payload example for "default, 400, 401, 403, 422, 429, 500" response messages for a "getClassesForCourse" operation.
    {
        "imsx_codeMajor" : "success"|"processing"|"failure"|"unsupported",
        "imsx_severity" : "status"|"warning"|"error",
        "imsx_description" : "..String..",
        "imsx_CodeMinor" : {
            "imsx_codeMinorField" : [
                {
                    "imsx_codeMinorFieldName" : "..NormalizedString..",
                    "imsx_codeMinorFieldValue" : "fullsuccess"|"invalid_filter_field"|"invalid_selection_field"|"invaliddata"|"unauthorisedrequest"|"forbidden"|"server_busy"|"unknownobject"|"internal_server_error"
                },
                {...},
                {...}
            ]
        }
    }
                        

6.30.2 Response Payloads for the HTTP Codes (200)

A tabular description of the response payload is shown in the Table below.

Table 6.30.2 - Tabular representation of the JSON payload for "200" response messages for a "getClassesForCourse" operation.
Property Name Multiplicity JSON Data-type Description
    classes [0..*] Array [ Object ] The collection of class instances. The order is not significant. The corresponding query constraints may result in no instances being returned.
            sourcedId [1..1] String The sourcedId of the object. All objects MUST be identified by a Source Identifier. This is a GUID System ID for an object. This is the GUID that SYSTEMS will refer to when making API calls, or when needing to identify an object. It is RECOMMENDED that systems are able to map whichever local ids (e.g. database key fields) they use to SourcedId. The sourcedId of an object is considered an addressable property of an entity and as such will not be treated as Personally Identifiable Information (PII) by certified products. Therefore, as a part of certification, vendors will be required to declare that they will notify customers via documentation or other formal and documented agreement that sourcedIds should never contain PII in general, but particularly users. This means that if a customer includes a student name in an enrollment.sourcedId, it will not fall to any certified product to protect the enrollment.sourcedId as PII, or even the userSourcedId field in the enrollment record.
            status [1..1] Enumeration All objects MUST BE either 'active' or 'tobedeleted'. Something which is flagged 'tobedeleted' is to be considered safe to delete. Systems can delete records that are flagged as such if they wish, but they are not under any compulsion to do so. In v1.1 the enumeration value of 'inactive' was removed and so for backwards compatibility all such marked objects should be interpreted as 'tobedeleted'.
            dateLastModified [1..1] String (Format: date-time) All objects MUST be annotated with the dateTime upon which they were last modified. This enables requesters to query for just the latest objects. DateTimes MUST be expressed in W3C profile of [ISO 8601] and MUST contain the UTC timezone.
            metadata [0..1] Object All objects CAN be extended using the Metadata class. This specification is silent on what implementers may consider to be appropriate extensions. The form of the extension is dependent on the binding technology being used.
                    extensions [0..*] Set of Proprietary Properties The form of the extension is dependent on the binding technology being used. This specification is silent on what implementers may consider to be appropriate extensions.
            title [1..1] String The tile/label for the class.
            classCode [0..1] String The class code.
            classType [0..1] Union(ClassTypeEnumExt) The type of class. This is based upon an enumerated vocabulary.
            location [0..1] String The location for the class e.g. 'Room 19'.
            grades [0..*] Array [ String ] The grade(s) who attend the class. The permitted vocabulary should be defined as part of the adoption and deployment process. See the Implementation Guide [OR-IMPL-12] for more details on how to define/use such a vocabulary.
            subjects [0..*] Array [ String ] The set of subjects addressed by this class e.g. 'chemistry'.
            course [1..1] Object The link to the associated course i.e. the Course 'sourcedId'.
                    href [1..1] String (Format: uri) The URI for the type of object being referenced.
                    sourcedId [1..1] String The globally unique identifier of the object being referenced.
                    type [1..1] Enumeration The type of object being referenced i.e. a 'course'.
            school [1..1] Object The link to the associated school i.e. the School 'sourcedId'.
                    href [1..1] String (Format: uri) The URI for the type of object being referenced.
                    sourcedId [1..1] String The globally unique identifier of the object being referenced.
                    type [1..1] Enumeration The type of object being referenced i.e. an 'org'.
            terms [1..*] Array [ Object ] The links to the set of terms or semesters (academicSession) i.e. the set of 'sourcedIds' for the terms within the associated school year.
                    href [1..1] String (Format: uri) The URI for the type of object being referenced.
                    sourcedId [1..1] String The globally unique identifier of the object being referenced.
                    type [1..1] Enumeration The type of object being referenced i.e. an 'academicSession'.
            subjectCodes [0..*] Array [ String ] This is a machine readable set of codes and the number should match the associated 'subjects' attribute. The vocabulary for this characteristic should be defined as part of the local addition of this specification (see the Implementation Guide [OR-IMPL-12] for more details).
            periods [0..*] Array [ String ] The time slots in the day that the class will be given. Examples are 1 or a list of 1, 3, 5, etc.
            resources [0..*] Array [ Object ] The links to the set of associated resources i.e. the Resource 'sourcedIds'.
                    href [1..1] String (Format: uri) The URI for the type of object being referenced.
                    sourcedId [1..1] String The globally unique identifier of the object being referenced.
                    type [1..1] Enumeration The type of object being referenced i.e. a 'resource'.

An example of the response JSON payload is shown in the code block below. The JSON Schema file that can be used to validate this payload is given in Appendix C1.15c.

Code 6.30.2 - JSON payload example for "200" response messages for a "getClassesForCourse" operation.
    {
        "classes" : [
            {
                "sourcedId" : "..String..",
                "status" : "active"|"tobedeleted",
                "dateLastModified" : "..Date/Time..",
                "metadata" : {
                    "..permitted extension point.." : "..user defined value.."
                },
                "title" : "..NormalizedString..",
                "classCode" : "..NormalizedString..",
                "classType" : "..select from Union..",
                "location" : "..NormalizedString..",
                "grades" : [ "..NormalizedString..", ..., "..NormalizedString.." ],
                "subjects" : [ "..NormalizedString..", ..., "..NormalizedString.." ],
                "course" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "course"
                },
                "school" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "org"
                },
                "terms" : [
                    {
                        "href" : "..URI..",
                        "sourcedId" : "..String..",
                        "type" : "academicSession"
                    },
                    {...},
                    {...}
                ],
                "subjectCodes" : [ "..NormalizedString..", ..., "..NormalizedString.." ],
                "periods" : [ "..NormalizedString..", ..., "..NormalizedString.." ],
                "resources" : [
                    {
                        "href" : "..URI..",
                        "sourcedId" : "..String..",
                        "type" : "resource"
                    },
                    {...},
                    {...}
                ]
            },
            {...},
            {...}
        ]
    }
                        

6.31 "getClassesForSchool" Request Payload

There is no payload for this request.

6.32 "getClassesForSchool" Response Payloads

6.32.1 Response Payloads for the HTTP Codes (default, 400, 401, 403, 422, 429, 500)

A tabular description of the response payload is shown in the Table below.

Table 6.32.1 - Tabular representation of the JSON payload for "default, 400, 401, 403, 422, 429, 500" response messages for a "getClassesForSchool" operation.
Property Name Multiplicity JSON Data-type Description
    imsx_codeMajor [1..1] Enumeration The code major value (from the corresponding enumerated vocabulary). See Appendix B for further information on the interpretation of this set of codes. The permitted vocabulary for the values for the CodeMajor field.
    imsx_severity [1..1] Enumeration The severity value (from the corresponding enumerated vocabulary). See Appendix B for further information on the interpretation of this set of codes.
    imsx_description [0..1] String A human readable description supplied by the entity creating the status code information.
    imsx_CodeMinor [0..1] Object The set of reported code minor status codes. See Appendix B for further information on the interpretation of this set of codes.
            imsx_codeMinorField [1..*] Array [ Object ] Each reported code minor status code.
                    imsx_codeMinorFieldName [1..1] String This should contain the identity of the system that has produced the code minor status code report. In most cases this will be the target service provider denoted as 'TargetEndSystem'.
                    imsx_codeMinorFieldValue [1..1] Enumeration The code minor status code (this is a value from the corresponding enumerated vocabulary).

An example of the response JSON payload is shown in the code block below. The JSON Schema file that can be used to validate this payload is given in Appendix C1.16b.