IMS Candidate Final Public

IMS Global Logo

IMS OneRoster Gradebook 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 Gradebook 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 Gradebook Service provides the ability to manage the exchange of information about results, line items, categories (collections of line items) and score scales. It is also possible to exchange information about assessment activities in the form of assessment lineItems and assessment results. 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 Gradebook 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 "deleteAssessmentLineItem" Endpoint Query Parameters

2.3.2 "deleteAssessmentResult" Endpoint Query Parameters

2.3.3 "deleteCategory" Endpoint Query Parameters

2.3.4 "deleteLineItem" Endpoint Query Parameters

2.3.5 "deleteResult" Endpoint Query Parameters

2.3.6 "deleteScoreScale" Endpoint Query Parameters

2.3.7 "getAllAssessmentLineItems" Endpoint Query Parameters

2.3.8 "getAllAssessmentResults" Endpoint Query Parameters

2.3.9 "getAllCategories" Endpoint Query Parameters

2.3.10 "getAllLineItems" Endpoint Query Parameters

2.3.11 "getAllResults" Endpoint Query Parameters

2.3.12 "getAllScoreScales" Endpoint Query Parameters

2.3.13 "getAssessmentLineItem" Endpoint Query Parameters

2.3.14 "getAssessmentResult" Endpoint Query Parameters

2.3.15 "getCategoriesForClass" Endpoint Query Parameters

2.3.16 "getCategory" Endpoint Query Parameters

2.3.17 "getLineItem" Endpoint Query Parameters

2.3.18 "getLineItemsForClass" Endpoint Query Parameters

2.3.19 "getResult" Endpoint Query Parameters

2.3.20 "getResultsForClass" Endpoint Query Parameters

2.3.21 "getResultsForLineItemForClass" Endpoint Query Parameters

2.3.22 "getResultsForStudentForClass" Endpoint Query Parameters

2.3.23 "getScoreScale" Endpoint Query Parameters

2.3.24 "getScoreScalesForClass" Endpoint Query Parameters

2.3.25 "getScoreScalesForSchool" Endpoint Query Parameters

2.3.26 "postLineItemsForClass" Endpoint Query Parameters

2.3.27 "postLineItemsForSchool" Endpoint Query Parameters

2.3.28 "postResultsForAcademicSessionForClass" Endpoint Query Parameters

2.3.29 "postResultsForLineItem" Endpoint Query Parameters

2.3.30 "putAssessmentLineItem" Endpoint Query Parameters

2.3.31 "putAssessmentResult" Endpoint Query Parameters

2.3.32 "putCategory" Endpoint Query Parameters

2.3.33 "putLineItem" Endpoint Query Parameters

2.3.34 "putResult" Endpoint Query Parameters

2.3.35 "putScoreScale" 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 "https://purl.imsglobal.org/spec/or/v1p2/scope/assessment.createput" Scope

4.3.2 "https://purl.imsglobal.org/spec/or/v1p2/scope/assessment.delete" Scope

4.3.3 "https://purl.imsglobal.org/spec/or/v1p2/scope/assessment.readonly" Scope

4.3.4 "https://purl.imsglobal.org/spec/or/v1p2/scope/gradebook-core.readonly" Scope

4.3.5 "https://purl.imsglobal.org/spec/or/v1p2/scope/gradebook.createpost" Scope

4.3.6 "https://purl.imsglobal.org/spec/or/v1p2/scope/gradebook.createput" Scope

4.3.7 "https://purl.imsglobal.org/spec/or/v1p2/scope/gradebook.delete" Scope

4.3.8 "https://purl.imsglobal.org/spec/or/v1p2/scope/gradebook.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 CategoriesSet Service Parameter Payload Class Mapping

5.2.2 SingleCategory Service Parameter Payload Class Mapping

5.2.3 ResultSet Service Parameter Payload Class Mapping

5.2.4 LineItemSet Service Parameter Payload Class Mapping

5.2.5 ScoreScaleSet Service Parameter Payload Class Mapping

5.2.6 GUIDPairSet Service Parameter Payload Class Mapping

5.2.7 SingleResult Service Parameter Payload Class Mapping

5.2.8 SingleLineItem Service Parameter Payload Class Mapping

5.2.9 SingleScoreScale Service Parameter Payload Class Mapping

5.2.10 AssessmentLineItemSet Service Parameter Payload Class Mapping

5.2.11 SingleAssessmentLineItem Service Parameter Payload Class Mapping

5.2.12 AssessmentResultSet Service Parameter Payload Class Mapping

5.2.13 SingleAssessmentResult Service Parameter Payload Class Mapping

5.3 Payload Classes UML/JSON Mapping

5.3.1 AcadSessionGUIDRef Payload Class Mapping

5.3.2 AssessmentLineItem Payload Class Mapping

5.3.3 AssessmentLineItemGUIDRef Payload Class Mapping

5.3.4 AssessmentResult Payload Class Mapping

5.3.5 Base Payload Class Mapping

5.3.6 Category Payload Class Mapping

5.3.7 CategoryGUIDRef Payload Class Mapping

5.3.8 ClassGUIDRef Payload Class Mapping

5.3.9 CourseGUIDRef Payload Class Mapping

5.3.10 GUIDPair Payload Class Mapping

5.3.11 GUIDRef Payload Class Mapping

5.3.12 LearningObjectiveResults Payload Class Mapping

5.3.13 LearningObjectiveScoreSet Payload Class Mapping

5.3.14 LearningObjectiveSet Payload Class Mapping

5.3.15 LineItem Payload Class Mapping

5.3.16 LineItemGUIDRef Payload Class Mapping

5.3.17 Metadata Payload Class Mapping

5.3.18 OrgGUIDRef Payload Class Mapping

5.3.19 Result Payload Class Mapping

5.3.20 ScoreScale Payload Class Mapping

5.3.21 ScoreScaleGUIDRef Payload Class Mapping

5.3.22 ScoreScaleValue Payload Class Mapping

5.3.23 UserGUIDRef Payload Class Mapping

5.3.24 imsx_CodeMinor Payload Class Mapping

5.3.25 imsx_CodeMinorField Payload Class Mapping

5.3.26 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 "deleteAssessmentLineItem" Request Payload

6.2 "deleteAssessmentLineItem" Response Payload

6.2.1 Response Payloads for the HTTP Codes (204)

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

6.3 "deleteAssessmentResult" Request Payload

6.4 "deleteAssessmentResult" Response Payload

6.4.1 Response Payloads for the HTTP Codes (204)

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

6.5 "deleteCategory" Request Payload

6.6 "deleteCategory" Response Payload

6.6.1 Response Payloads for the HTTP Codes (204)

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

6.7 "deleteLineItem" Request Payload

6.8 "deleteLineItem" Response Payload

6.8.1 Response Payloads for the HTTP Codes (204)

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

6.9 "deleteResult" Request Payload

6.10 "deleteResult" Response Payload

6.10.1 Response Payloads for the HTTP Codes (204)

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

6.11 "deleteScoreScale" Request Payload

6.12 "deleteScoreScale" Response Payload

6.12.1 Response Payloads for the HTTP Codes (204)

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

6.13 "getAllAssessmentLineItems" Request Payload

6.14 "getAllAssessmentLineItems" Response Payload

6.14.1 Response Payloads for the HTTP Codes (200)

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

6.15 "getAllAssessmentResults" Request Payload

6.16 "getAllAssessmentResults" Response Payload

6.16.1 Response Payloads for the HTTP Codes (200)

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

6.17 "getAllCategories" Request Payload

6.18 "getAllCategories" Response Payload

6.18.1 Response Payloads for the HTTP Codes (200)

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

6.19 "getAllLineItems" Request Payload

6.20 "getAllLineItems" Response Payload

6.20.1 Response Payloads for the HTTP Codes (200)

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

6.21 "getAllResults" Request Payload

6.22 "getAllResults" Response Payload

6.22.1 Response Payloads for the HTTP Codes (200)

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

6.23 "getAllScoreScales" Request Payload

6.24 "getAllScoreScales" Response Payload

6.24.1 Response Payloads for the HTTP Codes (200)

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

6.25 "getAssessmentLineItem" Request Payload

6.26 "getAssessmentLineItem" Response Payload

6.26.1 Response Payloads for the HTTP Codes (200)

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

6.27 "getAssessmentResult" Request Payload

6.28 "getAssessmentResult" Response Payload

6.28.1 Response Payloads for the HTTP Codes (200)

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

6.29 "getCategoriesForClass" Request Payload

6.30 "getCategoriesForClass" Response Payload

6.30.1 Response Payloads for the HTTP Codes (200)

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

6.31 "getCategory" Request Payload

6.32 "getCategory" Response Payload

6.32.1 Response Payloads for the HTTP Codes (200)

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

6.33 "getLineItem" Request Payload

6.34 "getLineItem" Response Payload

6.34.1 Response Payloads for the HTTP Codes (200)

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

6.35 "getLineItemsForClass" Request Payload

6.36 "getLineItemsForClass" Response Payload

6.36.1 Response Payloads for the HTTP Codes (200)

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

6.37 "getResult" Request Payload

6.38 "getResult" Response Payload

6.38.1 Response Payloads for the HTTP Codes (200)

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

6.39 "getResultsForClass" Request Payload

6.40 "getResultsForClass" Response Payload

6.40.1 Response Payloads for the HTTP Codes (200)

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

6.41 "getResultsForLineItemForClass" Request Payload

6.42 "getResultsForLineItemForClass" Response Payload

6.42.1 Response Payloads for the HTTP Codes (200)

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

6.43 "getResultsForStudentForClass" Request Payload

6.44 "getResultsForStudentForClass" Response Payload

6.44.1 Response Payloads for the HTTP Codes (200)

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

6.45 "getScoreScale" Request Payload

6.46 "getScoreScale" Response Payload

6.46.1 Response Payloads for the HTTP Codes (200)

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

6.47 "getScoreScalesForClass" Request Payload

6.48 "getScoreScalesForClass" Response Payload

6.48.1 Response Payloads for the HTTP Codes (200)

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

6.49 "getScoreScalesForSchool" Request Payload

6.50 "getScoreScalesForSchool" Response Payload

6.50.1 Response Payloads for the HTTP Codes (200)

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

6.51 "postLineItemsForClass" Request Payload

6.52 "postLineItemsForClass" Response Payload

6.52.1 Response Payloads for the HTTP Codes (201)

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

6.53 "postLineItemsForSchool" Request Payload

6.54 "postLineItemsForSchool" Response Payload

6.54.1 Response Payloads for the HTTP Codes (201)

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

6.55 "postResultsForAcademicSessionForClass" Request Payload

6.56 "postResultsForAcademicSessionForClass" Response Payload

6.56.1 Response Payloads for the HTTP Codes (201)

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

6.57 "postResultsForLineItem" Request Payload

6.58 "postResultsForLineItem" Response Payload

6.58.1 Response Payloads for the HTTP Codes (201)

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

6.59 "putAssessmentLineItem" Request Payload

6.60 "putAssessmentLineItem" Response Payload

6.60.1 Response Payloads for the HTTP Codes (201)

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

6.61 "putAssessmentResult" Request Payload

6.62 "putAssessmentResult" Response Payload

6.62.1 Response Payloads for the HTTP Codes (201)

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

6.63 "putCategory" Request Payload

6.64 "putCategory" Response Payload

6.64.1 Response Payloads for the HTTP Codes (201)

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

6.65 "putLineItem" Request Payload

6.66 "putLineItem" Response Payload

6.66.1 Response Payloads for the HTTP Codes (201)

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

6.67 "putResult" Request Payload

6.68 "putResult" Response Payload

6.68.1 Response Payloads for the HTTP Codes (201)

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

6.69 "putScoreScale" Request Payload

6.70 "putScoreScale" Response Payload

6.70.1 Response Payloads for the HTTP Codes (201)

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

7. OpenAPI Description

7.1 General Information

7.2 Tags Information

7.3 Security Information

7.4 Paths Information

7.4.1 "/assessmentLineItems" Path

7.4.2 "/assessmentLineItems/{sourcedId}" Path

7.4.3 "/assessmentResults" Path

7.4.4 "/assessmentResults/{sourcedId}" Path

7.4.5 "/categories" Path

7.4.6 "/categories/{sourcedId}" Path

7.4.7 "/classes/{classSourcedId}/academicSessions/{academicSessionSourcedId}/results" Path

7.4.8 "/classes/{classSourcedId}/categories" Path

7.4.9 "/classes/{classSourcedId}/lineItems" Path

7.4.10 "/classes/{classSourcedId}/lineItems/{lineItemSourcedId}/results" Path

7.4.11 "/classes/{classSourcedId}/results" Path

7.4.12 "/classes/{classSourcedId}/scoreScales" Path

7.4.13 "/classes/{classSourcedId}/students/{studentSourcedId}/results" Path

7.4.14 "/lineItems" Path

7.4.15 "/lineItems/{lineItemSourcedId}/results" Path

7.4.16 "/lineItems/{sourcedId}" Path

7.4.17 "/results" Path

7.4.18 "/results/{sourcedId}" Path

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

7.4.20 "/schools/{schoolSourcedId}/scoreScales" Path

7.4.21 "/scoreScales" Path

7.4.22 "/scoreScales/{sourcedId}" Path

7.5 Definitions Information

7.5.1 "AcadSessionGUIDRefDType" Definition

7.5.2 "AssessmentLineItemDType" Definition

7.5.3 "AssessmentLineItemGUIDRefDType" Definition

7.5.4 "AssessmentLineItemSetDType" Definition

7.5.5 "AssessmentResultDType" Definition

7.5.6 "AssessmentResultSetDType" Definition

7.5.7 "CategoriesSetDType" Definition

7.5.8 "CategoryDType" Definition

7.5.9 "CategoryGUIDRefDType" Definition

7.5.10 "ClassGUIDRefDType" Definition

7.5.11 "CourseGUIDRefDType" Definition

7.5.12 "GUIDPairDType" Definition

7.5.13 "GUIDPairSetDType" Definition

7.5.14 "LearningObjectiveResultsDType" Definition

7.5.15 "LearningObjectiveScoreSetDType" Definition

7.5.16 "LearningObjectiveSetDType" Definition

7.5.17 "LineItemDType" Definition

7.5.18 "LineItemGUIDRefDType" Definition

7.5.19 "LineItemSetDType" Definition

7.5.20 "MetadataDType" Definition

7.5.21 "OrgGUIDRefDType" Definition

7.5.22 "ResultDType" Definition

7.5.23 "ResultSetDType" Definition

7.5.24 "ScoreScaleDType" Definition

7.5.25 "ScoreScaleGUIDRefDType" Definition

7.5.26 "ScoreScaleSetDType" Definition

7.5.27 "ScoreScaleValueDType" Definition

7.5.28 "SingleAssessmentLineItemDType" Definition

7.5.29 "SingleAssessmentResultDType" Definition

7.5.30 "SingleCategoryDType" Definition

7.5.31 "SingleLineItemDType" Definition

7.5.32 "SingleResultDType" Definition

7.5.33 "SingleScoreScaleDType" Definition

7.5.34 "UserGUIDRefDType" Definition

7.5.35 "imsx_CodeMinorDType" Definition

7.5.36 "imsx_CodeMinorFieldDType" Definition

7.5.37 "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 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 "deleteAssessmentLineItem" Operation Request Payload Validation.

C1.1b JSON Schema for the "deleteAssessmentLineItem" Operation Response Payload Validation for HTTP Codes (204)

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

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

C1.2b JSON Schema for the "deleteAssessmentResult" Operation Response Payload Validation for HTTP Codes (204)

C1.2c JSON Schema for the "deleteAssessmentResult" Operation Response Payload Validation for HTTP Codes (default,401,403,404,422,429,500)

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

C1.3b JSON Schema for the "deleteCategory" Operation Response Payload Validation for HTTP Codes (204)

C1.3c JSON Schema for the "deleteCategory" Operation Response Payload Validation for HTTP Codes (default,401,403,404,422,429,500)

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

C1.4b JSON Schema for the "deleteLineItem" Operation Response Payload Validation for HTTP Codes (204)

C1.4c JSON Schema for the "deleteLineItem" Operation Response Payload Validation for HTTP Codes (default,401,403,404,422,429,500)

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

C1.5b JSON Schema for the "deleteResult" Operation Response Payload Validation for HTTP Codes (204)

C1.5c JSON Schema for the "deleteResult" Operation Response Payload Validation for HTTP Codes (default,401,403,404,422,429,500)

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

C1.6b JSON Schema for the "deleteScoreScale" Operation Response Payload Validation for HTTP Codes (204)

C1.6c JSON Schema for the "deleteScoreScale" Operation Response Payload Validation for HTTP Codes (default,401,403,404,422,429,500)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

C1.26b JSON Schema for the "postLineItemsForClass" Operation Response Payload Validation for HTTP Codes (201)

C1.26c JSON Schema for the "postLineItemsForClass" Operation Response Payload Validation for HTTP Codes (default,401,403,404,422,429,500)

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

C1.27b JSON Schema for the "postLineItemsForSchool" Operation Response Payload Validation for HTTP Codes (201)

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

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

C1.28b JSON Schema for the "postResultsForAcademicSessionForClass" Operation Response Payload Validation for HTTP Codes (201)

C1.28c JSON Schema for the "postResultsForAcademicSessionForClass" Operation Response Payload Validation for HTTP Codes (default,401,403,404,422,429,500)

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

C1.29b JSON Schema for the "postResultsForLineItem" Operation Response Payload Validation for HTTP Codes (201)

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

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

C1.30b JSON Schema for the "putAssessmentLineItem" Operation Response Payload Validation for HTTP Codes (201)

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

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

C1.31b JSON Schema for the "putAssessmentResult" Operation Response Payload Validation for HTTP Codes (201)

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

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

C1.32b JSON Schema for the "putCategory" Operation Response Payload Validation for HTTP Codes (201)

C1.32c JSON Schema for the "putCategory" Operation Response Payload Validation for HTTP Codes (default,401,403,404,422,429,500)

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

C1.33b JSON Schema for the "putLineItem" Operation Response Payload Validation for HTTP Codes (201)

C1.33c JSON Schema for the "putLineItem" Operation Response Payload Validation for HTTP Codes (default,401,403,404,422,429,500)

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

C1.34b JSON Schema for the "putResult" Operation Response Payload Validation for HTTP Codes (201)

C1.34c JSON Schema for the "putResult" Operation Response Payload Validation for HTTP Codes (default,401,403,404,422,429,500)

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

C1.35b JSON Schema for the "putScoreScale" Operation Response Payload Validation for HTTP Codes (201)

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

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 "https://purl.imsglobal.org/spec/or/v1p2/scope/assessment.createput" Scope

Table 4.3.2 "https://purl.imsglobal.org/spec/or/v1p2/scope/assessment.delete" Scope

Table 4.3.3 "https://purl.imsglobal.org/spec/or/v1p2/scope/assessment.readonly" Scope

Table 4.3.4 "https://purl.imsglobal.org/spec/or/v1p2/scope/gradebook-core.readonly" Scope

Table 4.3.5 "https://purl.imsglobal.org/spec/or/v1p2/scope/gradebook.createpost" Scope

Table 4.3.6 "https://purl.imsglobal.org/spec/or/v1p2/scope/gradebook.createput" Scope

Table 4.3.7 "https://purl.imsglobal.org/spec/or/v1p2/scope/gradebook.delete" Scope

Table 4.3.8 "https://purl.imsglobal.org/spec/or/v1p2/scope/gradebook.readonly" Scope

Table 6.51.1 - Tabular representation of the JSON payload for the request message for a "postLineItemsForClass" operation.

Table 6.53.1 - Tabular representation of the JSON payload for the request message for a "postLineItemsForSchool" operation.

Table 6.55.1 - Tabular representation of the JSON payload for the request message for a "postResultsForAcademicSessionForClass" operation.

Table 6.57.1 - Tabular representation of the JSON payload for the request message for a "postResultsForLineItem" operation.

Table 6.59.1 - Tabular representation of the JSON payload for the request message for a "putAssessmentLineItem" operation.

Table 6.61.1 - Tabular representation of the JSON payload for the request message for a "putAssessmentResult" operation.

Table 6.63.1 - Tabular representation of the JSON payload for the request message for a "putCategory" operation.

Table 6.65.1 - Tabular representation of the JSON payload for the request message for a "putLineItem" operation.

Table 6.67.1 - Tabular representation of the JSON payload for the request message for a "putResult" operation.

Table 6.69.1 - Tabular representation of the JSON payload for the request message for a "putScoreScale" operation.

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 "/assessmentLineItems" Path.

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

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

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

Table 7.4.5 - The Set of HTTP Verbs Permitted on the "/categories" Path.

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

Table 7.4.7 - The Set of HTTP Verbs Permitted on the "/classes/{classSourcedId}/academicSessions/{academicSessionSourcedId}/results" Path.

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

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

Table 7.4.10 - The Set of HTTP Verbs Permitted on the "/classes/{classSourcedId}/lineItems/{lineItemSourcedId}/results" Path.

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

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

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

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

Table 7.4.15 - The Set of HTTP Verbs Permitted on the "/lineItems/{lineItemSourcedId}/results" Path.

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

Table 7.4.17 - The Set of HTTP Verbs Permitted on the "/results" Path.

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

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

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

Table 7.4.21 - The Set of HTTP Verbs Permitted on the "/scoreScales" Path.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Table 7.5.39 - 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.2 - JSON payload example for "default, 401, 403, 404, 422, 429, 500" response messages for a "deleteAssessmentLineItem" operation.

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

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

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

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

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

Code 6.14.1 - JSON payload example for "200" response messages for a "getAllAssessmentLineItems" operation.

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

Code 6.16.1 - JSON payload example for "200" response messages for a "getAllAssessmentResults" operation.

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

Code 6.18.1 - JSON payload example for "200" response messages for a "getAllCategories" operation.

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

Code 6.20.1 - JSON payload example for "200" response messages for a "getAllLineItems" operation.

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

Code 6.22.1 - JSON payload example for "200" response messages for a "getAllResults" operation.

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

Code 6.24.1 - JSON payload example for "200" response messages for a "getAllScoreScales" operation.

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

Code 6.26.1 - JSON payload example for "200" response messages for a "getAssessmentLineItem" operation.

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

Code 6.28.1 - JSON payload example for "200" response messages for a "getAssessmentResult" operation.

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

Code 6.30.1 - JSON payload example for "200" response messages for a "getCategoriesForClass" operation.

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

Code 6.32.1 - JSON payload example for "200" response messages for a "getCategory" operation.

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

Code 6.34.1 - JSON payload example for "200" response messages for a "getLineItem" operation.

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

Code 6.36.1 - JSON payload example for "200" response messages for a "getLineItemsForClass" operation.

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

Code 6.38.1 - JSON payload example for "200" response messages for a "getResult" operation.

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

Code 6.40.1 - JSON payload example for "200" response messages for a "getResultsForClass" operation.

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

Code 6.42.1 - JSON payload example for "200" response messages for a "getResultsForLineItemForClass" operation.

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

Code 6.44.1 - JSON payload example for "200" response messages for a "getResultsForStudentForClass" operation.

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

Code 6.46.1 - JSON payload example for "200" response messages for a "getScoreScale" operation.

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

Code 6.48.1 - JSON payload example for "200" response messages for a "getScoreScalesForClass" operation.

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

Code 6.50.1 - JSON payload example for "200" response messages for a "getScoreScalesForSchool" operation.

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

Code 6.51.1 - JSON payload example for the request message for a "postLineItemsForClass" operation.

Code 6.52.1 - JSON payload example for "201" response messages for a "postLineItemsForClass" operation.

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

Code 6.53.1 - JSON payload example for the request message for a "postLineItemsForSchool" operation.

Code 6.54.1 - JSON payload example for "201" response messages for a "postLineItemsForSchool" operation.

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

Code 6.55.1 - JSON payload example for the request message for a "postResultsForAcademicSessionForClass" operation.

Code 6.56.1 - JSON payload example for "201" response messages for a "postResultsForAcademicSessionForClass" operation.

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

Code 6.57.1 - JSON payload example for the request message for a "postResultsForLineItem" operation.

Code 6.58.1 - JSON payload example for "201" response messages for a "postResultsForLineItem" operation.

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

Code 6.59.1 - JSON payload example for the request message for a "putAssessmentLineItem" operation.

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

Code 6.61.1 - JSON payload example for the request message for a "putAssessmentResult" operation.

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

Code 6.63.1 - JSON payload example for the request message for a "putCategory" operation.

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

Code 6.65.1 - JSON payload example for the request message for a "putLineItem" operation.

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

Code 6.67.1 - JSON payload example for the request message for a "putResult" operation.

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

Code 6.69.1 - JSON payload example for the request message for a "putScoreScale" operation.

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

toc | top

1. Introduction

This Section is NOT NORMATIVE.

1.1. Scope and Context

This document is the OneRoster 1.2 Gradebook Service REST/JSON Binding and as such it is used as the basis for the development of the following documents:

This information model defines the OneRoster Gradebook Abstract Application Programming Interface (a-API). This service model 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:

A key artefact produced as part of the REST/JSON binding description is the associated OpenAPI file based upon the OpenAPI Specification version 2 [OAS, 14] and [OAS, 17] version 3.

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 Gradebook Service 1.2

The set of changes made between OR 1.1 and OR 1.2 with respect to gradebook 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 Gradebook 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-GBK-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
OAS OpenAPI Specification
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
deleteAssessmentLineItem /assessmentLineItems/{sourcedId} DELETE
deleteAssessmentResult /assessmentResults/{sourcedId} DELETE
deleteCategory /categories/{sourcedId} DELETE
deleteLineItem /lineItems/{sourcedId} DELETE
deleteResult /results/{sourcedId} DELETE
deleteScoreScale /scoreScales/{sourcedId} DELETE
getAllAssessmentLineItems /assessmentLineItems GET
getAllAssessmentResults /assessmentResults GET
getAllCategories /categories GET
getAllLineItems /lineItems GET
getAllResults /results GET
getAllScoreScales /scoreScales GET
getAssessmentLineItem /assessmentLineItems/{sourcedId} GET
getAssessmentResult /assessmentResults/{sourcedId} GET
getCategoriesForClass /classes/{classSourcedId}/categories GET
getCategory /categories/{sourcedId} GET
getLineItem /lineItems/{sourcedId} GET
getLineItemsForClass /classes/{classSourcedId}/lineItems GET
getResult /results/{sourcedId} GET
getResultsForClass /classes/{classSourcedId}/results GET
getResultsForLineItemForClass /classes/{classSourcedId}/lineItems/{lineItemSourcedId}/results GET
getResultsForStudentForClass /classes/{classSourcedId}/students/{studentSourcedId}/results GET
getScoreScale /scoreScales/{sourcedId} GET
getScoreScalesForClass /classes/{classSourcedId}/scoreScales GET
getScoreScalesForSchool /schools/{schoolSourcedId}/scoreScales GET
postLineItemsForClass /classes/{classSourcedId}/lineItems POST
postLineItemsForSchool /schools/{schoolSourcedId}/lineItems POST
postResultsForAcademicSessionForClass /classes/{classSourcedId}/academicSessions/{academicSessionSourcedId}/results POST
postResultsForLineItem /lineItems/{lineItemSourcedId}/results POST
putAssessmentLineItem /assessmentLineItems/{sourcedId} PUT
putAssessmentResult /assessmentResults/{sourcedId} PUT
putCategory /categories/{sourcedId} PUT
putLineItem /lineItems/{sourcedId} PUT
putResult /results/{sourcedId} PUT
putScoreScale /scoreScales/{sourcedId} PUT

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/gradebook/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 "deleteAssessmentLineItem" Endpoint Query Parameters

There are no pre-defined query parameters for this endpoint.

2.3.2 "deleteAssessmentResult" Endpoint Query Parameters

There are no pre-defined query parameters for this endpoint.

2.3.3 "deleteCategory" Endpoint Query Parameters

There are no pre-defined query parameters for this endpoint.

2.3.4 "deleteLineItem" Endpoint Query Parameters

There are no pre-defined query parameters for this endpoint.

2.3.5 "deleteResult" Endpoint Query Parameters

There are no pre-defined query parameters for this endpoint.

2.3.6 "deleteScoreScale" Endpoint Query Parameters

There are no pre-defined query parameters for this endpoint.

2.3.7 "getAllAssessmentLineItems" 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 "getAllAssessmentLineItems" 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 "getAllAssessmentLineItems" 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 "getAllAssessmentLineItems" 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 "getAllAssessmentLineItems" 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 "getAllAssessmentLineItems" 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.

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 "getAllAssessmentLineItems" 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 "getAllAssessmentResults" 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 "getAllAssessmentResults" 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 "getAllAssessmentResults" 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 "getAllAssessmentResults" 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 "getAllAssessmentResults" 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 "getAllAssessmentResults" 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.

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 "getAllAssessmentResults" 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 "getAllCategories" 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 "getAllCategories" 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 "getAllCategories" 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 "getAllCategories" 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 "getAllCategories" 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 "getAllCategories" 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.

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 "getAllCategories" 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 "getAllLineItems" 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 "getAllLineItems" 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 "getAllLineItems" 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 "getAllLineItems" 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 "getAllLineItems" 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 "getAllLineItems" 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.

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 "getAllLineItems" 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 "getAllResults" 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 "getAllResults" 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 "getAllResults" 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 "getAllResults" 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 "getAllResults" 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 "getAllResults" 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.

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 "getAllResults" 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 "getAllScoreScales" 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 "getAllScoreScales" 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 "getAllScoreScales" 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 "getAllScoreScales" 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 "getAllScoreScales" 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 "getAllScoreScales" 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.

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 "getAllScoreScales" 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 "getAssessmentLineItem" Endpoint Query Parameters

2.3.13.1 "fields" Query Parameter

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

Table 2.3.13.1 - The definition of the "fields" query parameter for the "getAssessmentLineItem" 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 "getAssessmentResult" 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 "getAssessmentResult" 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 "getCategoriesForClass" 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 "getCategoriesForClass" 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 "getCategoriesForClass" 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 "getCategoriesForClass" 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 "getCategoriesForClass" 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 "getCategoriesForClass" 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.

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 "getCategoriesForClass" 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 "getCategory" Endpoint Query Parameters

2.3.16.1 "fields" Query Parameter

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

Table 2.3.16.1 - The definition of the "fields" query parameter for the "getCategory" 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 "getLineItem" Endpoint Query Parameters

2.3.17.1 "fields" Query Parameter

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

Table 2.3.17.1 - The definition of the "fields" query parameter for the "getLineItem" 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 "getLineItemsForClass" 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 "getLineItemsForClass" 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 "getLineItemsForClass" 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 "getLineItemsForClass" 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 "getLineItemsForClass" 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 "getLineItemsForClass" 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.

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 "getLineItemsForClass" 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 "getResult" Endpoint Query Parameters

2.3.19.1 "fields" Query Parameter

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

Table 2.3.19.1 - The definition of the "fields" query parameter for the "getResult" 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 "getResultsForClass" 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 "getResultsForClass" 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 "getResultsForClass" 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 "getResultsForClass" 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 "getResultsForClass" 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 "getResultsForClass" 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.

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 "getResultsForClass" 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 "getResultsForLineItemForClass" Endpoint Query Parameters

2.3.21.1 "limit" Query Parameter

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

Table 2.3.21.1 - The definition of the "limit" query parameter for the "getResultsForLineItemForClass" 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.21.2 "offset" Query Parameter

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

Table 2.3.21.2 - The definition of the "offset" query parameter for the "getResultsForLineItemForClass" 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.21.3 "sort" Query Parameter

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

Table 2.3.21.3 - The definition of the "sort" query parameter for the "getResultsForLineItemForClass" 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.21.4 "orderBy" Query Parameter

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

Table 2.3.21.4 - The definition of the "orderBy" query parameter for the "getResultsForLineItemForClass" 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.21.5 "filter" Query Parameter

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

Table 2.3.21.5 - The definition of the "filter" query parameter for the "getResultsForLineItemForClass" 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.

2.3.21.6 "fields" Query Parameter

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

Table 2.3.21.6 - The definition of the "fields" query parameter for the "getResultsForLineItemForClass" 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 "getResultsForStudentForClass" 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 "getResultsForStudentForClass" 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 "getResultsForStudentForClass" 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 "getResultsForStudentForClass" 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 "getResultsForStudentForClass" 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 "getResultsForStudentForClass" 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.

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 "getResultsForStudentForClass" 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 "getScoreScale" 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 "getScoreScale" 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 "getScoreScalesForClass" Endpoint Query Parameters

2.3.24.1 "limit" Query Parameter

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

Table 2.3.24.1 - The definition of the "limit" query parameter for the "getScoreScalesForClass" 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.24.2 "offset" Query Parameter

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

Table 2.3.24.2 - The definition of the "offset" query parameter for the "getScoreScalesForClass" 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.24.3 "sort" Query Parameter

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

Table 2.3.24.3 - The definition of the "sort" query parameter for the "getScoreScalesForClass" 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.24.4 "orderBy" Query Parameter

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

Table 2.3.24.4 - The definition of the "orderBy" query parameter for the "getScoreScalesForClass" 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.24.5 "filter" Query Parameter

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

Table 2.3.24.5 - The definition of the "filter" query parameter for the "getScoreScalesForClass" 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.

2.3.24.6 "fields" Query Parameter

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

Table 2.3.24.6 - The definition of the "fields" query parameter for the "getScoreScalesForClass" 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 "getScoreScalesForSchool" 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 "getScoreScalesForSchool" 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 "getScoreScalesForSchool" 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 "getScoreScalesForSchool" 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 "getScoreScalesForSchool" 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 "getScoreScalesForSchool" 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.

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 "getScoreScalesForSchool" 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 "postLineItemsForClass" Endpoint Query Parameters

There are no pre-defined query parameters for this endpoint.

2.3.27 "postLineItemsForSchool" Endpoint Query Parameters

There are no pre-defined query parameters for this endpoint.

2.3.28 "postResultsForAcademicSessionForClass" Endpoint Query Parameters

There are no pre-defined query parameters for this endpoint.

2.3.29 "postResultsForLineItem" Endpoint Query Parameters

There are no pre-defined query parameters for this endpoint.

2.3.30 "putAssessmentLineItem" Endpoint Query Parameters

There are no pre-defined query parameters for this endpoint.

2.3.31 "putAssessmentResult" Endpoint Query Parameters

There are no pre-defined query parameters for this endpoint.

2.3.32 "putCategory" Endpoint Query Parameters

There are no pre-defined query parameters for this endpoint.

2.3.33 "putLineItem" Endpoint Query Parameters

There are no pre-defined query parameters for this endpoint.

2.3.34 "putResult" Endpoint Query Parameters

There are no pre-defined query parameters for this endpoint.

2.3.35 "putScoreScale" Endpoint Query Parameters

There are no pre-defined query parameters for this endpoint.

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
/assessmentLineItems 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 AssessmentLineItemSetDType.
  • 400 - an invalid selection field was supplied and data filtering on the selection criteria was not possible i.e. 'invalid_selection_field'. 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.
/assessmentLineItems/{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 SingleAssessmentLineItemDType.
  • 400 - an invalid selection field was supplied and data filtering on the selection criteria was not possible i.e. 'invalid_selection_field'. 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.
/assessmentLineItems/{sourcedId} DELETE
  • 204 - the object has been successfully deleted. There is no payload in the response message.
  • 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.
/assessmentLineItems/{sourcedId} PUT
  • 201 - the object has been successfully stored in the Service Provider repository. There is no payload in the response message.
  • 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.
/assessmentResults 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 AssessmentResultSetDType.
  • 400 - an invalid selection field was supplied and data filtering on the selection criteria was not possible i.e. 'invalid_selection_field'. 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.
/assessmentResults/{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 SingleAssessmentResultDType.
  • 400 - an invalid selection field was supplied and data filtering on the selection criteria was not possible i.e. 'invalid_selection_field'. 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.
/assessmentResults/{sourcedId} DELETE
  • 204 - the object has been successfully deleted. There is no payload in the response message.
  • 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.
/assessmentResults/{sourcedId} PUT
  • 201 - the object has been successfully stored in the Service Provider repository. There is no payload in the response message.
  • 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.
/categories 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 CategoriesSetDType.
  • 400 - an invalid selection field was supplied and data filtering on the selection criteria was not possible i.e. 'invalid_selection_field'. 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.
/categories/{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 SingleCategoryDType.
  • 400 - an invalid selection field was supplied and data filtering on the selection criteria was not possible i.e. 'invalid_selection_field'. 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.
/categories/{sourcedId} DELETE
  • 204 - the object has been successfully deleted. There is no payload in the response message.
  • 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.
/categories/{sourcedId} PUT
  • 201 - the object has been successfully stored in the Service Provider repository. There is no payload in the response message.
  • 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}/results 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 ResultSetDType.
  • 400 - an invalid selection field was supplied and data filtering on the selection criteria was not possible i.e. 'invalid_selection_field'. 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}/lineItems 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 LineItemSetDType.
  • 400 - an invalid selection field was supplied and data filtering on the selection criteria was not possible i.e. 'invalid_selection_field'. 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}/lineItems/{lineItemSourcedId}/results 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 ResultSetDType.
  • 400 - an invalid selection field was supplied and data filtering on the selection criteria was not possible i.e. 'invalid_selection_field'. 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/{studentSourcedId}/results 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 ResultSetDType.
  • 400 - an invalid selection field was supplied and data filtering on the selection criteria was not possible i.e. 'invalid_selection_field'. 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}/categories 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 CategoriesSetDType.
  • 400 - an invalid selection field was supplied and data filtering on the selection criteria was not possible i.e. 'invalid_selection_field'. 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}/scoreScales 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 ScoreScaleSetDType.
  • 400 - an invalid selection field was supplied and data filtering on the selection criteria was not possible i.e. 'invalid_selection_field'. 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}/academicSessions/{academicSessionSourcedId}/results POST
  • 201 - the object has been successfully stored in the Service Provider repository. The payload is defined by the structure GUIDPairSetDType.
  • 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}/lineItems POST
  • 201 - the object has been successfully stored in the Service Provider repository. The payload is defined by the structure GUIDPairSetDType.
  • 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.
/lineItems 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 LineItemSetDType.
  • 400 - an invalid selection field was supplied and data filtering on the selection criteria was not possible i.e. 'invalid_selection_field'. 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.
/lineItems/{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 SingleLineItemDType.
  • 400 - an invalid selection field was supplied and data filtering on the selection criteria was not possible i.e. 'invalid_selection_field'. 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.
/lineItems/{sourcedId} DELETE
  • 204 - the object has been successfully deleted. There is no payload in the response message.
  • 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.
/lineItems/{sourcedId} PUT
  • 201 - the object has been successfully stored in the Service Provider repository. There is no payload in the response message.
  • 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.
/lineItems/{lineItemSourcedId}/results POST
  • 201 - the object has been successfully stored in the Service Provider repository. The payload is defined by the structure GUIDPairSetDType.
  • 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.
/results 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 ResultSetDType.
  • 400 - an invalid selection field was supplied and data filtering on the selection criteria was not possible i.e. 'invalid_selection_field'. 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.
/results/{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 SingleResultDType.
  • 400 - an invalid selection field was supplied and data filtering on the selection criteria was not possible i.e. 'invalid_selection_field'. 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.
/results/{sourcedId} DELETE
  • 204 - the object has been successfully deleted. There is no payload in the response message.
  • 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.
/results/{sourcedId} PUT
  • 201 - the object has been successfully stored in the Service Provider repository. There is no payload in the response message.
  • 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}/scoreScales 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 ScoreScaleSetDType.
  • 400 - an invalid selection field was supplied and data filtering on the selection criteria was not possible i.e. 'invalid_selection_field'. 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}/lineItems POST
  • 201 - the object has been successfully stored in the Service Provider repository. The payload is defined by the structure GUIDPairSetDType.
  • 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.
/scoreScales 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 ScoreScaleSetDType.
  • 400 - an invalid selection field was supplied and data filtering on the selection criteria was not possible i.e. 'invalid_selection_field'. 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.
/scoreScales/{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 SingleScoreScaleDType.
  • 400 - an invalid selection field was supplied and data filtering on the selection criteria was not possible i.e. 'invalid_selection_field'. 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.
/scoreScales/{sourcedId} DELETE
  • 204 - the object has been successfully deleted. There is no payload in the response message.
  • 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.
/scoreScales/{sourcedId} PUT
  • 201 - the object has been successfully stored in the Service Provider repository. There is no payload in the response message.
  • 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.

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/gradebook/v1p2/discovery/".

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

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

toc | top

3. Using the Endpoint Parameters

This Section is NORMATIVE.

3.1. Pagination

For requests of collections i.e. the response for the 'getAllLineItems()', 'getAllResults', etc. 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 lineItems:

    GET https://imsglobal.org/ims/oneroster/gradebook/v1p2/lineItems?limit=10

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

    GET https://imsglobal.org/ims/oneroster/gradebook/v1p2/lineItems?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/gradebook/v1p2/lineItems?limit=10&offset=20>; rel="next",
    <https://imsglobal.org/ims/oneroster/gradebook/v1p2/lineItems?limit=3&offset=500>; rel="last",
    <https://imsglobal.org/ims/oneroster/gradebook/v1p2/lineItems?limit=10&offset=0>; rel="first",
    <https://imsglobal.org/ims/oneroster/gradebook/v1p2/lineItems?limit=10&offset=0>; rel="prev"

3.2. Sorting

It should be possible for collections, i.e. the response for the 'getAllResults()', 'getAllLineItems()', etc. calls, 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 students sorted into ascending familyName order:

    GET https://imsglobal.org/ims/oneroster/gradebook/v1p2/results?sort=score&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. 'getAllLineItems()', 'getResults()', etc. 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 'results', it MUST be possible to filter on: 'sourcedId', 'score, 'dateLastModified', etc.

Predicates MUST be chosen from those listed in Table 3.1:

Table 3.1 List of predicates used for filtering.
Predicate Representation
Equal =
Not Equal !=
Greater Than >
Greater Than or Equal >=
Lesser Than <
Lesser Than or Equal <=
Contains ~

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.0, 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 'lineItems' with a 'dueDate' of '2017-01-01T00:00:00Z' is:

    GET https://imsglobal.org/ims/oneroster/gradebook/v1p2/lineItems?filter=dueDate='2017-01-01T00:00:00Z'

URL encoded as:

    GET https://imsglobal.org/ims/oneroster/gradebook/v1p2/lineItems?filter=role%3D%272017-01-01T00:00:00Z%27

Filter queries MUST be URL encoded.

An example of a complex query for all 'lineItems' with a dueDate='2017-01-01T00:00:00Z' AND dateLastModified>'2016-12-12T00:00:00Z' is:

    GET https://imsglobal.org/ims/oneroster/gradebook/v1p2/lineItems?filter=dueDate%3D%272017%3D01%3D01T00%3A00%3A00Z%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 'subject' (this is not a field in 'lineItem' but is used as a generic example of filters for arrays) field when the value of the field is "subject1,subject2,subject3" the following filters would return:

This means filtering using the '=' has 'AND' semantics and for '~' 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 'getAllResults()', etc. 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 Results returning only the 'sourcedId' and 'score':

    GET https://imsglobal.org/ims/oneroster/gradebook/v1p2/results?fields=sourcedId,score

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 "https://purl.imsglobal.org/spec/or/v1p2/scope/assessment.createput" Scope

Access to all of the write assessment operations that permit the creation of a new single object in which the 'sourcedId' is supplied. The set of service operations covered by this scope are listed in Table 4.3.1.

Table 4.3.1 Service Operations for the "https://purl.imsglobal.org/spec/or/v1p2/scope/assessment.createput" Scope.
Operation HTTP Verb Endpoint
putAssessmentLineItem PUT /assessmentLineItems/{sourcedId}
putAssessmentResult PUT /assessmentResults/{sourcedId}

4.3.2 "https://purl.imsglobal.org/spec/or/v1p2/scope/assessment.delete" Scope

Access to the set of assessment operations that permit an object to be deleted. The set of service operations covered by this scope are listed in Table 4.3.2.

Table 4.3.2 Service Operations for the "https://purl.imsglobal.org/spec/or/v1p2/scope/assessment.delete" Scope.
Operation HTTP Verb Endpoint
deleteAssessmentLineItem DELETE /assessmentLineItems/{sourcedId}
deleteAssessmentResult DELETE /assessmentResults/{sourcedId}

4.3.3 "https://purl.imsglobal.org/spec/or/v1p2/scope/assessment.readonly" Scope

Access to ALL of the assessment read operations. The set of service operations covered by this scope are listed in Table 4.3.3.

Table 4.3.3 Service Operations for the "https://purl.imsglobal.org/spec/or/v1p2/scope/assessment.readonly" Scope.
Operation HTTP Verb Endpoint
getAllAssessmentLineItems GET /assessmentLineItems
getAllAssessmentResults GET /assessmentResults
getAssessmentLineItem GET /assessmentLineItems/{sourcedId}
getAssessmentResult GET /assessmentResults/{sourcedId}

4.3.4 "https://purl.imsglobal.org/spec/or/v1p2/scope/gradebook-core.readonly" Scope

Access to the set of core read operations i.e. reading of all objects or a single object. The set of service operations covered by this scope are listed in Table 4.3.4.

Table 4.3.4 Service Operations for the "https://purl.imsglobal.org/spec/or/v1p2/scope/gradebook-core.readonly" Scope.
Operation HTTP Verb Endpoint
getAllCategories GET /categories
getAllLineItems GET /lineItems
getAllResults GET /results
getAllScoreScales GET /scoreScales
getCategory GET /categories/{sourcedId}
getLineItem GET /lineItems/{sourcedId}
getResult GET /results/{sourcedId}
getScoreScale GET /scoreScales/{sourcedId}

4.3.5 "https://purl.imsglobal.org/spec/or/v1p2/scope/gradebook.createpost" Scope

Access to the set of write operations that permit the creation of objects where the server allocates the 'sourcedIds'. The set of service operations covered by this scope are listed in Table 4.3.5.

Table 4.3.5 Service Operations for the "https://purl.imsglobal.org/spec/or/v1p2/scope/gradebook.createpost" Scope.
Operation HTTP Verb Endpoint
postLineItemsForClass POST /classes/{classSourcedId}/lineItems
postLineItemsForSchool POST /schools/{schoolSourcedId}/lineItems
postResultsForAcademicSessionForClass POST /classes/{classSourcedId}/academicSessions/{academicSessionSourcedId}/results
postResultsForLineItem POST /lineItems/{lineItemSourcedId}/results

4.3.6 "https://purl.imsglobal.org/spec/or/v1p2/scope/gradebook.createput" Scope

Access to all of the gradebook write operations that permit the creation of a new single object in which the 'sourcedId' is supplied. The set of service operations covered by this scope are listed in Table 4.3.6.

Table 4.3.6 Service Operations for the "https://purl.imsglobal.org/spec/or/v1p2/scope/gradebook.createput" Scope.
Operation HTTP Verb Endpoint
putCategory PUT /categories/{sourcedId}
putLineItem PUT /lineItems/{sourcedId}
putResult PUT /results/{sourcedId}
putScoreScale PUT /scoreScales/{sourcedId}

4.3.7 "https://purl.imsglobal.org/spec/or/v1p2/scope/gradebook.delete" Scope

Access to the set of gradebook operations that permit an object to be deleted. The set of service operations covered by this scope are listed in Table 4.3.7.

Table 4.3.7 Service Operations for the "https://purl.imsglobal.org/spec/or/v1p2/scope/gradebook.delete" Scope.
Operation HTTP Verb Endpoint
deleteCategory DELETE /categories/{sourcedId}
deleteLineItem DELETE /lineItems/{sourcedId}
deleteResult DELETE /results/{sourcedId}
deleteScoreScale DELETE /scoreScales/{sourcedId}

4.3.8 "https://purl.imsglobal.org/spec/or/v1p2/scope/gradebook.readonly" Scope

Access to ALL of the gradebook read operations. The set of service operations covered by this scope are listed in Table 4.3.8.

Table 4.3.8 Service Operations for the "https://purl.imsglobal.org/spec/or/v1p2/scope/gradebook.readonly" Scope.
Operation HTTP Verb Endpoint
getAllCategories GET /categories
getAllLineItems GET /lineItems
getAllResults GET /results
getAllScoreScales GET /scoreScales
getCategoriesForClass GET /classes/{classSourcedId}/categories
getCategory GET /categories/{sourcedId}
getLineItem GET /lineItems/{sourcedId}
getLineItemsForClass GET /classes/{classSourcedId}/lineItems
getResult GET /results/{sourcedId}
getResultsForClass GET /classes/{classSourcedId}/results
getResultsForLineItemForClass GET /classes/{classSourcedId}/lineItems/{lineItemSourcedId}/results
getResultsForStudentForClass GET /classes/{classSourcedId}/students/{studentSourcedId}/results
getScoreScale GET /scoreScales/{sourcedId}
getScoreScalesForClass GET /classes/{classSourcedId}/scoreScales
getScoreScalesForSchool GET /schools/{schoolSourcedId}/scoreScales

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
getAllAssessmentLineItems assessmentLineItems AssessmentLineItemSet assessmentLineItems Array of Objects AssessmentLineItemSetDType
getAllAssessmentResults assessmentResults AssessmentResultSet assessmentResults Array of Objects AssessmentResultSetDType
getAllCategories categories CategoriesSet categories Array of Objects CategoriesSetDType
getAllLineItems lineItems LineItemSet lineItems Array of Objects LineItemSetDType
getAllResults results ResultSet results Array of Objects ResultSetDType
getAllScoreScales scoreScales ScoreScaleSet scoreScales Array of Objects ScoreScaleSetDType
getAssessmentLineItem assessmentLineItem SingleAssessmentLineItem assessmentLineItem Object SingleAssessmentLineItemDType
getAssessmentResult assessmentResult SingleAssessmentResult assessmentResult Object SingleAssessmentResultDType
getCategoriesForClass categories CategoriesSet categories Array of Objects CategoriesSetDType
getCategory category SingleCategory category Object SingleCategoryDType
getLineItem lineItem SingleLineItem lineItem Object SingleLineItemDType
getLineItemsForClass lineItems LineItemSet lineItems Array of Objects LineItemSetDType
getResult result SingleResult result Object SingleResultDType
getResultsForClass results ResultSet results Array of Objects ResultSetDType
getResultsForLineItemForClass results ResultSet results Array of Objects ResultSetDType
getResultsForStudentForClass results ResultSet results Array of Objects ResultSetDType
getScoreScale scoreScale SingleScoreScale scoreScale Object SingleScoreScaleDType
getScoreScalesForClass scoreScales ScoreScaleSet scoreScales Array of Objects ScoreScaleSetDType
getScoreScalesForSchool scoreScales ScoreScaleSet scoreScales Array of Objects ScoreScaleSetDType
postLineItemsForClass lineItems LineItemSet lineItems Array of Objects LineItemSetDType
postLineItemsForClass sourcedIdPairs GUIDPairSet sourcedIdPairs Array of Objects GUIDPairSetDType
postLineItemsForSchool lineItems LineItemSet lineItems Array of Objects LineItemSetDType
postLineItemsForSchool sourcedIdPairs GUIDPairSet sourcedIdPairs Array of Objects GUIDPairSetDType
postResultsForAcademicSessionForClass results ResultSet results Array of Objects ResultSetDType
postResultsForAcademicSessionForClass sourcedIdPairs GUIDPairSet sourcedIdPairs Array of Objects GUIDPairSetDType
postResultsForLineItem results ResultSet results Array of Objects ResultSetDType
postResultsForLineItem sourcedIdPairs GUIDPairSet sourcedIdPairs Array of Objects GUIDPairSetDType
putAssessmentLineItem assessmentLineItem SingleAssessmentLineItem assessmentLineItem Object SingleAssessmentLineItemDType
putAssessmentResult assessmentResult SingleAssessmentResult assessmentResult Object SingleAssessmentResultDType
putCategory category SingleCategory category Object SingleCategoryDType
putLineItem lineItem SingleLineItem lineItem Object SingleLineItemDType
putResult result SingleResult result Object SingleResultDType
putScoreScale scoreScale SingleScoreScale scoreScale Object SingleScoreScaleDType

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 CategoriesSet Service Parameter Payload Class Mapping

The UML/JSON Mapping for the "CategoriesSet" Service Parameter Payload Class is given in Table 5.2.1.

Table 5.2.1 UML/JSON Mapping for the "CategoriesSet" Service Parameter Payload Class.
Information Model Details JSON Binding Details
Name UML Artefact Data Type Multiplicity Name Type
CategoriesSet Payload Parameter Container [ Sequence ] - N/A - CategoriesSetDType Object
  • categories
Attribute Category [0.. *] categories Array of Properties

5.2.2 SingleCategory Service Parameter Payload Class Mapping

The UML/JSON Mapping for the "SingleCategory" Service Parameter Payload Class is given in Table 5.2.2.

Table 5.2.2 UML/JSON Mapping for the "SingleCategory" Service Parameter Payload Class.
Information Model Details JSON Binding Details
Name UML Artefact Data Type Multiplicity Name Type
SingleCategory Payload Parameter Container [ Sequence ] - N/A - SingleCategoryDType Object
  • category
Attribute Category [1] category Property

5.2.3 ResultSet Service Parameter Payload Class Mapping

The UML/JSON Mapping for the "ResultSet" Service Parameter Payload Class is given in Table 5.2.3.

Table 5.2.3 UML/JSON Mapping for the "ResultSet" Service Parameter Payload Class.
Information Model Details JSON Binding Details
Name UML Artefact Data Type Multiplicity Name Type
ResultSet Payload Parameter Container [ Sequence ] - N/A - ResultSetDType Object
  • results
Attribute Result [0.. *] results Array of Properties

5.2.4 LineItemSet Service Parameter Payload Class Mapping

The UML/JSON Mapping for the "LineItemSet" Service Parameter Payload Class is given in Table 5.2.4.

Table 5.2.4 UML/JSON Mapping for the "LineItemSet" Service Parameter Payload Class.
Information Model Details JSON Binding Details
Name UML Artefact Data Type Multiplicity Name Type
LineItemSet Payload Parameter Container [ Sequence ] - N/A - LineItemSetDType Object
  • lineItems
Attribute LineItem [0.. *] lineItems Array of Properties

5.2.5 ScoreScaleSet Service Parameter Payload Class Mapping

The UML/JSON Mapping for the "ScoreScaleSet" Service Parameter Payload Class is given in Table 5.2.5.

Table 5.2.5 UML/JSON Mapping for the "ScoreScaleSet" Service Parameter Payload Class.
Information Model Details JSON Binding Details
Name UML Artefact Data Type Multiplicity Name Type
ScoreScaleSet Payload Parameter Container [ Unordered ] - N/A - ScoreScaleSetDType Object
  • scoreScales
Attribute ScoreScale [0.. *] scoreScales Array of Properties

5.2.6 GUIDPairSet Service Parameter Payload Class Mapping

The UML/JSON Mapping for the "GUIDPairSet" Service Parameter Payload Class is given in Table 5.2.6.

Table 5.2.6 UML/JSON Mapping for the "GUIDPairSet" Service Parameter Payload Class.
Information Model Details JSON Binding Details
Name UML Artefact Data Type Multiplicity Name Type
GUIDPairSet Payload Parameter Container [ Unordered ] - N/A - GUIDPairSetDType Object
  • sourcedIdPairs
Attribute GUIDPair [0.. *] sourcedIdPairs Array of Properties

5.2.7 SingleResult Service Parameter Payload Class Mapping

The UML/JSON Mapping for the "SingleResult" Service Parameter Payload Class is given in Table 5.2.7.

Table 5.2.7 UML/JSON Mapping for the "SingleResult" Service Parameter Payload Class.
Information Model Details JSON Binding Details
Name UML Artefact Data Type Multiplicity Name Type
SingleResult Payload Parameter Container [ Sequence ] - N/A - SingleResultDType Object
  • result
Attribute Result [1] result Property

5.2.8 SingleLineItem Service Parameter Payload Class Mapping

The UML/JSON Mapping for the "SingleLineItem" Service Parameter Payload Class is given in Table 5.2.8.

Table 5.2.8 UML/JSON Mapping for the "SingleLineItem" Service Parameter Payload Class.
Information Model Details JSON Binding Details
Name UML Artefact Data Type Multiplicity Name Type
SingleLineItem Payload Parameter Container [ Sequence ] - N/A - SingleLineItemDType Object
  • lineItem
Attribute LineItem [1] lineItem Property

5.2.9 SingleScoreScale Service Parameter Payload Class Mapping

The UML/JSON Mapping for the "SingleScoreScale" Service Parameter Payload Class is given in Table 5.2.9.

Table 5.2.9 UML/JSON Mapping for the "SingleScoreScale" Service Parameter Payload Class.
Information Model Details JSON Binding Details
Name UML Artefact Data Type Multiplicity Name Type
SingleScoreScale Payload Parameter Container [ Unordered ] - N/A - SingleScoreScaleDType Object
  • scoreScale
Attribute ScoreScale [1] scoreScale Property

5.2.10 AssessmentLineItemSet Service Parameter Payload Class Mapping

The UML/JSON Mapping for the "AssessmentLineItemSet" Service Parameter Payload Class is given in Table 5.2.10.

Table 5.2.10 UML/JSON Mapping for the "AssessmentLineItemSet" Service Parameter Payload Class.
Information Model Details JSON Binding Details
Name UML Artefact Data Type Multiplicity Name Type
AssessmentLineItemSet Payload Parameter Container [ Sequence ] - N/A - AssessmentLineItemSetDType Object
  • assessmentLineItems
Attribute AssessmentLineItem [0.. *] assessmentLineItems Array of Properties

5.2.11 SingleAssessmentLineItem Service Parameter Payload Class Mapping

The UML/JSON Mapping for the "SingleAssessmentLineItem" Service Parameter Payload Class is given in Table 5.2.11.

Table 5.2.11 UML/JSON Mapping for the "SingleAssessmentLineItem" Service Parameter Payload Class.
Information Model Details JSON Binding Details
Name UML Artefact Data Type Multiplicity Name Type
SingleAssessmentLineItem Payload Parameter Container [ Sequence ] - N/A - SingleAssessmentLineItemDType Object
  • assessmentLineItem
Attribute AssessmentLineItem [1] assessmentLineItem Property

5.2.12 AssessmentResultSet Service Parameter Payload Class Mapping

The UML/JSON Mapping for the "AssessmentResultSet" Service Parameter Payload Class is given in Table 5.2.12.

Table 5.2.12 UML/JSON Mapping for the "AssessmentResultSet" Service Parameter Payload Class.
Information Model Details JSON Binding Details
Name UML Artefact Data Type Multiplicity Name Type
AssessmentResultSet Payload Parameter Container [ Sequence ] - N/A - AssessmentResultSetDType Object
  • assessmentResults
Attribute AssessmentResult [0.. *] assessmentResults Array of Properties

5.2.13 SingleAssessmentResult Service Parameter Payload Class Mapping

The UML/JSON Mapping for the "SingleAssessmentResult" Service Parameter Payload Class is given in Table 5.2.13.

Table 5.2.13 UML/JSON Mapping for the "SingleAssessmentResult" Service Parameter Payload Class.
Information Model Details JSON Binding Details
Name UML Artefact Data Type Multiplicity Name Type
SingleAssessmentResult Payload Parameter Container [ Sequence ] - N/A - SingleAssessmentResultDType Object
  • assessmentResult
Attribute AssessmentResult [1] assessmentResult 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 AssessmentLineItem Payload Class Mapping

The Payload UML/JSON Mapping for the "AssessmentLineItem" Class is given in Table 5.3.2.

Table 5.3.2 Payload UML/JSON Mapping for the "AssessmentLineItem" Class.
Information Model Details JSON Binding Details
Name UML Artefact Data Type Multiplicity Name Type
AssessmentLineItem Core Container [ Sequence ] AND Inherits [ Base ] - N/A - AssessmentLineItemDType
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
  • description
Attribute PT: String [0..1] description Property
  • class
Attribute ClassGUIDRef [0..1] class Property
  • parentAssessmentLineItem
Attribute AssessmentLineItemGUIDRef [0..1] parentAssessmentLineItem Property
  • scoreScale
Attribute ScoreScaleGUIDRef [0..1] scoreScale Property
  • resultValueMin
Attribute PT: Float [0..1] resultValueMin Property
  • resultValueMax
Attribute PT: Float [0..1] resultValueMax Property
  • learningObjectiveSet
Attribute LearningObjectiveSet [0.. *] learningObjectiveSet Array of Properties

5.3.3 AssessmentLineItemGUIDRef Payload Class Mapping

The Payload UML/JSON Mapping for the "AssessmentLineItemGUIDRef" Class is given in Table 5.3.3.

Table 5.3.3 Payload UML/JSON Mapping for the "AssessmentLineItemGUIDRef" Class.
Information Model Details JSON Binding Details
Name UML Artefact Data Type Multiplicity Name Type
AssessmentLineItemGUIDRef Core Container [ Sequence ] AND Inherits [ GUIDRef ] - N/A - AssessmentLineItemGUIDRefDType
Object
  • href
    [ INHERITED ]
Attribute PT: AnyURI [1] href Property
  • sourcedId
    [ INHERITED ]
Attribute DT: GUID (PT: String) [1] sourcedId Property
  • type
Attribute [ Enumeration (AssessmentLineItemGUIDRefTypeEnum) ] [1] type Property

5.3.4 AssessmentResult Payload Class Mapping

The Payload UML/JSON Mapping for the "AssessmentResult" Class is given in Table 5.3.4.

Table 5.3.4 Payload UML/JSON Mapping for the "AssessmentResult" Class.
Information Model Details JSON Binding Details
Name UML Artefact Data Type Multiplicity Name Type
AssessmentResult Core Container [ Sequence ] AND Inherits [ Base ] - N/A - AssessmentResultDType
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
  • assessmentLineItem
Attribute AssessmentLineItemGUIDRef [1] assessmentLineItem Property
  • student
Attribute UserGUIDRef [1] student Property
  • score
Attribute PT: Float [0..1] score Property
  • textScore
Attribute PT: NormalizedString [0..1] textScore Property
  • scoreDate
Attribute PT: Date [1] scoreDate Property
  • scoreScale
Attribute ScoreScaleGUIDRef [0..1] scoreScale Property
  • scorePercentile
Attribute PT: Float [0..1] scorePercentile Property
  • scoreStatus
Attribute [ Union (ScoreStatusExtEnum) ] [1] scoreStatus Property
  • comment
Attribute PT: String [0..1] comment Property
  • learningObjectiveSet
Attribute LearningObjectiveScoreSet [0.. *] learningObjectiveSet Array of Properties

5.3.5 Base Payload Class Mapping

The Payload UML/JSON Mapping for the "Base" Class is given in Table 5.3.5.

Table 5.3.5 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.6 Category Payload Class Mapping

The Payload UML/JSON Mapping for the "Category" Class is given in Table 5.3.6.

Table 5.3.6 Payload UML/JSON Mapping for the "Category" Class.
Information Model Details JSON Binding Details
Name UML Artefact Data Type Multiplicity Name Type
Category Core Container [ Sequence ] AND Inherits [ Base ] - N/A - CategoryDType
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
  • weight
Attribute PT: Float [0..1] weight Property

5.3.7 CategoryGUIDRef Payload Class Mapping

The Payload UML/JSON Mapping for the "CategoryGUIDRef" Class is given in Table 5.3.7.

Table 5.3.7 Payload UML/JSON Mapping for the "CategoryGUIDRef" Class.
Information Model Details JSON Binding Details
Name UML Artefact Data Type Multiplicity Name Type
CategoryGUIDRef Core Container [ Sequence ] AND Inherits [ GUIDRef ] - N/A - CategoryGUIDRefDType
Object
  • href
    [ INHERITED ]
Attribute PT: AnyURI [1] href Property
  • sourcedId
    [ INHERITED ]
Attribute DT: GUID (PT: String) [1] sourcedId Property
  • type
Attribute [ Enumeration (CategoryGUIDRefTypeEnum) ] [1] type Property

5.3.8 ClassGUIDRef Payload Class Mapping

The Payload UML/JSON Mapping for the "ClassGUIDRef" Class is given in Table 5.3.8.

Table 5.3.8 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.9 CourseGUIDRef Payload Class Mapping

The Payload UML/JSON Mapping for the "CourseGUIDRef" Class is given in Table 5.3.9.

Table 5.3.9 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.10 GUIDPair Payload Class Mapping

The Payload UML/JSON Mapping for the "GUIDPair" Class is given in Table 5.3.10.

Table 5.3.10 Payload UML/JSON Mapping for the "GUIDPair" Class.
Information Model Details JSON Binding Details
Name UML Artefact Data Type Multiplicity Name Type
GUIDPair Core Container [ Unordered ] - N/A - GUIDPairDType Object
  • suppliedSourcedId
Attribute DT: GUID (PT: String) [1] suppliedSourcedId Property
  • allocatedSourcedId
Attribute DT: GUID (PT: String) [1] allocatedSourcedId 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 LearningObjectiveResults Payload Class Mapping

The Payload UML/JSON Mapping for the "LearningObjectiveResults" Class is given in Table 5.3.12.

Table 5.3.12 Payload UML/JSON Mapping for the "LearningObjectiveResults" Class.
Information Model Details JSON Binding Details
Name UML Artefact Data Type Multiplicity Name Type
LearningObjectiveResults Core Container [ Sequence ] - N/A - LearningObjectiveResultsDType Object
  • learningObjectiveId
Attribute PT: NormalizedString [1] learningObjectiveId Property
  • score
Attribute PT: Float [0..1] score Property
  • textScore
Attribute PT: NormalizedString [0..1] textScore Property

5.3.13 LearningObjectiveScoreSet Payload Class Mapping

The Payload UML/JSON Mapping for the "LearningObjectiveScoreSet" Class is given in Table 5.3.13.

Table 5.3.13 Payload UML/JSON Mapping for the "LearningObjectiveScoreSet" Class.
Information Model Details JSON Binding Details
Name UML Artefact Data Type Multiplicity Name Type
LearningObjectiveScoreSet Core Container [ Sequence ] - N/A - LearningObjectiveScoreSetDType Object
  • source
Attribute [ Union (SourceExtEnum) ] [1] source Property
  • learningObjectiveResults
Attribute LearningObjectiveResults [1.. *] learningObjectiveResults Array of Properties

5.3.14 LearningObjectiveSet Payload Class Mapping

The Payload UML/JSON Mapping for the "LearningObjectiveSet" Class is given in Table 5.3.14.

Table 5.3.14 Payload UML/JSON Mapping for the "LearningObjectiveSet" Class.
Information Model Details JSON Binding Details
Name UML Artefact Data Type Multiplicity Name Type
LearningObjectiveSet Core Container [ Sequence ] - N/A - LearningObjectiveSetDType Object
  • source
Attribute [ Union (SourceExtEnum) ] [1] source Property
  • learningObjectiveIds
Attribute PT: NormalizedString [1.. *] learningObjectiveIds Array of Properties

5.3.15 LineItem Payload Class Mapping

The Payload UML/JSON Mapping for the "LineItem" Class is given in Table 5.3.15.

Table 5.3.15 Payload UML/JSON Mapping for the "LineItem" Class.
Information Model Details JSON Binding Details
Name UML Artefact Data Type Multiplicity Name Type
LineItem Core Container [ Sequence ] AND Inherits [ Base ] - N/A - LineItemDType
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
  • description
Attribute PT: String [0..1] description Property
  • assignDate
Attribute PT: DateTime [1] assignDate Property
  • dueDate
Attribute PT: DateTime [1] dueDate Property
  • class
Attribute ClassGUIDRef [1] class Property
  • school
Attribute OrgGUIDRef [1] school Property
  • category
Attribute CategoryGUIDRef [1] category Property
  • gradingPeriod
Attribute AcadSessionGUIDRef [0..1] gradingPeriod Property
  • academicSession
Attribute AcadSessionGUIDRef [0..1] academicSession Property
  • scoreScale
Attribute ScoreScaleGUIDRef [1] scoreScale Property
  • resultValueMin
Attribute PT: Float [0..1] resultValueMin Property
  • resultValueMax
Attribute PT: Float [0..1] resultValueMax Property
  • learningObjectiveSet
Attribute LearningObjectiveSet [0.. *] learningObjectiveSet Array of Properties

5.3.16 LineItemGUIDRef Payload Class Mapping

The Payload UML/JSON Mapping for the "LineItemGUIDRef" Class is given in Table 5.3.16.

Table 5.3.16 Payload UML/JSON Mapping for the "LineItemGUIDRef" Class.
Information Model Details JSON Binding Details
Name UML Artefact Data Type Multiplicity Name Type
LineItemGUIDRef Core Container [ Sequence ] AND Inherits [ GUIDRef ] - N/A - LineItemGUIDRefDType
Object
  • href
    [ INHERITED ]
Attribute PT: AnyURI [1] href Property
  • sourcedId
    [ INHERITED ]
Attribute DT: GUID (PT: String) [1] sourcedId Property
  • type
Attribute [ Enumeration (LineItemGUIDRefTypeEnum) ] [1] type Property

5.3.17 Metadata Payload Class Mapping

The Payload UML/JSON Mapping for the "Metadata" Class is given in Table 5.3.17.

Table 5.3.17 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.18 OrgGUIDRef Payload Class Mapping

The Payload UML/JSON Mapping for the "OrgGUIDRef" Class is given in Table 5.3.18.

Table 5.3.18 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.19 Result Payload Class Mapping

The Payload UML/JSON Mapping for the "Result" Class is given in Table 5.3.19.

Table 5.3.19 Payload UML/JSON Mapping for the "Result" Class.
Information Model Details JSON Binding Details
Name UML Artefact Data Type Multiplicity Name Type
Result Core Container [ Sequence ] AND Inherits [ Base ] - N/A - ResultDType
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
  • lineItem
Attribute LineItemGUIDRef [1] lineItem Property
  • student
Attribute UserGUIDRef [1] student Property
  • class
Attribute ClassGUIDRef [0..1] class Property
  • scoreScale
Attribute ScoreScaleGUIDRef [0..1] scoreScale Property
  • scoreStatus
Attribute [ Union (ScoreStatusExtEnum) ] [1] scoreStatus Property
  • score
Attribute PT: Float [0..1] score Property
  • textScore
Attribute PT: NormalizedString [0..1] textScore Property
  • scoreDate
Attribute PT: Date [1] scoreDate Property
  • comment
Attribute PT: String [0..1] comment Property
  • learningObjectiveSet
Attribute LearningObjectiveScoreSet [0.. *] learningObjectiveSet Array of Properties

5.3.20 ScoreScale Payload Class Mapping

The Payload UML/JSON Mapping for the "ScoreScale" Class is given in Table 5.3.20.

Table 5.3.20 Payload UML/JSON Mapping for the "ScoreScale" Class.
Information Model Details JSON Binding Details
Name UML Artefact Data Type Multiplicity Name Type
ScoreScale Core Container [ Unordered ] AND Inherits [ Base ] - N/A - ScoreScaleDType
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
  • type
Attribute PT: NormalizedString [1] type Property
  • course
Attribute CourseGUIDRef [0..1] course Property
  • class
Attribute ClassGUIDRef [1] class Property
  • scoreScaleValue
Attribute ScoreScaleValue [1.. *] scoreScaleValue Array of Properties

5.3.21 ScoreScaleGUIDRef Payload Class Mapping

The Payload UML/JSON Mapping for the "ScoreScaleGUIDRef" Class is given in Table 5.3.21.

Table 5.3.21 Payload UML/JSON Mapping for the "ScoreScaleGUIDRef" Class.
Information Model Details JSON Binding Details
Name UML Artefact Data Type Multiplicity Name Type
ScoreScaleGUIDRef Core Container [ Sequence ] AND Inherits [ GUIDRef ] - N/A - ScoreScaleGUIDRefDType
Object
  • href
    [ INHERITED ]
Attribute PT: AnyURI [1] href Property
  • sourcedId
    [ INHERITED ]
Attribute DT: GUID (PT: String) [1] sourcedId Property
  • type
Attribute [ Enumeration (ScoreScaleGUIDRefTypeEnum) ] [1] type Property

5.3.22 ScoreScaleValue Payload Class Mapping

The Payload UML/JSON Mapping for the "ScoreScaleValue" Class is given in Table 5.3.22.

Table 5.3.22 Payload UML/JSON Mapping for the "ScoreScaleValue" Class.
Information Model Details JSON Binding Details
Name UML Artefact Data Type Multiplicity Name Type
ScoreScaleValue Core Container [ Unordered ] - N/A - ScoreScaleValueDType Object
  • itemValueLHS
Attribute PT: NormalizedString [1] itemValueLHS Property
  • itemValueRHS
Attribute PT: NormalizedString [1] itemValueRHS Property

5.3.23 UserGUIDRef Payload Class Mapping

The Payload UML/JSON Mapping for the "UserGUIDRef" Class is given in Table 5.3.23.

Table 5.3.23 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.24 imsx_CodeMinor Payload Class Mapping

The Payload UML/JSON Mapping for the "imsx_CodeMinor" Class is given in Table 5.3.24.

Table 5.3.24 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.25 imsx_CodeMinorField Payload Class Mapping

The Payload UML/JSON Mapping for the "imsx_CodeMinorField" Class is given in Table 5.3.25.

Table 5.3.25 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.26 imsx_StatusInfo Payload Class Mapping

The Payload UML/JSON Mapping for the "imsx_StatusInfo" Class is given in Table 5.3.26.

Table 5.3.26 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 }.
AssessmentLineItemGUIDRefTypeEnum Enumerated value set of: { assessmentLineItem }.
BaseStatusEnum Enumerated value set of: { active | tobedeleted }.
CategoryGUIDRefTypeEnum Enumerated value set of: { category }.
ClassGUIDRefTypeEnum Enumerated value set of: { class }.
CourseGUIDRefTypeEnum Enumerated value set of: { course }.
LineItemGUIDRefTypeEnum Enumerated value set of: { lineItem }.
OrgGUIDRefTypeEnum Enumerated value set of: { org }.
ScoreScaleGUIDRefTypeEnum Enumerated value set of: { scoreScale }.
ScoreStatusEnum Enumerated value set of: { exempt | fully graded | not submitted | partially graded | submitted | late | incomplete | missing | withdrawal | in progress }.
SourceEnum Enumerated value set of: { case | unknown }.
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 | internal_server_error | server_busy | deletefailure | unknownobject | forbidden }.
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
ScoreStatusExtEnum This is a value from one of the set of data-types: ScoreStatusExtString, ScoreStatusEnum
SourceExtEnum This is a value from one of the set of data-types: SourceExtensionString, SourceEnum

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".
Float This is mapped to the JSON "number" data-type with the format of "float".
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 "deleteAssessmentLineItem" Request Payload

There is no payload for this request.

6.2 "deleteAssessmentLineItem" Response Payloads

6.2.1 Response Payloads for the HTTP Codes (204)

There is no payload for these responses i.e. only a HTTP response header is returned.

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

A tabular description of the response payload is shown in the Table below.

Table 6.2.2 - Tabular representation of the JSON payload for "default, 401, 403, 404, 422, 429, 500" response messages for a "deleteAssessmentLineItem" 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.1c.

Code 6.2.2 - JSON payload example for "default, 401, 403, 404, 422, 429, 500" response messages for a "deleteAssessmentLineItem" 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"|"internal_server_error"|"server_busy"|"deletefailure"|"unknownobject"|"forbidden"
                },
                {...},
                {...}
            ]
        }
    }
                        

6.3 "deleteAssessmentResult" Request Payload

There is no payload for this request.

6.4 "deleteAssessmentResult" Response Payloads

6.4.1 Response Payloads for the HTTP Codes (204)

There is no payload for these responses i.e. only a HTTP response header is returned.

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

A tabular description of the response payload is shown in the Table below.

Table 6.4.2 - Tabular representation of the JSON payload for "default, 401, 403, 404, 422, 429, 500" response messages for a "deleteAssessmentResult" 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.2c.

Code 6.4.2 - JSON payload example for "default, 401, 403, 404, 422, 429, 500" response messages for a "deleteAssessmentResult" 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"|"internal_server_error"|"server_busy"|"deletefailure"|"unknownobject"|"forbidden"
                },
                {...},
                {...}
            ]
        }
    }
                        

6.5 "deleteCategory" Request Payload

There is no payload for this request.

6.6 "deleteCategory" Response Payloads

6.6.1 Response Payloads for the HTTP Codes (204)

There is no payload for these responses i.e. only a HTTP response header is returned.

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

A tabular description of the response payload is shown in the Table below.

Table 6.6.2 - Tabular representation of the JSON payload for "default, 401, 403, 404, 422, 429, 500" response messages for a "deleteCategory" 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.3c.

Code 6.6.2 - JSON payload example for "default, 401, 403, 404, 422, 429, 500" response messages for a "deleteCategory" 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"|"internal_server_error"|"server_busy"|"deletefailure"|"unknownobject"|"forbidden"
                },
                {...},
                {...}
            ]
        }
    }
                        

6.7 "deleteLineItem" Request Payload

There is no payload for this request.

6.8 "deleteLineItem" Response Payloads

6.8.1 Response Payloads for the HTTP Codes (204)

There is no payload for these responses i.e. only a HTTP response header is returned.

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

A tabular description of the response payload is shown in the Table below.

Table 6.8.2 - Tabular representation of the JSON payload for "default, 401, 403, 404, 422, 429, 500" response messages for a "deleteLineItem" 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.4c.

Code 6.8.2 - JSON payload example for "default, 401, 403, 404, 422, 429, 500" response messages for a "deleteLineItem" 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"|"internal_server_error"|"server_busy"|"deletefailure"|"unknownobject"|"forbidden"
                },
                {...},
                {...}
            ]
        }
    }
                        

6.9 "deleteResult" Request Payload

There is no payload for this request.

6.10 "deleteResult" Response Payloads

6.10.1 Response Payloads for the HTTP Codes (204)

There is no payload for these responses i.e. only a HTTP response header is returned.

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

A tabular description of the response payload is shown in the Table below.

Table 6.10.2 - Tabular representation of the JSON payload for "default, 401, 403, 404, 422, 429, 500" response messages for a "deleteResult" 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.5c.

Code 6.10.2 - JSON payload example for "default, 401, 403, 404, 422, 429, 500" response messages for a "deleteResult" 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"|"internal_server_error"|"server_busy"|"deletefailure"|"unknownobject"|"forbidden"
                },
                {...},
                {...}
            ]
        }
    }
                        

6.11 "deleteScoreScale" Request Payload

There is no payload for this request.

6.12 "deleteScoreScale" Response Payloads

6.12.1 Response Payloads for the HTTP Codes (204)

There is no payload for these responses i.e. only a HTTP response header is returned.

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

A tabular description of the response payload is shown in the Table below.

Table 6.12.2 - Tabular representation of the JSON payload for "default, 401, 403, 404, 422, 429, 500" response messages for a "deleteScoreScale" 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.6c.

Code 6.12.2 - JSON payload example for "default, 401, 403, 404, 422, 429, 500" response messages for a "deleteScoreScale" 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"|"internal_server_error"|"server_busy"|"deletefailure"|"unknownobject"|"forbidden"
                },
                {...},
                {...}
            ]
        }
    }
                        

6.13 "getAllAssessmentLineItems" Request Payload

There is no payload for this request.

6.14 "getAllAssessmentLineItems" Response Payloads

6.14.1 Response Payloads for the HTTP Codes (200)

A tabular description of the response payload is shown in the Table below.

Table 6.14.1 - Tabular representation of the JSON payload for "200" response messages for a "getAllAssessmentLineItems" operation.
Property Name Multiplicity JSON Data-type Description
    assessmentLineItems [0..*] Array [ Object ] The collection of assessment lineItem 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, human readable, for the assessment lineItem. This should allow the assessment lineItem to be distinguished from its peer assessment lineItems.
            description [0..1] String A human readable description of the usage of the assessment lineItem.
            class [0..1] Object The GUID of the class to which the assessment lineItem has been assigned. Note that an assessment LineItem MAY be assigned tio a class.
                    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'.
            parentAssessmentLineItem [0..1] Object The GUID of the parent assessment lineItem. This enables the assessment lineItems to be chained together in a parent/child hierarchy.
                    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 'assessmentLineItem'.
            scoreScale [0..1] Object The GUID of the score scale to be used for the lineItem. This attribute was added in the OR 1.2 release.
                    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 'scoreScale'.
            resultValueMin [0..1] Float The minimum value (numeric) that can be assigned to the score attribute in a result. The score scale mapping should be used to map to other scores.
            resultValueMax [0..1] Float The maximum value (numeric) that can be assigned to the score attribute in a result. The score scale mapping should be used to map to other scores.
            learningObjectiveSet [0..*] Array [ Object ] The set of identifiers for the learning objectives to which this assessment is aligned. Any number groups of learning objectives can be assigned.
                    source [1..1] Union(SourceExtEnum) The source responsible for creating the learning objective identifiers. The permitted values are from an extensible vocabulary.
                    learningObjectiveIds [1..*] Array [ String ] The set of unique identifiers for the associated learning objectives. If these are CASE identifiers they MUST be valid UUIDs.

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 "200" response messages for a "getAllAssessmentLineItems" operation.
    {
        "assessmentLineItems" : [
            {
                "sourcedId" : "..String..",
                "status" : "active"|"tobedeleted",
                "dateLastModified" : "..Date/Time..",
                "metadata" : {
                    "..permitted extension point.." : "..user defined value.."
                },
                "title" : "..NormalizedString..",
                "description" : "..String..",
                "class" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "class"
                },
                "parentAssessmentLineItem" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "assessmentLineItem"
                },
                "scoreScale" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "scoreScale"
                },
                "resultValueMin" : ..Number(Float)..,
                "resultValueMax" : ..Number(Float)..,
                "learningObjectiveSet" : [
                    {
                        "source" : "..select from Union..",
                        "learningObjectiveIds" : [ "..NormalizedString..", ..., "..NormalizedString.." ]
                    },
                    {...},
                    {...}
                ]
            },
            {...},
            {...}
        ]
    }
                        

6.14.2 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.2 - Tabular representation of the JSON payload for "default, 400, 401, 403, 422, 429, 500" response messages for a "getAllAssessmentLineItems" 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.7c.

Code 6.14.2 - JSON payload example for "default, 400, 401, 403, 422, 429, 500" response messages for a "getAllAssessmentLineItems" 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"|"internal_server_error"|"server_busy"|"deletefailure"|"unknownobject"|"forbidden"
                },
                {...},
                {...}
            ]
        }
    }
                        

6.15 "getAllAssessmentResults" Request Payload

There is no payload for this request.

6.16 "getAllAssessmentResults" Response Payloads

6.16.1 Response Payloads for the HTTP Codes (200)

A tabular description of the response payload is shown in the Table below.

Table 6.16.1 - Tabular representation of the JSON payload for "200" response messages for a "getAllAssessmentResults" operation.
Property Name Multiplicity JSON Data-type Description
    assessmentResults [0..*] Array [ Object ] The collection of assessment result 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.
            assessmentLineItem [1..1] Object The GUID of the assessment lineItem to which the assessment result is aligned.
                    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 'assessmentLineItem'.
            student [1..1] Object The GUID of the student for whom the assessment result is assigned.
                    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'.
            score [0..1] Float The score for the result. If a scoreScale is assigned then the value must align with the scale.
            textScore [0..1] String An optional non-numeric score value. If a scoreScale is assigned then the value must align with the scale.
            scoreDate [1..1] String (Format: date) The date at which the score is assigned or there is an update to the result e.g. change in the 'scoreStatus'.. The format is YYYY-MM-DD as defined in [ISO 8601].
            scoreScale [0..1] Object The GUID of the scoreScale against which the result is aligned.
                    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 'scoreScale'.
            scorePercentile [0..1] Float The percentile rank of a score is the percentage of scores in its frequency distribution that are equal to or lower than it.
            scoreStatus [1..1] Union(ScoreStatusExtEnum) The status of the score. The value is from an extensible enumerated vocabulary.
            comment [0..1] String A human readable comment about the score.
            learningObjectiveSet [0..*] Array [ Object ] The set of identifiers for the learning objectives to which this result is aligned. Any number groups of learning objectives can be assigned.
                    source [1..1] Union(SourceExtEnum) The source responsible for creating the learning objective identifiers. The permitted values are from an extensible vocabulary.
                    learningObjectiveResults [1..*] Array [ Object ] The set of unique identifiers for the associated learning objectives (these may have alignment with a mastery score). If these are CASE identifiers they MUST be valid UUIDs.
                            learningObjectiveId [1..1] String The unique identifier for the associated learning objective. If this is a CASE identifier it MUST be a valid UUID.
                            score [0..1] Float The optional mastery score supplied as a numeric value.
                            textScore [0..1] String The optional mastery score supplied in a non-numeric form.

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 "200" response messages for a "getAllAssessmentResults" operation.
    {
        "assessmentResults" : [
            {
                "sourcedId" : "..String..",
                "status" : "active"|"tobedeleted",
                "dateLastModified" : "..Date/Time..",
                "metadata" : {
                    "..permitted extension point.." : "..user defined value.."
                },
                "assessmentLineItem" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "assessmentLineItem"
                },
                "student" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "user"
                },
                "score" : ..Number(Float)..,
                "textScore" : "..NormalizedString..",
                "scoreDate" : "..String(Date)..",
                "scoreScale" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "scoreScale"
                },
                "scorePercentile" : ..Number(Float)..,
                "scoreStatus" : "..select from Union..",
                "comment" : "..String..",
                "learningObjectiveSet" : [
                    {
                        "source" : "..select from Union..",
                        "learningObjectiveResults" : [
                            {
                                "learningObjectiveId" : "..NormalizedString..",
                                "score" : ..Number(Float)..,
                                "textScore" : "..NormalizedString.."
                            },
                            {...},
                            {...}
                        ]
                    },
                    {...},
                    {...}
                ]
            },
            {...},
            {...}
        ]
    }
                        

6.16.2 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.2 - Tabular representation of the JSON payload for "default, 400, 401, 403, 422, 429, 500" response messages for a "getAllAssessmentResults" 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.8c.

Code 6.16.2 - JSON payload example for "default, 400, 401, 403, 422, 429, 500" response messages for a "getAllAssessmentResults" 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"|"internal_server_error"|"server_busy"|"deletefailure"|"unknownobject"|"forbidden"
                },
                {...},
                {...}
            ]
        }
    }
                        

6.17 "getAllCategories" Request Payload

There is no payload for this request.

6.18 "getAllCategories" Response Payloads

6.18.1 Response Payloads for the HTTP Codes (200)

A tabular description of the response payload is shown in the Table below.

Table 6.18.1 - Tabular representation of the JSON payload for "200" response messages for a "getAllCategories" operation.
Property Name Multiplicity JSON Data-type Description
    categories [0..*] Array [ Object ] The collection of category 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 human readable title for the category.
            weight [0..1] Float Total weight of this grading category in calculation of the course final score.

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 "200" response messages for a "getAllCategories" operation.
    {
        "categories" : [
            {
                "sourcedId" : "..String..",
                "status" : "active"|"tobedeleted",
                "dateLastModified" : "..Date/Time..",
                "metadata" : {
                    "..permitted extension point.." : "..user defined value.."
                },
                "title" : "..NormalizedString..",
                "weight" : ..Number(Float)..
            },
            {...},
            {...}
        ]
    }
                        

6.18.2 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.2 - Tabular representation of the JSON payload for "default, 400, 401, 403, 422, 429, 500" response messages for a "getAllCategories" 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.9c.

Code 6.18.2 - JSON payload example for "default, 400, 401, 403, 422, 429, 500" response messages for a "getAllCategories" 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"|"internal_server_error"|"server_busy"|"deletefailure"|"unknownobject"|"forbidden"
                },
                {...},
                {...}
            ]
        }
    }
                        

6.19 "getAllLineItems" Request Payload

There is no payload for this request.

6.20 "getAllLineItems" Response Payloads

6.20.1 Response Payloads for the HTTP Codes (200)

A tabular description of the response payload is shown in the Table below.

Table 6.20.1 - Tabular representation of the JSON payload for "200" response messages for a "getAllLineItems" operation.
Property Name Multiplicity JSON Data-type Description
    lineItems [0..*] Array [ Object ] The collection of lineItem 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, human readable, for the lineItem. This should allow the lineItem to be distinguished from its peer lineItems.
            description [0..1] String A human readable description of the usage of the lineItem.
            assignDate [1..1] String (Format: date-time) The date/time the activity being addressed by the lineItem was assigned to the student. This has a format as defined in [ISO 8601].
            dueDate [1..1] String (Format: date-time) The date/time by which the assignment must be completed and submitted. This has the dateTime format as defined in [ISO 8601].
            class [1..1] Object The GUID of the class to which the lineItem has been assigned.
                    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 GUID of the school for whom the lineItem has been assigned. This attribute was added in the OR 1.2 release.
                    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'.
            category [1..1] Object The GUID of the category to which the lineItem has been assigned.
                    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 'category'.
            gradingPeriod [0..1] Object The GUID of the grading period for the lineItem. This attribute was added in the OR 1.2 release.
                    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'.
            academicSession [0..1] Object The GUID of the academic session for the lineItem. This should NOT be defined if the 'gradingPeriod' attribute has been used.
                    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'.
            scoreScale [1..1] Object The GUID of the score scale to be used for the lineItem. This attribute was added in the OR 1.2 release.
                    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 'scoreScale'.
            resultValueMin [0..1] Float The minimum value (numeric) that can be assigned to the score attribute in a result. The score scale mapping should be used to map to other scores.
            resultValueMax [0..1] Float The maximum value (numeric) that can be assigned to the score attribute in a result. The score scale mapping should be used to map to other scores.
            learningObjectiveSet [0..*] Array [ Object ] The set of identifiers for the learning objectives to which this assessment is aligned. Any number groups of learning objectives can be assigned.
                    source [1..1] Union(SourceExtEnum) The source responsible for creating the learning objective identifiers. The permitted values are from an extensible vocabulary.
                    learningObjectiveIds [1..*] Array [ String ] The set of unique identifiers for the associated learning objectives. If these are CASE identifiers they MUST be valid UUIDs.

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 "200" response messages for a "getAllLineItems" operation.
    {
        "lineItems" : [
            {
                "sourcedId" : "..String..",
                "status" : "active"|"tobedeleted",
                "dateLastModified" : "..Date/Time..",
                "metadata" : {
                    "..permitted extension point.." : "..user defined value.."
                },
                "title" : "..NormalizedString..",
                "description" : "..String..",
                "assignDate" : "..Date/Time..",
                "dueDate" : "..Date/Time..",
                "class" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "class"
                },
                "school" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "org"
                },
                "category" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "category"
                },
                "gradingPeriod" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "academicSession"
                },
                "academicSession" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "academicSession"
                },
                "scoreScale" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "scoreScale"
                },
                "resultValueMin" : ..Number(Float)..,
                "resultValueMax" : ..Number(Float)..,
                "learningObjectiveSet" : [
                    {
                        "source" : "..select from Union..",
                        "learningObjectiveIds" : [ "..NormalizedString..", ..., "..NormalizedString.." ]
                    },
                    {...},
                    {...}
                ]
            },
            {...},
            {...}
        ]
    }
                        

6.20.2 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.2 - Tabular representation of the JSON payload for "default, 400, 401, 403, 422, 429, 500" response messages for a "getAllLineItems" 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.10c.

Code 6.20.2 - JSON payload example for "default, 400, 401, 403, 422, 429, 500" response messages for a "getAllLineItems" 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"|"internal_server_error"|"server_busy"|"deletefailure"|"unknownobject"|"forbidden"
                },
                {...},
                {...}
            ]
        }
    }
                        

6.21 "getAllResults" Request Payload

There is no payload for this request.

6.22 "getAllResults" Response Payloads

6.22.1 Response Payloads for the HTTP Codes (200)

A tabular description of the response payload is shown in the Table below.

Table 6.22.1 - Tabular representation of the JSON payload for "200" response messages for a "getAllResults" operation.
Property Name Multiplicity JSON Data-type Description
    results [0..*] Array [ Object ] The collection of result 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.
            lineItem [1..1] Object The GUID of the lineItem to which the result is aligned.
                    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 'lineItem'.
            student [1..1] Object The GUID of the student for whom the result is assigned.
                    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 [0..1] Object The GUID of the class to which the result is aligned.
                    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'.
            scoreScale [0..1] Object The GUID of the scoreScale against which the result is aligned.
                    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 'scoreScale'.
            scoreStatus [1..1] Union(ScoreStatusExtEnum) The status of the score. The value is from an extensible enumerated vocabulary.
            score [0..1] Float The score for the result. If a scoreScale is assigned then the value must align with the scale.
            textScore [0..1] String An optional non-numeric score value. If a scoreScale is assigned then the value must align with the scale. This attribute was added in OR 1.2.
            scoreDate [1..1] String (Format: date) The date at which the score is assigned or there is an update to the result e.g. change in the 'scoreStatus'. The format is YYYY-MM-DD as defined in [ISO 8601].
            comment [0..1] String A human readable comment about the score.
            learningObjectiveSet [0..*] Array [ Object ] The set of identifiers for the learning objectives to which this result is aligned. Any number groups of learning objectives can be assigned.
                    source [1..1] Union(SourceExtEnum) The source responsible for creating the learning objective identifiers. The permitted values are from an extensible vocabulary.
                    learningObjectiveResults [1..*] Array [ Object ] The set of unique identifiers for the associated learning objectives (these may have alignment with a mastery score). If these are CASE identifiers they MUST be valid UUIDs.
                            learningObjectiveId [1..1] String The unique identifier for the associated learning objective. If this is a CASE identifier it MUST be a valid UUID.
                            score [0..1] Float The optional mastery score supplied as a numeric value.
                            textScore [0..1] String The optional mastery score supplied in a non-numeric form.

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 "200" response messages for a "getAllResults" operation.
    {
        "results" : [
            {
                "sourcedId" : "..String..",
                "status" : "active"|"tobedeleted",
                "dateLastModified" : "..Date/Time..",
                "metadata" : {
                    "..permitted extension point.." : "..user defined value.."
                },
                "lineItem" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "lineItem"
                },
                "student" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "user"
                },
                "class" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "class"
                },
                "scoreScale" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "scoreScale"
                },
                "scoreStatus" : "..select from Union..",
                "score" : ..Number(Float)..,
                "textScore" : "..NormalizedString..",
                "scoreDate" : "..String(Date)..",
                "comment" : "..String..",
                "learningObjectiveSet" : [
                    {
                        "source" : "..select from Union..",
                        "learningObjectiveResults" : [
                            {
                                "learningObjectiveId" : "..NormalizedString..",
                                "score" : ..Number(Float)..,
                                "textScore" : "..NormalizedString.."
                            },
                            {...},
                            {...}
                        ]
                    },
                    {...},
                    {...}
                ]
            },
            {...},
            {...}
        ]
    }
                        

6.22.2 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.2 - Tabular representation of the JSON payload for "default, 400, 401, 403, 422, 429, 500" response messages for a "getAllResults" 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.11c.

Code 6.22.2 - JSON payload example for "default, 400, 401, 403, 422, 429, 500" response messages for a "getAllResults" 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"|"internal_server_error"|"server_busy"|"deletefailure"|"unknownobject"|"forbidden"
                },
                {...},
                {...}
            ]
        }
    }
                        

6.23 "getAllScoreScales" Request Payload

There is no payload for this request.

6.24 "getAllScoreScales" Response Payloads

6.24.1 Response Payloads for the HTTP Codes (200)

A tabular description of the response payload is shown in the Table below.

Table 6.24.1 - Tabular representation of the JSON payload for "200" response messages for a "getAllScoreScales" operation.
Property Name Multiplicity JSON Data-type Description
    scoreScales [0..*] Array [ Object ] The collection of scoreScale 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 human readable title for the score scale mapping.
            type [1..1] String The type of score scale mapping. At present there is no predefined vocabulary. This should be used by an organization to differentiate between the score scales that it produces.
            course [0..1] Object The GUID for the course for which this scale will be used.
                    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'.
            class [1..1] Object The GUID for the class for which this scale will be used.
                    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'.
            scoreScaleValue [1..*] Array [ Object ] The set of mappings for this score scale.
                    itemValueLHS [1..1] String The left hand side value of the mapping relationship. The format is either a single value ('x') or a range ('x' - 'y'). In the case of a single value this is considered to be the inclusive lower value for the implied range. When a range is specified (lower-to-upper) the values are inclusive.
                    itemValueRHS [1..1] String The right hand side value of the mapping relationship i.e. the equivalent value to the reference point defined in the LHS.

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 "200" response messages for a "getAllScoreScales" operation.
    {
        "scoreScales" : [
            {
                "sourcedId" : "..String..",
                "status" : "active"|"tobedeleted",
                "dateLastModified" : "..Date/Time..",
                "metadata" : {
                    "..permitted extension point.." : "..user defined value.."
                },
                "title" : "..NormalizedString..",
                "type" : "..NormalizedString..",
                "course" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "course"
                },
                "class" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "class"
                },
                "scoreScaleValue" : [
                    {
                        "itemValueLHS" : "..NormalizedString..",
                        "itemValueRHS" : "..NormalizedString.."
                    },
                    {...},
                    {...}
                ]
            },
            {...},
            {...}
        ]
    }
                        

6.24.2 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.2 - Tabular representation of the JSON payload for "default, 400, 401, 403, 422, 429, 500" response messages for a "getAllScoreScales" 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.12c.

Code 6.24.2 - JSON payload example for "default, 400, 401, 403, 422, 429, 500" response messages for a "getAllScoreScales" 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"|"internal_server_error"|"server_busy"|"deletefailure"|"unknownobject"|"forbidden"
                },
                {...},
                {...}
            ]
        }
    }
                        

6.25 "getAssessmentLineItem" Request Payload

There is no payload for this request.

6.26 "getAssessmentLineItem" Response Payloads

6.26.1 Response Payloads for the HTTP Codes (200)

A tabular description of the response payload is shown in the Table below.

Table 6.26.1 - Tabular representation of the JSON payload for "200" response messages for a "getAssessmentLineItem" operation.
Property Name Multiplicity JSON Data-type Description
    assessmentLineItem [1..1] Object The instance of the single assessment lineItem 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, human readable, for the assessment lineItem. This should allow the assessment lineItem to be distinguished from its peer assessment lineItems.
            description [0..1] String A human readable description of the usage of the assessment lineItem.
            class [0..1] Object The GUID of the class to which the assessment lineItem has been assigned. Note that an assessment LineItem MAY be assigned tio a class.
                    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'.
            parentAssessmentLineItem [0..1] Object The GUID of the parent assessment lineItem. This enables the assessment lineItems to be chained together in a parent/child hierarchy.
                    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 'assessmentLineItem'.
            scoreScale [0..1] Object The GUID of the score scale to be used for the lineItem. This attribute was added in the OR 1.2 release.
                    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 'scoreScale'.
            resultValueMin [0..1] Float The minimum value (numeric) that can be assigned to the score attribute in a result. The score scale mapping should be used to map to other scores.
            resultValueMax [0..1] Float The maximum value (numeric) that can be assigned to the score attribute in a result. The score scale mapping should be used to map to other scores.
            learningObjectiveSet [0..*] Array [ Object ] The set of identifiers for the learning objectives to which this assessment is aligned. Any number groups of learning objectives can be assigned.
                    source [1..1] Union(SourceExtEnum) The source responsible for creating the learning objective identifiers. The permitted values are from an extensible vocabulary.
                    learningObjectiveIds [1..*] Array [ String ] The set of unique identifiers for the associated learning objectives. If these are CASE identifiers they MUST be valid UUIDs.

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 "200" response messages for a "getAssessmentLineItem" operation.
    {
        "assessmentLineItem" : {
            "sourcedId" : "..String..",
            "status" : "active"|"tobedeleted",
            "dateLastModified" : "..Date/Time..",
            "metadata" : {
                "..permitted extension point.." : "..user defined value.."
            },
            "title" : "..NormalizedString..",
            "description" : "..String..",
            "class" : {
                "href" : "..URI..",
                "sourcedId" : "..String..",
                "type" : "class"
            },
            "parentAssessmentLineItem" : {
                "href" : "..URI..",
                "sourcedId" : "..String..",
                "type" : "assessmentLineItem"
            },
            "scoreScale" : {
                "href" : "..URI..",
                "sourcedId" : "..String..",
                "type" : "scoreScale"
            },
            "resultValueMin" : ..Number(Float)..,
            "resultValueMax" : ..Number(Float)..,
            "learningObjectiveSet" : [
                {
                    "source" : "..select from Union..",
                    "learningObjectiveIds" : [ "..NormalizedString..", ..., "..NormalizedString.." ]
                },
                {...},
                {...}
            ]
        }
    }
                        

6.26.2 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.26.2 - Tabular representation of the JSON payload for "default, 400, 401, 403, 404, 422, 429, 500" response messages for a "getAssessmentLineItem" 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.13c.

Code 6.26.2 - JSON payload example for "default, 400, 401, 403, 404, 422, 429, 500" response messages for a "getAssessmentLineItem" 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"|"internal_server_error"|"server_busy"|"deletefailure"|"unknownobject"|"forbidden"
                },
                {...},
                {...}
            ]
        }
    }
                        

6.27 "getAssessmentResult" Request Payload

There is no payload for this request.

6.28 "getAssessmentResult" Response Payloads

6.28.1 Response Payloads for the HTTP Codes (200)

A tabular description of the response payload is shown in the Table below.

Table 6.28.1 - Tabular representation of the JSON payload for "200" response messages for a "getAssessmentResult" operation.
Property Name Multiplicity JSON Data-type Description
    assessmentResult [1..1] Object The instance of the single assessment result 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.
            assessmentLineItem [1..1] Object The GUID of the assessment lineItem to which the assessment result is aligned.
                    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 'assessmentLineItem'.
            student [1..1] Object The GUID of the student for whom the assessment result is assigned.
                    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'.
            score [0..1] Float The score for the result. If a scoreScale is assigned then the value must align with the scale.
            textScore [0..1] String An optional non-numeric score value. If a scoreScale is assigned then the value must align with the scale.
            scoreDate [1..1] String (Format: date) The date at which the score is assigned or there is an update to the result e.g. change in the 'scoreStatus'.. The format is YYYY-MM-DD as defined in [ISO 8601].
            scoreScale [0..1] Object The GUID of the scoreScale against which the result is aligned.
                    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 'scoreScale'.
            scorePercentile [0..1] Float The percentile rank of a score is the percentage of scores in its frequency distribution that are equal to or lower than it.
            scoreStatus [1..1] Union(ScoreStatusExtEnum) The status of the score. The value is from an extensible enumerated vocabulary.
            comment [0..1] String A human readable comment about the score.
            learningObjectiveSet [0..*] Array [ Object ] The set of identifiers for the learning objectives to which this result is aligned. Any number groups of learning objectives can be assigned.
                    source [1..1] Union(SourceExtEnum) The source responsible for creating the learning objective identifiers. The permitted values are from an extensible vocabulary.
                    learningObjectiveResults [1..*] Array [ Object ] The set of unique identifiers for the associated learning objectives (these may have alignment with a mastery score). If these are CASE identifiers they MUST be valid UUIDs.
                            learningObjectiveId [1..1] String The unique identifier for the associated learning objective. If this is a CASE identifier it MUST be a valid UUID.
                            score [0..1] Float The optional mastery score supplied as a numeric value.
                            textScore [0..1] String The optional mastery score supplied in a non-numeric form.

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 "200" response messages for a "getAssessmentResult" operation.
    {
        "assessmentResult" : {
            "sourcedId" : "..String..",
            "status" : "active"|"tobedeleted",
            "dateLastModified" : "..Date/Time..",
            "metadata" : {
                "..permitted extension point.." : "..user defined value.."
            },
            "assessmentLineItem" : {
                "href" : "..URI..",
                "sourcedId" : "..String..",
                "type" : "assessmentLineItem"
            },
            "student" : {
                "href" : "..URI..",
                "sourcedId" : "..String..",
                "type" : "user"
            },
            "score" : ..Number(Float)..,
            "textScore" : "..NormalizedString..",
            "scoreDate" : "..String(Date)..",
            "scoreScale" : {
                "href" : "..URI..",
                "sourcedId" : "..String..",
                "type" : "scoreScale"
            },
            "scorePercentile" : ..Number(Float)..,
            "scoreStatus" : "..select from Union..",
            "comment" : "..String..",
            "learningObjectiveSet" : [
                {
                    "source" : "..select from Union..",
                    "learningObjectiveResults" : [
                        {
                            "learningObjectiveId" : "..NormalizedString..",
                            "score" : ..Number(Float)..,
                            "textScore" : "..NormalizedString.."
                        },
                        {...},
                        {...}
                    ]
                },
                {...},
                {...}
            ]
        }
    }
                        

6.28.2 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.2 - Tabular representation of the JSON payload for "default, 400, 401, 403, 404, 422, 429, 500" response messages for a "getAssessmentResult" 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.14c.

Code 6.28.2 - JSON payload example for "default, 400, 401, 403, 404, 422, 429, 500" response messages for a "getAssessmentResult" 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"|"internal_server_error"|"server_busy"|"deletefailure"|"unknownobject"|"forbidden"
                },
                {...},
                {...}
            ]
        }
    }
                        

6.29 "getCategoriesForClass" Request Payload

There is no payload for this request.

6.30 "getCategoriesForClass" Response Payloads

6.30.1 Response Payloads for the HTTP Codes (200)

A tabular description of the response payload is shown in the Table below.

Table 6.30.1 - Tabular representation of the JSON payload for "200" response messages for a "getCategoriesForClass" operation.
Property Name Multiplicity JSON Data-type Description
    categories [0..*] Array [ Object ] The collection of category 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 human readable title for the category.
            weight [0..1] Float Total weight of this grading category in calculation of the course final score.

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 "200" response messages for a "getCategoriesForClass" operation.
    {
        "categories" : [
            {
                "sourcedId" : "..String..",
                "status" : "active"|"tobedeleted",
                "dateLastModified" : "..Date/Time..",
                "metadata" : {
                    "..permitted extension point.." : "..user defined value.."
                },
                "title" : "..NormalizedString..",
                "weight" : ..Number(Float)..
            },
            {...},
            {...}
        ]
    }
                        

6.30.2 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.30.2 - Tabular representation of the JSON payload for "default, 400, 401, 403, 404, 422, 429, 500" response messages for a "getCategoriesForClass" 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.15c.

Code 6.30.2 - JSON payload example for "default, 400, 401, 403, 404, 422, 429, 500" response messages for a "getCategoriesForClass" 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"|"internal_server_error"|"server_busy"|"deletefailure"|"unknownobject"|"forbidden"
                },
                {...},
                {...}
            ]
        }
    }
                        

6.31 "getCategory" Request Payload

There is no payload for this request.

6.32 "getCategory" Response Payloads

6.32.1 Response Payloads for the HTTP Codes (200)

A tabular description of the response payload is shown in the Table below.

Table 6.32.1 - Tabular representation of the JSON payload for "200" response messages for a "getCategory" operation.
Property Name Multiplicity JSON Data-type Description
    category [1..1] Object The instance of the single category 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 human readable title for the category.
            weight [0..1] Float Total weight of this grading category in calculation of the course final score.

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.

Code 6.32.1 - JSON payload example for "200" response messages for a "getCategory" operation.
    {
        "category" : {
            "sourcedId" : "..String..",
            "status" : "active"|"tobedeleted",
            "dateLastModified" : "..Date/Time..",
            "metadata" : {
                "..permitted extension point.." : "..user defined value.."
            },
            "title" : "..NormalizedString..",
            "weight" : ..Number(Float)..
        }
    }
                        

6.32.2 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.32.2 - Tabular representation of the JSON payload for "default, 400, 401, 403, 404, 422, 429, 500" response messages for a "getCategory" 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.16c.

Code 6.32.2 - JSON payload example for "default, 400, 401, 403, 404, 422, 429, 500" response messages for a "getCategory" 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"|"internal_server_error"|"server_busy"|"deletefailure"|"unknownobject"|"forbidden"
                },
                {...},
                {...}
            ]
        }
    }
                        

6.33 "getLineItem" Request Payload

There is no payload for this request.

6.34 "getLineItem" Response Payloads

6.34.1 Response Payloads for the HTTP Codes (200)

A tabular description of the response payload is shown in the Table below.

Table 6.34.1 - Tabular representation of the JSON payload for "200" response messages for a "getLineItem" operation.
Property Name Multiplicity JSON Data-type Description
    lineItem [1..1] Object The instance of the single lineItem 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, human readable, for the lineItem. This should allow the lineItem to be distinguished from its peer lineItems.
            description [0..1] String A human readable description of the usage of the lineItem.
            assignDate [1..1] String (Format: date-time) The date/time the activity being addressed by the lineItem was assigned to the student. This has a format as defined in [ISO 8601].
            dueDate [1..1] String (Format: date-time) The date/time by which the assignment must be completed and submitted. This has the dateTime format as defined in [ISO 8601].
            class [1..1] Object The GUID of the class to which the lineItem has been assigned.
                    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 GUID of the school for whom the lineItem has been assigned. This attribute was added in the OR 1.2 release.
                    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'.
            category [1..1] Object The GUID of the category to which the lineItem has been assigned.
                    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 'category'.
            gradingPeriod [0..1] Object The GUID of the grading period for the lineItem. This attribute was added in the OR 1.2 release.
                    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'.
            academicSession [0..1] Object The GUID of the academic session for the lineItem. This should NOT be defined if the 'gradingPeriod' attribute has been used.
                    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'.
            scoreScale [1..1] Object The GUID of the score scale to be used for the lineItem. This attribute was added in the OR 1.2 release.
                    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 'scoreScale'.
            resultValueMin [0..1] Float The minimum value (numeric) that can be assigned to the score attribute in a result. The score scale mapping should be used to map to other scores.
            resultValueMax [0..1] Float The maximum value (numeric) that can be assigned to the score attribute in a result. The score scale mapping should be used to map to other scores.
            learningObjectiveSet [0..*] Array [ Object ] The set of identifiers for the learning objectives to which this assessment is aligned. Any number groups of learning objectives can be assigned.
                    source [1..1] Union(SourceExtEnum) The source responsible for creating the learning objective identifiers. The permitted values are from an extensible vocabulary.
                    learningObjectiveIds [1..*] Array [ String ] The set of unique identifiers for the associated learning objectives. If these are CASE identifiers they MUST be valid UUIDs.

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.17b.

Code 6.34.1 - JSON payload example for "200" response messages for a "getLineItem" operation.
    {
        "lineItem" : {
            "sourcedId" : "..String..",
            "status" : "active"|"tobedeleted",
            "dateLastModified" : "..Date/Time..",
            "metadata" : {
                "..permitted extension point.." : "..user defined value.."
            },
            "title" : "..NormalizedString..",
            "description" : "..String..",
            "assignDate" : "..Date/Time..",
            "dueDate" : "..Date/Time..",
            "class" : {
                "href" : "..URI..",
                "sourcedId" : "..String..",
                "type" : "class"
            },
            "school" : {
                "href" : "..URI..",
                "sourcedId" : "..String..",
                "type" : "org"
            },
            "category" : {
                "href" : "..URI..",
                "sourcedId" : "..String..",
                "type" : "category"
            },
            "gradingPeriod" : {
                "href" : "..URI..",
                "sourcedId" : "..String..",
                "type" : "academicSession"
            },
            "academicSession" : {
                "href" : "..URI..",
                "sourcedId" : "..String..",
                "type" : "academicSession"
            },
            "scoreScale" : {
                "href" : "..URI..",
                "sourcedId" : "..String..",
                "type" : "scoreScale"
            },
            "resultValueMin" : ..Number(Float)..,
            "resultValueMax" : ..Number(Float)..,
            "learningObjectiveSet" : [
                {
                    "source" : "..select from Union..",
                    "learningObjectiveIds" : [ "..NormalizedString..", ..., "..NormalizedString.." ]
                },
                {...},
                {...}
            ]
        }
    }
                        

6.34.2 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.34.2 - Tabular representation of the JSON payload for "default, 400, 401, 403, 404, 422, 429, 500" response messages for a "getLineItem" 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.17c.

Code 6.34.2 - JSON payload example for "default, 400, 401, 403, 404, 422, 429, 500" response messages for a "getLineItem" 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"|"internal_server_error"|"server_busy"|"deletefailure"|"unknownobject"|"forbidden"
                },
                {...},
                {...}
            ]
        }
    }
                        

6.35 "getLineItemsForClass" Request Payload

There is no payload for this request.

6.36 "getLineItemsForClass" Response Payloads

6.36.1 Response Payloads for the HTTP Codes (200)

A tabular description of the response payload is shown in the Table below.

Table 6.36.1 - Tabular representation of the JSON payload for "200" response messages for a "getLineItemsForClass" operation.
Property Name Multiplicity JSON Data-type Description
    lineItems [0..*] Array [ Object ] The collection of lineItem 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, human readable, for the lineItem. This should allow the lineItem to be distinguished from its peer lineItems.
            description [0..1] String A human readable description of the usage of the lineItem.
            assignDate [1..1] String (Format: date-time) The date/time the activity being addressed by the lineItem was assigned to the student. This has a format as defined in [ISO 8601].
            dueDate [1..1] String (Format: date-time) The date/time by which the assignment must be completed and submitted. This has the dateTime format as defined in [ISO 8601].
            class [1..1] Object The GUID of the class to which the lineItem has been assigned.
                    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 GUID of the school for whom the lineItem has been assigned. This attribute was added in the OR 1.2 release.
                    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'.
            category [1..1] Object The GUID of the category to which the lineItem has been assigned.
                    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 'category'.
            gradingPeriod [0..1] Object The GUID of the grading period for the lineItem. This attribute was added in the OR 1.2 release.
                    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'.
            academicSession [0..1] Object The GUID of the academic session for the lineItem. This should NOT be defined if the 'gradingPeriod' attribute has been used.
                    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'.
            scoreScale [1..1] Object The GUID of the score scale to be used for the lineItem. This attribute was added in the OR 1.2 release.
                    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 'scoreScale'.
            resultValueMin [0..1] Float The minimum value (numeric) that can be assigned to the score attribute in a result. The score scale mapping should be used to map to other scores.
            resultValueMax [0..1] Float The maximum value (numeric) that can be assigned to the score attribute in a result. The score scale mapping should be used to map to other scores.
            learningObjectiveSet [0..*] Array [ Object ] The set of identifiers for the learning objectives to which this assessment is aligned. Any number groups of learning objectives can be assigned.
                    source [1..1] Union(SourceExtEnum) The source responsible for creating the learning objective identifiers. The permitted values are from an extensible vocabulary.
                    learningObjectiveIds [1..*] Array [ String ] The set of unique identifiers for the associated learning objectives. If these are CASE identifiers they MUST be valid UUIDs.

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.18b.

Code 6.36.1 - JSON payload example for "200" response messages for a "getLineItemsForClass" operation.
    {
        "lineItems" : [
            {
                "sourcedId" : "..String..",
                "status" : "active"|"tobedeleted",
                "dateLastModified" : "..Date/Time..",
                "metadata" : {
                    "..permitted extension point.." : "..user defined value.."
                },
                "title" : "..NormalizedString..",
                "description" : "..String..",
                "assignDate" : "..Date/Time..",
                "dueDate" : "..Date/Time..",
                "class" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "class"
                },
                "school" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "org"
                },
                "category" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "category"
                },
                "gradingPeriod" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "academicSession"
                },
                "academicSession" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "academicSession"
                },
                "scoreScale" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "scoreScale"
                },
                "resultValueMin" : ..Number(Float)..,
                "resultValueMax" : ..Number(Float)..,
                "learningObjectiveSet" : [
                    {
                        "source" : "..select from Union..",
                        "learningObjectiveIds" : [ "..NormalizedString..", ..., "..NormalizedString.." ]
                    },
                    {...},
                    {...}
                ]
            },
            {...},
            {...}
        ]
    }
                        

6.36.2 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.36.2 - Tabular representation of the JSON payload for "default, 400, 401, 403, 404, 422, 429, 500" response messages for a "getLineItemsForClass" 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.18c.

Code 6.36.2 - JSON payload example for "default, 400, 401, 403, 404, 422, 429, 500" response messages for a "getLineItemsForClass" 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"|"internal_server_error"|"server_busy"|"deletefailure"|"unknownobject"|"forbidden"
                },
                {...},
                {...}
            ]
        }
    }
                        

6.37 "getResult" Request Payload

There is no payload for this request.

6.38 "getResult" Response Payloads

6.38.1 Response Payloads for the HTTP Codes (200)

A tabular description of the response payload is shown in the Table below.

Table 6.38.1 - Tabular representation of the JSON payload for "200" response messages for a "getResult" operation.
Property Name Multiplicity JSON Data-type Description
    result [1..1] Object The instance of the single result 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.
            lineItem [1..1] Object The GUID of the lineItem to which the result is aligned.
                    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 'lineItem'.
            student [1..1] Object The GUID of the student for whom the result is assigned.
                    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 [0..1] Object The GUID of the class to which the result is aligned.
                    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'.
            scoreScale [0..1] Object The GUID of the scoreScale against which the result is aligned.
                    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 'scoreScale'.
            scoreStatus [1..1] Union(ScoreStatusExtEnum) The status of the score. The value is from an extensible enumerated vocabulary.
            score [0..1] Float The score for the result. If a scoreScale is assigned then the value must align with the scale.
            textScore [0..1] String An optional non-numeric score value. If a scoreScale is assigned then the value must align with the scale. This attribute was added in OR 1.2.
            scoreDate [1..1] String (Format: date) The date at which the score is assigned or there is an update to the result e.g. change in the 'scoreStatus'. The format is YYYY-MM-DD as defined in [ISO 8601].
            comment [0..1] String A human readable comment about the score.
            learningObjectiveSet [0..*] Array [ Object ] The set of identifiers for the learning objectives to which this result is aligned. Any number groups of learning objectives can be assigned.
                    source [1..1] Union(SourceExtEnum) The source responsible for creating the learning objective identifiers. The permitted values are from an extensible vocabulary.
                    learningObjectiveResults [1..*] Array [ Object ] The set of unique identifiers for the associated learning objectives (these may have alignment with a mastery score). If these are CASE identifiers they MUST be valid UUIDs.
                            learningObjectiveId [1..1] String The unique identifier for the associated learning objective. If this is a CASE identifier it MUST be a valid UUID.
                            score [0..1] Float The optional mastery score supplied as a numeric value.
                            textScore [0..1] String The optional mastery score supplied in a non-numeric form.

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.19b.

Code 6.38.1 - JSON payload example for "200" response messages for a "getResult" operation.
    {
        "result" : {
            "sourcedId" : "..String..",
            "status" : "active"|"tobedeleted",
            "dateLastModified" : "..Date/Time..",
            "metadata" : {
                "..permitted extension point.." : "..user defined value.."
            },
            "lineItem" : {
                "href" : "..URI..",
                "sourcedId" : "..String..",
                "type" : "lineItem"
            },
            "student" : {
                "href" : "..URI..",
                "sourcedId" : "..String..",
                "type" : "user"
            },
            "class" : {
                "href" : "..URI..",
                "sourcedId" : "..String..",
                "type" : "class"
            },
            "scoreScale" : {
                "href" : "..URI..",
                "sourcedId" : "..String..",
                "type" : "scoreScale"
            },
            "scoreStatus" : "..select from Union..",
            "score" : ..Number(Float)..,
            "textScore" : "..NormalizedString..",
            "scoreDate" : "..String(Date)..",
            "comment" : "..String..",
            "learningObjectiveSet" : [
                {
                    "source" : "..select from Union..",
                    "learningObjectiveResults" : [
                        {
                            "learningObjectiveId" : "..NormalizedString..",
                            "score" : ..Number(Float)..,
                            "textScore" : "..NormalizedString.."
                        },
                        {...},
                        {...}
                    ]
                },
                {...},
                {...}
            ]
        }
    }
                        

6.38.2 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.38.2 - Tabular representation of the JSON payload for "default, 400, 401, 403, 404, 422, 429, 500" response messages for a "getResult" 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.19c.

Code 6.38.2 - JSON payload example for "default, 400, 401, 403, 404, 422, 429, 500" response messages for a "getResult" 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"|"internal_server_error"|"server_busy"|"deletefailure"|"unknownobject"|"forbidden"
                },
                {...},
                {...}
            ]
        }
    }
                        

6.39 "getResultsForClass" Request Payload

There is no payload for this request.

6.40 "getResultsForClass" Response Payloads

6.40.1 Response Payloads for the HTTP Codes (200)

A tabular description of the response payload is shown in the Table below.

Table 6.40.1 - Tabular representation of the JSON payload for "200" response messages for a "getResultsForClass" operation.
Property Name Multiplicity JSON Data-type Description
    results [0..*] Array [ Object ] The collection of result 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.
            lineItem [1..1] Object The GUID of the lineItem to which the result is aligned.
                    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 'lineItem'.
            student [1..1] Object The GUID of the student for whom the result is assigned.
                    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 [0..1] Object The GUID of the class to which the result is aligned.
                    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'.
            scoreScale [0..1] Object The GUID of the scoreScale against which the result is aligned.
                    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 'scoreScale'.
            scoreStatus [1..1] Union(ScoreStatusExtEnum) The status of the score. The value is from an extensible enumerated vocabulary.
            score [0..1] Float The score for the result. If a scoreScale is assigned then the value must align with the scale.
            textScore [0..1] String An optional non-numeric score value. If a scoreScale is assigned then the value must align with the scale. This attribute was added in OR 1.2.
            scoreDate [1..1] String (Format: date) The date at which the score is assigned or there is an update to the result e.g. change in the 'scoreStatus'. The format is YYYY-MM-DD as defined in [ISO 8601].
            comment [0..1] String A human readable comment about the score.
            learningObjectiveSet [0..*] Array [ Object ] The set of identifiers for the learning objectives to which this result is aligned. Any number groups of learning objectives can be assigned.
                    source [1..1] Union(SourceExtEnum) The source responsible for creating the learning objective identifiers. The permitted values are from an extensible vocabulary.
                    learningObjectiveResults [1..*] Array [ Object ] The set of unique identifiers for the associated learning objectives (these may have alignment with a mastery score). If these are CASE identifiers they MUST be valid UUIDs.
                            learningObjectiveId [1..1] String The unique identifier for the associated learning objective. If this is a CASE identifier it MUST be a valid UUID.
                            score [0..1] Float The optional mastery score supplied as a numeric value.
                            textScore [0..1] String The optional mastery score supplied in a non-numeric form.

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.20b.

Code 6.40.1 - JSON payload example for "200" response messages for a "getResultsForClass" operation.
    {
        "results" : [
            {
                "sourcedId" : "..String..",
                "status" : "active"|"tobedeleted",
                "dateLastModified" : "..Date/Time..",
                "metadata" : {
                    "..permitted extension point.." : "..user defined value.."
                },
                "lineItem" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "lineItem"
                },
                "student" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "user"
                },
                "class" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "class"
                },
                "scoreScale" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "scoreScale"
                },
                "scoreStatus" : "..select from Union..",
                "score" : ..Number(Float)..,
                "textScore" : "..NormalizedString..",
                "scoreDate" : "..String(Date)..",
                "comment" : "..String..",
                "learningObjectiveSet" : [
                    {
                        "source" : "..select from Union..",
                        "learningObjectiveResults" : [
                            {
                                "learningObjectiveId" : "..NormalizedString..",
                                "score" : ..Number(Float)..,
                                "textScore" : "..NormalizedString.."
                            },
                            {...},
                            {...}
                        ]
                    },
                    {...},
                    {...}
                ]
            },
            {...},
            {...}
        ]
    }
                        

6.40.2 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.40.2 - Tabular representation of the JSON payload for "default, 400, 401, 403, 404, 422, 429, 500" response messages for a "getResultsForClass" 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.20c.

Code 6.40.2 - JSON payload example for "default, 400, 401, 403, 404, 422, 429, 500" response messages for a "getResultsForClass" 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"|"internal_server_error"|"server_busy"|"deletefailure"|"unknownobject"|"forbidden"
                },
                {...},
                {...}
            ]
        }
    }
                        

6.41 "getResultsForLineItemForClass" Request Payload

There is no payload for this request.

6.42 "getResultsForLineItemForClass" Response Payloads

6.42.1 Response Payloads for the HTTP Codes (200)

A tabular description of the response payload is shown in the Table below.

Table 6.42.1 - Tabular representation of the JSON payload for "200" response messages for a "getResultsForLineItemForClass" operation.
Property Name Multiplicity JSON Data-type Description
    results [0..*] Array [ Object ] The collection of result 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.
            lineItem [1..1] Object The GUID of the lineItem to which the result is aligned.
                    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 'lineItem'.
            student [1..1] Object The GUID of the student for whom the result is assigned.
                    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 [0..1] Object The GUID of the class to which the result is aligned.
                    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'.
            scoreScale [0..1] Object The GUID of the scoreScale against which the result is aligned.
                    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 'scoreScale'.
            scoreStatus [1..1] Union(ScoreStatusExtEnum) The status of the score. The value is from an extensible enumerated vocabulary.
            score [0..1] Float The score for the result. If a scoreScale is assigned then the value must align with the scale.
            textScore [0..1] String An optional non-numeric score value. If a scoreScale is assigned then the value must align with the scale. This attribute was added in OR 1.2.
            scoreDate [1..1] String (Format: date) The date at which the score is assigned or there is an update to the result e.g. change in the 'scoreStatus'. The format is YYYY-MM-DD as defined in [ISO 8601].
            comment [0..1] String A human readable comment about the score.
            learningObjectiveSet [0..*] Array [ Object ] The set of identifiers for the learning objectives to which this result is aligned. Any number groups of learning objectives can be assigned.
                    source [1..1] Union(SourceExtEnum) The source responsible for creating the learning objective identifiers. The permitted values are from an extensible vocabulary.
                    learningObjectiveResults [1..*] Array [ Object ] The set of unique identifiers for the associated learning objectives (these may have alignment with a mastery score). If these are CASE identifiers they MUST be valid UUIDs.
                            learningObjectiveId [1..1] String The unique identifier for the associated learning objective. If this is a CASE identifier it MUST be a valid UUID.
                            score [0..1] Float The optional mastery score supplied as a numeric value.
                            textScore [0..1] String The optional mastery score supplied in a non-numeric form.

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.21b.

Code 6.42.1 - JSON payload example for "200" response messages for a "getResultsForLineItemForClass" operation.
    {
        "results" : [
            {
                "sourcedId" : "..String..",
                "status" : "active"|"tobedeleted",
                "dateLastModified" : "..Date/Time..",
                "metadata" : {
                    "..permitted extension point.." : "..user defined value.."
                },
                "lineItem" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "lineItem"
                },
                "student" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "user"
                },
                "class" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "class"
                },
                "scoreScale" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "scoreScale"
                },
                "scoreStatus" : "..select from Union..",
                "score" : ..Number(Float)..,
                "textScore" : "..NormalizedString..",
                "scoreDate" : "..String(Date)..",
                "comment" : "..String..",
                "learningObjectiveSet" : [
                    {
                        "source" : "..select from Union..",
                        "learningObjectiveResults" : [
                            {
                                "learningObjectiveId" : "..NormalizedString..",
                                "score" : ..Number(Float)..,
                                "textScore" : "..NormalizedString.."
                            },
                            {...},
                            {...}
                        ]
                    },
                    {...},
                    {...}
                ]
            },
            {...},
            {...}
        ]
    }
                        

6.42.2 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.42.2 - Tabular representation of the JSON payload for "default, 400, 401, 403, 404, 422, 429, 500" response messages for a "getResultsForLineItemForClass" 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.21c.

Code 6.42.2 - JSON payload example for "default, 400, 401, 403, 404, 422, 429, 500" response messages for a "getResultsForLineItemForClass" 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"|"internal_server_error"|"server_busy"|"deletefailure"|"unknownobject"|"forbidden"
                },
                {...},
                {...}
            ]
        }
    }
                        

6.43 "getResultsForStudentForClass" Request Payload

There is no payload for this request.

6.44 "getResultsForStudentForClass" Response Payloads

6.44.1 Response Payloads for the HTTP Codes (200)

A tabular description of the response payload is shown in the Table below.

Table 6.44.1 - Tabular representation of the JSON payload for "200" response messages for a "getResultsForStudentForClass" operation.
Property Name Multiplicity JSON Data-type Description
    results [0..*] Array [ Object ] The collection of result 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.
            lineItem [1..1] Object The GUID of the lineItem to which the result is aligned.
                    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 'lineItem'.
            student [1..1] Object The GUID of the student for whom the result is assigned.
                    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 [0..1] Object The GUID of the class to which the result is aligned.
                    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'.
            scoreScale [0..1] Object The GUID of the scoreScale against which the result is aligned.
                    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 'scoreScale'.
            scoreStatus [1..1] Union(ScoreStatusExtEnum) The status of the score. The value is from an extensible enumerated vocabulary.
            score [0..1] Float The score for the result. If a scoreScale is assigned then the value must align with the scale.
            textScore [0..1] String An optional non-numeric score value. If a scoreScale is assigned then the value must align with the scale. This attribute was added in OR 1.2.
            scoreDate [1..1] String (Format: date) The date at which the score is assigned or there is an update to the result e.g. change in the 'scoreStatus'. The format is YYYY-MM-DD as defined in [ISO 8601].
            comment [0..1] String A human readable comment about the score.
            learningObjectiveSet [0..*] Array [ Object ] The set of identifiers for the learning objectives to which this result is aligned. Any number groups of learning objectives can be assigned.
                    source [1..1] Union(SourceExtEnum) The source responsible for creating the learning objective identifiers. The permitted values are from an extensible vocabulary.
                    learningObjectiveResults [1..*] Array [ Object ] The set of unique identifiers for the associated learning objectives (these may have alignment with a mastery score). If these are CASE identifiers they MUST be valid UUIDs.
                            learningObjectiveId [1..1] String The unique identifier for the associated learning objective. If this is a CASE identifier it MUST be a valid UUID.
                            score [0..1] Float The optional mastery score supplied as a numeric value.
                            textScore [0..1] String The optional mastery score supplied in a non-numeric form.

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.22b.

Code 6.44.1 - JSON payload example for "200" response messages for a "getResultsForStudentForClass" operation.
    {
        "results" : [
            {
                "sourcedId" : "..String..",
                "status" : "active"|"tobedeleted",
                "dateLastModified" : "..Date/Time..",
                "metadata" : {
                    "..permitted extension point.." : "..user defined value.."
                },
                "lineItem" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "lineItem"
                },
                "student" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "user"
                },
                "class" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "class"
                },
                "scoreScale" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "scoreScale"
                },
                "scoreStatus" : "..select from Union..",
                "score" : ..Number(Float)..,
                "textScore" : "..NormalizedString..",
                "scoreDate" : "..String(Date)..",
                "comment" : "..String..",
                "learningObjectiveSet" : [
                    {
                        "source" : "..select from Union..",
                        "learningObjectiveResults" : [
                            {
                                "learningObjectiveId" : "..NormalizedString..",
                                "score" : ..Number(Float)..,
                                "textScore" : "..NormalizedString.."
                            },
                            {...},
                            {...}
                        ]
                    },
                    {...},
                    {...}
                ]
            },
            {...},
            {...}
        ]
    }
                        

6.44.2 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.44.2 - Tabular representation of the JSON payload for "default, 400, 401, 403, 404, 422, 429, 500" response messages for a "getResultsForStudentForClass" 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.22c.

Code 6.44.2 - JSON payload example for "default, 400, 401, 403, 404, 422, 429, 500" response messages for a "getResultsForStudentForClass" 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"|"internal_server_error"|"server_busy"|"deletefailure"|"unknownobject"|"forbidden"
                },
                {...},
                {...}
            ]
        }
    }
                        

6.45 "getScoreScale" Request Payload

There is no payload for this request.

6.46 "getScoreScale" Response Payloads

6.46.1 Response Payloads for the HTTP Codes (200)

A tabular description of the response payload is shown in the Table below.

Table 6.46.1 - Tabular representation of the JSON payload for "200" response messages for a "getScoreScale" operation.
Property Name Multiplicity JSON Data-type Description
    scoreScale [1..1] Object The instance of the single scoreScale 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 human readable title for the score scale mapping.
            type [1..1] String The type of score scale mapping. At present there is no predefined vocabulary. This should be used by an organization to differentiate between the score scales that it produces.
            course [0..1] Object The GUID for the course for which this scale will be used.
                    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'.
            class [1..1] Object The GUID for the class for which this scale will be used.
                    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'.
            scoreScaleValue [1..*] Array [ Object ] The set of mappings for this score scale.
                    itemValueLHS [1..1] String The left hand side value of the mapping relationship. The format is either a single value ('x') or a range ('x' - 'y'). In the case of a single value this is considered to be the inclusive lower value for the implied range. When a range is specified (lower-to-upper) the values are inclusive.
                    itemValueRHS [1..1] String The right hand side value of the mapping relationship i.e. the equivalent value to the reference point defined in the LHS.

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.23b.

Code 6.46.1 - JSON payload example for "200" response messages for a "getScoreScale" operation.
    {
        "scoreScale" : {
            "sourcedId" : "..String..",
            "status" : "active"|"tobedeleted",
            "dateLastModified" : "..Date/Time..",
            "metadata" : {
                "..permitted extension point.." : "..user defined value.."
            },
            "title" : "..NormalizedString..",
            "type" : "..NormalizedString..",
            "course" : {
                "href" : "..URI..",
                "sourcedId" : "..String..",
                "type" : "course"
            },
            "class" : {
                "href" : "..URI..",
                "sourcedId" : "..String..",
                "type" : "class"
            },
            "scoreScaleValue" : [
                {
                    "itemValueLHS" : "..NormalizedString..",
                    "itemValueRHS" : "..NormalizedString.."
                },
                {...},
                {...}
            ]
        }
    }
                        

6.46.2 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.46.2 - Tabular representation of the JSON payload for "default, 400, 401, 403, 404, 422, 429, 500" response messages for a "getScoreScale" 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.23c.

Code 6.46.2 - JSON payload example for "default, 400, 401, 403, 404, 422, 429, 500" response messages for a "getScoreScale" 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"|"internal_server_error"|"server_busy"|"deletefailure"|"unknownobject"|"forbidden"
                },
                {...},
                {...}
            ]
        }
    }
                        

6.47 "getScoreScalesForClass" Request Payload

There is no payload for this request.

6.48 "getScoreScalesForClass" Response Payloads

6.48.1 Response Payloads for the HTTP Codes (200)

A tabular description of the response payload is shown in the Table below.

Table 6.48.1 - Tabular representation of the JSON payload for "200" response messages for a "getScoreScalesForClass" operation.
Property Name Multiplicity JSON Data-type Description
    scoreScales [0..*] Array [ Object ] The collection of scoreScale 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 human readable title for the score scale mapping.
            type [1..1] String The type of score scale mapping. At present there is no predefined vocabulary. This should be used by an organization to differentiate between the score scales that it produces.
            course [0..1] Object The GUID for the course for which this scale will be used.
                    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'.
            class [1..1] Object The GUID for the class for which this scale will be used.
                    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'.
            scoreScaleValue [1..*] Array [ Object ] The set of mappings for this score scale.
                    itemValueLHS [1..1] String The left hand side value of the mapping relationship. The format is either a single value ('x') or a range ('x' - 'y'). In the case of a single value this is considered to be the inclusive lower value for the implied range. When a range is specified (lower-to-upper) the values are inclusive.
                    itemValueRHS [1..1] String The right hand side value of the mapping relationship i.e. the equivalent value to the reference point defined in the LHS.

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.24b.

Code 6.48.1 - JSON payload example for "200" response messages for a "getScoreScalesForClass" operation.
    {
        "scoreScales" : [
            {
                "sourcedId" : "..String..",
                "status" : "active"|"tobedeleted",
                "dateLastModified" : "..Date/Time..",
                "metadata" : {
                    "..permitted extension point.." : "..user defined value.."
                },
                "title" : "..NormalizedString..",
                "type" : "..NormalizedString..",
                "course" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "course"
                },
                "class" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "class"
                },
                "scoreScaleValue" : [
                    {
                        "itemValueLHS" : "..NormalizedString..",
                        "itemValueRHS" : "..NormalizedString.."
                    },
                    {...},
                    {...}
                ]
            },
            {...},
            {...}
        ]
    }
                        

6.48.2 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.48.2 - Tabular representation of the JSON payload for "default, 400, 401, 403, 404, 422, 429, 500" response messages for a "getScoreScalesForClass" 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.24c.

Code 6.48.2 - JSON payload example for "default, 400, 401, 403, 404, 422, 429, 500" response messages for a "getScoreScalesForClass" 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"|"internal_server_error"|"server_busy"|"deletefailure"|"unknownobject"|"forbidden"
                },
                {...},
                {...}
            ]
        }
    }
                        

6.49 "getScoreScalesForSchool" Request Payload

There is no payload for this request.

6.50 "getScoreScalesForSchool" Response Payloads

6.50.1 Response Payloads for the HTTP Codes (200)

A tabular description of the response payload is shown in the Table below.

Table 6.50.1 - Tabular representation of the JSON payload for "200" response messages for a "getScoreScalesForSchool" operation.
Property Name Multiplicity JSON Data-type Description
    scoreScales [0..*] Array [ Object ] The collection of scoreScale 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 human readable title for the score scale mapping.
            type [1..1] String The type of score scale mapping. At present there is no predefined vocabulary. This should be used by an organization to differentiate between the score scales that it produces.
            course [0..1] Object The GUID for the course for which this scale will be used.
                    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'.
            class [1..1] Object The GUID for the class for which this scale will be used.
                    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'.
            scoreScaleValue [1..*] Array [ Object ] The set of mappings for this score scale.
                    itemValueLHS [1..1] String The left hand side value of the mapping relationship. The format is either a single value ('x') or a range ('x' - 'y'). In the case of a single value this is considered to be the inclusive lower value for the implied range. When a range is specified (lower-to-upper) the values are inclusive.
                    itemValueRHS [1..1] String The right hand side value of the mapping relationship i.e. the equivalent value to the reference point defined in the LHS.

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.25b.

Code 6.50.1 - JSON payload example for "200" response messages for a "getScoreScalesForSchool" operation.
    {
        "scoreScales" : [
            {
                "sourcedId" : "..String..",
                "status" : "active"|"tobedeleted",
                "dateLastModified" : "..Date/Time..",
                "metadata" : {
                    "..permitted extension point.." : "..user defined value.."
                },
                "title" : "..NormalizedString..",
                "type" : "..NormalizedString..",
                "course" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "course"
                },
                "class" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "class"
                },
                "scoreScaleValue" : [
                    {
                        "itemValueLHS" : "..NormalizedString..",
                        "itemValueRHS" : "..NormalizedString.."
                    },
                    {...},
                    {...}
                ]
            },
            {...},
            {...}
        ]
    }
                        

6.50.2 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.50.2 - Tabular representation of the JSON payload for "default, 400, 401, 403, 404, 422, 429, 500" response messages for a "getScoreScalesForSchool" 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.25c.

Code 6.50.2 - JSON payload example for "default, 400, 401, 403, 404, 422, 429, 500" response messages for a "getScoreScalesForSchool" 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"|"internal_server_error"|"server_busy"|"deletefailure"|"unknownobject"|"forbidden"
                },
                {...},
                {...}
            ]
        }
    }
                        

6.51 "postLineItemsForClass" Request Payload

A tabular description of the request payload is shown in the Table below.

Table 6.51.1 - Tabular representation of the JSON payload for the request message for a "postLineItemsForClass" operation.
Property Name Multiplicity JSON Data-type Description
    lineItems [0..*] Array [ Object ] The collection of lineItem 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, human readable, for the lineItem. This should allow the lineItem to be distinguished from its peer lineItems.
            description [0..1] String A human readable description of the usage of the lineItem.
            assignDate [1..1] String (Format: date-time) The date/time the activity being addressed by the lineItem was assigned to the student. This has a format as defined in [ISO 8601].
            dueDate [1..1] String (Format: date-time) The date/time by which the assignment must be completed and submitted. This has the dateTime format as defined in [ISO 8601].
            class [1..1] Object The GUID of the class to which the lineItem has been assigned.
                    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 GUID of the school for whom the lineItem has been assigned. This attribute was added in the OR 1.2 release.
                    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'.
            category [1..1] Object The GUID of the category to which the lineItem has been assigned.
                    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 'category'.
            gradingPeriod [0..1] Object The GUID of the grading period for the lineItem. This attribute was added in the OR 1.2 release.
                    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'.
            academicSession [0..1] Object The GUID of the academic session for the lineItem. This should NOT be defined if the 'gradingPeriod' attribute has been used.
                    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'.
            scoreScale [1..1] Object The GUID of the score scale to be used for the lineItem. This attribute was added in the OR 1.2 release.
                    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 'scoreScale'.
            resultValueMin [0..1] Float The minimum value (numeric) that can be assigned to the score attribute in a result. The score scale mapping should be used to map to other scores.
            resultValueMax [0..1] Float The maximum value (numeric) that can be assigned to the score attribute in a result. The score scale mapping should be used to map to other scores.
            learningObjectiveSet [0..*] Array [ Object ] The set of identifiers for the learning objectives to which this assessment is aligned. Any number groups of learning objectives can be assigned.
                    source [1..1] Union(SourceExtEnum) The source responsible for creating the learning objective identifiers. The permitted values are from an extensible vocabulary.
                    learningObjectiveIds [1..*] Array [ String ] The set of unique identifiers for the associated learning objectives. If these are CASE identifiers they MUST be valid UUIDs.

An example of the request payload is shown in the code block below.

Code 6.51.1 - JSON payload example for the request message for a "postLineItemsForClass" operation.
    {
        "lineItems" : [
            {
                "sourcedId" : "..String..",
                "status" : "active"|"tobedeleted",
                "dateLastModified" : "..Date/Time..",
                "metadata" : {
                    "..permitted extension point.." : "..user defined value.."
                },
                "title" : "..NormalizedString..",
                "description" : "..String..",
                "assignDate" : "..Date/Time..",
                "dueDate" : "..Date/Time..",
                "class" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "class"
                },
                "school" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "org"
                },
                "category" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "category"
                },
                "gradingPeriod" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "academicSession"
                },
                "academicSession" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "academicSession"
                },
                "scoreScale" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "scoreScale"
                },
                "resultValueMin" : ..Number(Float)..,
                "resultValueMax" : ..Number(Float)..,
                "learningObjectiveSet" : [
                    {
                        "source" : "..select from Union..",
                        "learningObjectiveIds" : [ "..NormalizedString..", ..., "..NormalizedString.." ]
                    },
                    {...},
                    {...}
                ]
            },
            {...},
            {...}
        ]
    }
                        

6.52 "postLineItemsForClass" Response Payloads

6.52.1 Response Payloads for the HTTP Codes (201)

A tabular description of the response payload is shown in the Table below.

Table 6.52.1 - Tabular representation of the JSON payload for "201" response messages for a "postLineItemsForClass" operation.
Property Name Multiplicity JSON Data-type Description
    sourcedIdPairs [0..*] Array [ Object ] The set of sourcedId pairs. The order is not significant as each pair contains the information between the original/new values.
            suppliedSourcedId [1..1] String The temporary sourcedId that has been allocated by the requesting system. This sourcedId is used to enable identification of the original record for which the new sourcedId has been allocated at the service provider.
            allocatedSourcedId [1..1] String The sourcedId that has been allocated by the system on which the new record has been created.

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.26b.

Code 6.52.1 - JSON payload example for "201" response messages for a "postLineItemsForClass" operation.
    {
        "sourcedIdPairs" : [
            {
                "suppliedSourcedId" : "..String..",
                "allocatedSourcedId" : "..String.."
            },
            {...},
            {...}
        ]
    }
                        

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

A tabular description of the response payload is shown in the Table below.

Table 6.52.2 - Tabular representation of the JSON payload for "default, 401, 403, 404, 422, 429, 500" response messages for a "postLineItemsForClass" 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.26c.

Code 6.52.2 - JSON payload example for "default, 401, 403, 404, 422, 429, 500" response messages for a "postLineItemsForClass" 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"|"internal_server_error"|"server_busy"|"deletefailure"|"unknownobject"|"forbidden"
                },
                {...},
                {...}
            ]
        }
    }
                        

6.53 "postLineItemsForSchool" Request Payload

A tabular description of the request payload is shown in the Table below.

Table 6.53.1 - Tabular representation of the JSON payload for the request message for a "postLineItemsForSchool" operation.
Property Name Multiplicity JSON Data-type Description
    lineItems [0..*] Array [ Object ] The collection of lineItem 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, human readable, for the lineItem. This should allow the lineItem to be distinguished from its peer lineItems.
            description [0..1] String A human readable description of the usage of the lineItem.
            assignDate [1..1] String (Format: date-time) The date/time the activity being addressed by the lineItem was assigned to the student. This has a format as defined in [ISO 8601].
            dueDate [1..1] String (Format: date-time) The date/time by which the assignment must be completed and submitted. This has the dateTime format as defined in [ISO 8601].
            class [1..1] Object The GUID of the class to which the lineItem has been assigned.
                    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 GUID of the school for whom the lineItem has been assigned. This attribute was added in the OR 1.2 release.
                    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'.
            category [1..1] Object The GUID of the category to which the lineItem has been assigned.
                    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 'category'.
            gradingPeriod [0..1] Object The GUID of the grading period for the lineItem. This attribute was added in the OR 1.2 release.
                    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'.
            academicSession [0..1] Object The GUID of the academic session for the lineItem. This should NOT be defined if the 'gradingPeriod' attribute has been used.
                    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'.
            scoreScale [1..1] Object The GUID of the score scale to be used for the lineItem. This attribute was added in the OR 1.2 release.
                    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 'scoreScale'.
            resultValueMin [0..1] Float The minimum value (numeric) that can be assigned to the score attribute in a result. The score scale mapping should be used to map to other scores.
            resultValueMax [0..1] Float The maximum value (numeric) that can be assigned to the score attribute in a result. The score scale mapping should be used to map to other scores.
            learningObjectiveSet [0..*] Array [ Object ] The set of identifiers for the learning objectives to which this assessment is aligned. Any number groups of learning objectives can be assigned.
                    source [1..1] Union(SourceExtEnum) The source responsible for creating the learning objective identifiers. The permitted values are from an extensible vocabulary.
                    learningObjectiveIds [1..*] Array [ String ] The set of unique identifiers for the associated learning objectives. If these are CASE identifiers they MUST be valid UUIDs.

An example of the request payload is shown in the code block below.

Code 6.53.1 - JSON payload example for the request message for a "postLineItemsForSchool" operation.
    {
        "lineItems" : [
            {
                "sourcedId" : "..String..",
                "status" : "active"|"tobedeleted",
                "dateLastModified" : "..Date/Time..",
                "metadata" : {
                    "..permitted extension point.." : "..user defined value.."
                },
                "title" : "..NormalizedString..",
                "description" : "..String..",
                "assignDate" : "..Date/Time..",
                "dueDate" : "..Date/Time..",
                "class" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "class"
                },
                "school" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "org"
                },
                "category" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "category"
                },
                "gradingPeriod" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "academicSession"
                },
                "academicSession" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "academicSession"
                },
                "scoreScale" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "scoreScale"
                },
                "resultValueMin" : ..Number(Float)..,
                "resultValueMax" : ..Number(Float)..,
                "learningObjectiveSet" : [
                    {
                        "source" : "..select from Union..",
                        "learningObjectiveIds" : [ "..NormalizedString..", ..., "..NormalizedString.." ]
                    },
                    {...},
                    {...}
                ]
            },
            {...},
            {...}
        ]
    }
                        

6.54 "postLineItemsForSchool" Response Payloads

6.54.1 Response Payloads for the HTTP Codes (201)

A tabular description of the response payload is shown in the Table below.

Table 6.54.1 - Tabular representation of the JSON payload for "201" response messages for a "postLineItemsForSchool" operation.
Property Name Multiplicity JSON Data-type Description
    sourcedIdPairs [0..*] Array [ Object ] The set of sourcedId pairs. The order is not significant as each pair contains the information between the original/new values.
            suppliedSourcedId [1..1] String The temporary sourcedId that has been allocated by the requesting system. This sourcedId is used to enable identification of the original record for which the new sourcedId has been allocated at the service provider.
            allocatedSourcedId [1..1] String The sourcedId that has been allocated by the system on which the new record has been created.

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.27b.

Code 6.54.1 - JSON payload example for "201" response messages for a "postLineItemsForSchool" operation.
    {
        "sourcedIdPairs" : [
            {
                "suppliedSourcedId" : "..String..",
                "allocatedSourcedId" : "..String.."
            },
            {...},
            {...}
        ]
    }
                        

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

A tabular description of the response payload is shown in the Table below.

Table 6.54.2 - Tabular representation of the JSON payload for "default, 401, 403, 404, 422, 429, 500" response messages for a "postLineItemsForSchool" 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.27c.

Code 6.54.2 - JSON payload example for "default, 401, 403, 404, 422, 429, 500" response messages for a "postLineItemsForSchool" 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"|"internal_server_error"|"server_busy"|"deletefailure"|"unknownobject"|"forbidden"
                },
                {...},
                {...}
            ]
        }
    }
                        

6.55 "postResultsForAcademicSessionForClass" Request Payload

A tabular description of the request payload is shown in the Table below.

Table 6.55.1 - Tabular representation of the JSON payload for the request message for a "postResultsForAcademicSessionForClass" operation.
Property Name Multiplicity JSON Data-type Description
    results [0..*] Array [ Object ] The collection of result 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.
            lineItem [1..1] Object The GUID of the lineItem to which the result is aligned.
                    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 'lineItem'.
            student [1..1] Object The GUID of the student for whom the result is assigned.
                    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 [0..1] Object The GUID of the class to which the result is aligned.
                    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'.
            scoreScale [0..1] Object The GUID of the scoreScale against which the result is aligned.
                    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 'scoreScale'.
            scoreStatus [1..1] Union(ScoreStatusExtEnum) The status of the score. The value is from an extensible enumerated vocabulary.
            score [0..1] Float The score for the result. If a scoreScale is assigned then the value must align with the scale.
            textScore [0..1] String An optional non-numeric score value. If a scoreScale is assigned then the value must align with the scale. This attribute was added in OR 1.2.
            scoreDate [1..1] String (Format: date) The date at which the score is assigned or there is an update to the result e.g. change in the 'scoreStatus'. The format is YYYY-MM-DD as defined in [ISO 8601].
            comment [0..1] String A human readable comment about the score.
            learningObjectiveSet [0..*] Array [ Object ] The set of identifiers for the learning objectives to which this result is aligned. Any number groups of learning objectives can be assigned.
                    source [1..1] Union(SourceExtEnum) The source responsible for creating the learning objective identifiers. The permitted values are from an extensible vocabulary.
                    learningObjectiveResults [1..*] Array [ Object ] The set of unique identifiers for the associated learning objectives (these may have alignment with a mastery score). If these are CASE identifiers they MUST be valid UUIDs.
                            learningObjectiveId [1..1] String The unique identifier for the associated learning objective. If this is a CASE identifier it MUST be a valid UUID.
                            score [0..1] Float The optional mastery score supplied as a numeric value.
                            textScore [0..1] String The optional mastery score supplied in a non-numeric form.

An example of the request payload is shown in the code block below.

Code 6.55.1 - JSON payload example for the request message for a "postResultsForAcademicSessionForClass" operation.
    {
        "results" : [
            {
                "sourcedId" : "..String..",
                "status" : "active"|"tobedeleted",
                "dateLastModified" : "..Date/Time..",
                "metadata" : {
                    "..permitted extension point.." : "..user defined value.."
                },
                "lineItem" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "lineItem"
                },
                "student" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "user"
                },
                "class" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "class"
                },
                "scoreScale" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "scoreScale"
                },
                "scoreStatus" : "..select from Union..",
                "score" : ..Number(Float)..,
                "textScore" : "..NormalizedString..",
                "scoreDate" : "..String(Date)..",
                "comment" : "..String..",
                "learningObjectiveSet" : [
                    {
                        "source" : "..select from Union..",
                        "learningObjectiveResults" : [
                            {
                                "learningObjectiveId" : "..NormalizedString..",
                                "score" : ..Number(Float)..,
                                "textScore" : "..NormalizedString.."
                            },
                            {...},
                            {...}
                        ]
                    },
                    {...},
                    {...}
                ]
            },
            {...},
            {...}
        ]
    }
                        

6.56 "postResultsForAcademicSessionForClass" Response Payloads

6.56.1 Response Payloads for the HTTP Codes (201)

A tabular description of the response payload is shown in the Table below.

Table 6.56.1 - Tabular representation of the JSON payload for "201" response messages for a "postResultsForAcademicSessionForClass" operation.
Property Name Multiplicity JSON Data-type Description
    sourcedIdPairs [0..*] Array [ Object ] The set of sourcedId pairs. The order is not significant as each pair contains the information between the original/new values.
            suppliedSourcedId [1..1] String The temporary sourcedId that has been allocated by the requesting system. This sourcedId is used to enable identification of the original record for which the new sourcedId has been allocated at the service provider.
            allocatedSourcedId [1..1] String The sourcedId that has been allocated by the system on which the new record has been created.

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.28b.

Code 6.56.1 - JSON payload example for "201" response messages for a "postResultsForAcademicSessionForClass" operation.
    {
        "sourcedIdPairs" : [
            {
                "suppliedSourcedId" : "..String..",
                "allocatedSourcedId" : "..String.."
            },
            {...},
            {...}
        ]
    }
                        

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

A tabular description of the response payload is shown in the Table below.

Table 6.56.2 - Tabular representation of the JSON payload for "default, 401, 403, 404, 422, 429, 500" response messages for a "postResultsForAcademicSessionForClass" 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.28c.

Code 6.56.2 - JSON payload example for "default, 401, 403, 404, 422, 429, 500" response messages for a "postResultsForAcademicSessionForClass" 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"|"internal_server_error"|"server_busy"|"deletefailure"|"unknownobject"|"forbidden"
                },
                {...},
                {...}
            ]
        }
    }
                        

6.57 "postResultsForLineItem" Request Payload

A tabular description of the request payload is shown in the Table below.

Table 6.57.1 - Tabular representation of the JSON payload for the request message for a "postResultsForLineItem" operation.
Property Name Multiplicity JSON Data-type Description
    results [0..*] Array [ Object ] The collection of result 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.
            lineItem [1..1] Object The GUID of the lineItem to which the result is aligned.
                    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 'lineItem'.
            student [1..1] Object The GUID of the student for whom the result is assigned.
                    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 [0..1] Object The GUID of the class to which the result is aligned.
                    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'.
            scoreScale [0..1] Object The GUID of the scoreScale against which the result is aligned.
                    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 'scoreScale'.
            scoreStatus [1..1] Union(ScoreStatusExtEnum) The status of the score. The value is from an extensible enumerated vocabulary.
            score [0..1] Float The score for the result. If a scoreScale is assigned then the value must align with the scale.
            textScore [0..1] String An optional non-numeric score value. If a scoreScale is assigned then the value must align with the scale. This attribute was added in OR 1.2.
            scoreDate [1..1] String (Format: date) The date at which the score is assigned or there is an update to the result e.g. change in the 'scoreStatus'. The format is YYYY-MM-DD as defined in [ISO 8601].
            comment [0..1] String A human readable comment about the score.
            learningObjectiveSet [0..*] Array [ Object ] The set of identifiers for the learning objectives to which this result is aligned. Any number groups of learning objectives can be assigned.
                    source [1..1] Union(SourceExtEnum) The source responsible for creating the learning objective identifiers. The permitted values are from an extensible vocabulary.
                    learningObjectiveResults [1..*] Array [ Object ] The set of unique identifiers for the associated learning objectives (these may have alignment with a mastery score). If these are CASE identifiers they MUST be valid UUIDs.
                            learningObjectiveId [1..1] String The unique identifier for the associated learning objective. If this is a CASE identifier it MUST be a valid UUID.
                            score [0..1] Float The optional mastery score supplied as a numeric value.
                            textScore [0..1] String The optional mastery score supplied in a non-numeric form.

An example of the request payload is shown in the code block below.

Code 6.57.1 - JSON payload example for the request message for a "postResultsForLineItem" operation.
    {
        "results" : [
            {
                "sourcedId" : "..String..",
                "status" : "active"|"tobedeleted",
                "dateLastModified" : "..Date/Time..",
                "metadata" : {
                    "..permitted extension point.." : "..user defined value.."
                },
                "lineItem" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "lineItem"
                },
                "student" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "user"
                },
                "class" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "class"
                },
                "scoreScale" : {
                    "href" : "..URI..",
                    "sourcedId" : "..String..",
                    "type" : "scoreScale"
                },
                "scoreStatus" : "..select from Union..",
                "score" : ..Number(Float)..,
                "textScore" : "..NormalizedString..",
                "scoreDate" : "..String(Date)..",
                "comment" : "..String..",
                "learningObjectiveSet" : [
                    {
                        "source" : "..select from Union..",
                        "learningObjectiveResults" : [
                            {
                                "learningObjectiveId" : "..NormalizedString..",
                                "score" : ..Number(Float)..,
                                "textScore" : "..NormalizedString.."
                            },
                            {...},
                            {...}
                        ]
                    },
                    {...},
                    {...}
                ]
            },
            {...},
            {...}
        ]
    }
                        

6.58 "postResultsForLineItem" Response Payloads

6.58.1 Response Payloads for the HTTP Codes (201)

A tabular description of the response payload is shown in the Table below.

Table 6.58.1 - Tabular representation of the JSON payload for "201" response messages for a "postResultsForLineItem" operation.
Property Name Multiplicity JSON Data-type Description
    sourcedIdPairs [0..*] Array [ Object ] The set of sourcedId pairs. The order is not significant as each pair contains the information between the