OneRoster Gradebook Service

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.

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.

Org Name	Date Election Made	Necessary Claims	Type
Anthology Inc.	10th August 2022	No	RF RAND (Required & Optional Elements)
D2L Corporation	21st July 2022	No	RF RAND (Required & Optional Elements)
Gwinnett County Public Schools	22nd July 2022	No	RF RAND (Required & Optional Elements)
Infinite Campus Inc.	25th July 2022	No	RF RAND (Required & Optional Elements)
Microsoft Corporation	8th August 2022	No	RF RAND (Required & Optional Elements)
SameGoal Inc.	21st July 2022	No	RF RAND (Required & Optional Elements)

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 gradebooks in the form of results, lineItems, collections of lineItems (categories) and score-scales. It is also possible to exchange information about assessment activities in the form of assessment lineItems and assessment results. In this document the data exchange is described in an implementation-independent format i.e. using a profile of the Unified Modeling Language (UML). The service description includes the definition of the data formats that are exchanged using a set of service operations.

List of Figures

List of Tables

Table 4.1 The set of interfaces.

Table 4.2 The set of operations for the "AssessmentLineItemsManagement" interface.

Table 4.3 The set of operations for the "AssessmentResultsManagement" interface.

Table 4.4 The set of operations for the "CategoriesManagement" interface.

Table 4.5 The set of operations for the "ClassesManagement" interface.

Table 4.6 The set of operations for the "LineItemsManagement" interface.

Table 4.7 The set of operations for the "ResultsManagement" interface.

Table 4.8 The set of operations for the "SchoolsManagement" interface.

Table 4.9 The set of operations for the "ScoreScalesManagement" interface.

Table 5.1 "AssessmentLineItemSet" Class Description

Table 5.1.1 "assessmentLineItems" Attribute Description

Table 5.2 "AssessmentResultSet" Class Description

Table 5.2.1 "assessmentResults" Attribute Description

Table 5.3 "CategoriesSet" Class Description

Table 5.3.1 "categories" Attribute Description

Table 5.4 "GUID" Class Description

Table 5.5 "GUIDPairSet" Class Description

Table 5.5.1 "sourcedIdPairs" Attribute Description

Table 5.6 "LineItemSet" Class Description

Table 5.6.1 "lineItems" Attribute Description

Table 5.7 "ResultSet" Class Description

Table 5.7.1 "results" Attribute Description

Table 5.8 "ScoreScaleSet" Class Description

Table 5.8.1 "scoreScales" Attribute Description

Table 5.9 "SingleAssessmentLineItem" Class Description

Table 5.9.1 "assessmentLineItem" Attribute Description

Table 5.10 "SingleAssessmentResult" Class Description

Table 5.10.1 "assessmentResult" Attribute Description

Table 5.11 "SingleCategory" Class Description

Table 5.11.1 "category" Attribute Description

Table 5.12 "SingleLineItem" Class Description

Table 5.12.1 "lineItem" Attribute Description

Table 5.13 "SingleResult" Class Description

Table 5.13.1 "result" Attribute Description

Table 5.14 "SingleScoreScale" Class Description

Table 5.14.1 "scoreScale" Attribute Description

Table 5.15 "imsx_StatusInfo" Class Description

Table 5.15.1 "imsx_codeMajor" Attribute Description

Table 5.15.2 "imsx_severity" Attribute Description

Table 5.15.3 "imsx_description" Attribute Description

Table 5.15.4 "imsx_CodeMinor" Attribute Description

Table 6.1.1 AcadSessionGUIDRef class definitions

Table 6.1.1.1 Description of the "type" attribute for the "AcadSessionGUIDRef" class

Table 6.1.2 AssessmentLineItem class definitions

Table 6.1.2.1 Description of the "title" attribute for the "AssessmentLineItem" class

Table 6.1.2.2 Description of the "description" attribute for the "AssessmentLineItem" class

Table 6.1.2.3 Description of the "class" attribute for the "AssessmentLineItem" class

Table 6.1.2.4 Description of the "parentAssessmentLineItem" attribute for the "AssessmentLineItem" class

Table 6.1.2.5 Description of the "scoreScale" attribute for the "AssessmentLineItem" class

Table 6.1.2.6 Description of the "resultValueMin" attribute for the "AssessmentLineItem" class

Table 6.1.2.7 Description of the "resultValueMax" attribute for the "AssessmentLineItem" class

Table 6.1.2.8 Description of the "learningObjectiveSet" attribute for the "AssessmentLineItem" class

Table 6.1.3 AssessmentLineItemGUIDRef class definitions

Table 6.1.3.1 Description of the "type" attribute for the "AssessmentLineItemGUIDRef" class

Table 6.1.4 AssessmentLineItemSet class definitions

Table 6.1.4.1 Description of the "assessmentLineItems" attribute for the "AssessmentLineItemSet" class

Table 6.1.5 AssessmentResult class definitions

Table 6.1.5.1 Description of the "assessmentLineItem" attribute for the "AssessmentResult" class

Table 6.1.5.2 Description of the "student" attribute for the "AssessmentResult" class

Table 6.1.5.3 Description of the "score" attribute for the "AssessmentResult" class

Table 6.1.5.4 Description of the "textScore" attribute for the "AssessmentResult" class

Table 6.1.5.5 Description of the "scoreDate" attribute for the "AssessmentResult" class

Table 6.1.5.6 Description of the "scoreScale" attribute for the "AssessmentResult" class

Table 6.1.5.7 Description of the "scorePercentile" attribute for the "AssessmentResult" class

Table 6.1.5.8 Description of the "scoreStatus" attribute for the "AssessmentResult" class

Table 6.1.5.9 Description of the "comment" attribute for the "AssessmentResult" class

Table 6.1.5.10 Description of the "learningObjectiveSet" attribute for the "AssessmentResult" class

Table 6.1.5.11 Description of the "inProgress" attribute for the "AssessmentResult" class

Table 6.1.5.12 Description of the "incomplete" attribute for the "AssessmentResult" class

Table 6.1.5.13 Description of the "late" attribute for the "AssessmentResult" class

Table 6.1.5.14 Description of the "missing" attribute for the "AssessmentResult" class

Table 6.1.6 AssessmentResultSet class definitions

Table 6.1.6.1 Description of the "assessmentResults" attribute for the "AssessmentResultSet" class

Table 6.1.7 Base class definitions

Table 6.1.7.1 Description of the "sourcedId" attribute for the "Base" class

Table 6.1.7.2 Description of the "status" attribute for the "Base" class

Table 6.1.7.3 Description of the "dateLastModified" attribute for the "Base" class

Table 6.1.7.4 Description of the "metadata" attribute for the "Base" class

Table 6.1.8 CategoriesSet class definitions

Table 6.1.8.1 Description of the "categories" attribute for the "CategoriesSet" class

Table 6.1.9 Category class definitions

Table 6.1.9.1 Description of the "title" attribute for the "Category" class

Table 6.1.9.2 Description of the "weight" attribute for the "Category" class

Table 6.1.10 CategoryGUIDRef class definitions

Table 6.1.10.1 Description of the "type" attribute for the "CategoryGUIDRef" class

Table 6.1.11 ClassGUIDRef class definitions

Table 6.1.11.1 Description of the "type" attribute for the "ClassGUIDRef" class

Table 6.1.12 CourseGUIDRef class definitions

Table 6.1.12.1 Description of the "type" attribute for the "CourseGUIDRef" class

Table 6.1.13 GUIDPair class definitions

Table 6.1.13.1 Description of the "suppliedSourcedId" attribute for the "GUIDPair" class

Table 6.1.13.2 Description of the "allocatedSourcedId" attribute for the "GUIDPair" class

Table 6.1.14 GUIDPairSet class definitions

Table 6.1.14.1 Description of the "sourcedIdPairs" attribute for the "GUIDPairSet" class

Table 6.1.15 GUIDRef class definitions

Table 6.1.15.1 Description of the "href" attribute for the "GUIDRef" class

Table 6.1.15.2 Description of the "sourcedId" attribute for the "GUIDRef" class

Table 6.1.16 LearningObjectiveResults class definitions

Table 6.1.16.1 Description of the "learningObjectiveId" attribute for the "LearningObjectiveResults" class

Table 6.1.16.2 Description of the "score" attribute for the "LearningObjectiveResults" class

Table 6.1.16.3 Description of the "textScore" attribute for the "LearningObjectiveResults" class

Table 6.1.17 LearningObjectiveScoreSet class definitions

Table 6.1.17.1 Description of the "source" attribute for the "LearningObjectiveScoreSet" class

Table 6.1.17.2 Description of the "learningObjectiveResults" attribute for the "LearningObjectiveScoreSet" class

Table 6.1.18 LearningObjectiveSet class definitions

Table 6.1.18.1 Description of the "source" attribute for the "LearningObjectiveSet" class

Table 6.1.18.2 Description of the "learningObjectiveIds" attribute for the "LearningObjectiveSet" class

Table 6.1.19 LineItem class definitions

Table 6.1.19.1 Description of the "title" attribute for the "LineItem" class

Table 6.1.19.2 Description of the "description" attribute for the "LineItem" class

Table 6.1.19.3 Description of the "assignDate" attribute for the "LineItem" class

Table 6.1.19.4 Description of the "dueDate" attribute for the "LineItem" class

Table 6.1.19.5 Description of the "class" attribute for the "LineItem" class

Table 6.1.19.6 Description of the "school" attribute for the "LineItem" class

Table 6.1.19.7 Description of the "category" attribute for the "LineItem" class

Table 6.1.19.8 Description of the "gradingPeriod" attribute for the "LineItem" class

Table 6.1.19.9 Description of the "academicSession" attribute for the "LineItem" class

Table 6.1.19.10 Description of the "scoreScale" attribute for the "LineItem" class

Table 6.1.19.11 Description of the "resultValueMin" attribute for the "LineItem" class

Table 6.1.19.12 Description of the "resultValueMax" attribute for the "LineItem" class

Table 6.1.19.13 Description of the "learningObjectiveSet" attribute for the "LineItem" class

Table 6.1.20 LineItemGUIDRef class definitions

Table 6.1.20.1 Description of the "type" attribute for the "LineItemGUIDRef" class

Table 6.1.21 LineItemSet class definitions

Table 6.1.21.1 Description of the "lineItems" attribute for the "LineItemSet" class

Table 6.1.22 Metadata class definitions

Table 6.1.22.1 Description of the "extensions" attribute for the "Metadata" class

Table 6.1.23 OrgGUIDRef class definitions

Table 6.1.23.1 Description of the "type" attribute for the "OrgGUIDRef" class

Table 6.1.24 Result class definitions

Table 6.1.24.1 Description of the "lineItem" attribute for the "Result" class

Table 6.1.24.2 Description of the "student" attribute for the "Result" class

Table 6.1.24.3 Description of the "class" attribute for the "Result" class

Table 6.1.24.4 Description of the "scoreScale" attribute for the "Result" class

Table 6.1.24.5 Description of the "scoreStatus" attribute for the "Result" class

Table 6.1.24.6 Description of the "score" attribute for the "Result" class

Table 6.1.24.7 Description of the "textScore" attribute for the "Result" class

Table 6.1.24.8 Description of the "scoreDate" attribute for the "Result" class

Table 6.1.24.9 Description of the "comment" attribute for the "Result" class

Table 6.1.24.10 Description of the "learningObjectiveSet" attribute for the "Result" class

Table 6.1.24.11 Description of the "inProgress" attribute for the "Result" class

Table 6.1.24.12 Description of the "incomplete" attribute for the "Result" class

Table 6.1.24.13 Description of the "late" attribute for the "Result" class

Table 6.1.24.14 Description of the "missing" attribute for the "Result" class

Table 6.1.25 ResultSet class definitions

Table 6.1.25.1 Description of the "results" attribute for the "ResultSet" class

Table 6.1.26 ScoreScale class definitions

Table 6.1.26.1 Description of the "title" attribute for the "ScoreScale" class

Table 6.1.26.2 Description of the "type" attribute for the "ScoreScale" class

Table 6.1.26.3 Description of the "course" attribute for the "ScoreScale" class

Table 6.1.26.4 Description of the "class" attribute for the "ScoreScale" class

Table 6.1.26.5 Description of the "scoreScaleValue" attribute for the "ScoreScale" class

Table 6.1.27 ScoreScaleGUIDRef class definitions

Table 6.1.27.1 Description of the "type" attribute for the "ScoreScaleGUIDRef" class

Table 6.1.28 ScoreScaleSet class definitions

Table 6.1.28.1 Description of the "scoreScales" attribute for the "ScoreScaleSet" class

Table 6.1.29 ScoreScaleValue class definitions

Table 6.1.29.1 Description of the "itemValueLHS" attribute for the "ScoreScaleValue" class

Table 6.1.29.2 Description of the "itemValueRHS" attribute for the "ScoreScaleValue" class

Table 6.1.30 SingleAssessmentLineItem class definitions

Table 6.1.30.1 Description of the "assessmentLineItem" attribute for the "SingleAssessmentLineItem" class

Table 6.1.31 SingleAssessmentResult class definitions

Table 6.1.31.1 Description of the "assessmentResult" attribute for the "SingleAssessmentResult" class

Table 6.1.32 SingleCategory class definitions

Table 6.1.32.1 Description of the "category" attribute for the "SingleCategory" class

Table 6.1.33 SingleLineItem class definitions

Table 6.1.33.1 Description of the "lineItem" attribute for the "SingleLineItem" class

Table 6.1.34 SingleResult class definitions

Table 6.1.34.1 Description of the "result" attribute for the "SingleResult" class

Table 6.1.35 SingleScoreScale class definitions

Table 6.1.35.1 Description of the "scoreScale" attribute for the "SingleScoreScale" class

Table 6.1.36 UserGUIDRef class definitions

Table 6.1.36.1 Description of the "type" attribute for the "UserGUIDRef" class

Table 6.1.37 imsx_CodeMinor class definitions

Table 6.1.37.1 Description of the "imsx_codeMinorField" attribute for the "imsx_CodeMinor" class

Table 6.1.38 imsx_CodeMinorField class definitions

Table 6.1.38.1 Description of the "imsx_codeMinorFieldName" attribute for the "imsx_CodeMinorField" class

Table 6.1.38.2 Description of the "imsx_codeMinorFieldValue" attribute for the "imsx_CodeMinorField" class

Table 6.1.39 imsx_StatusInfo class definitions

Table 6.1.39.1 Description of the "imsx_codeMajor" attribute for the "imsx_StatusInfo" class

Table 6.1.39.2 Description of the "imsx_severity" attribute for the "imsx_StatusInfo" class

Table 6.1.39.3 Description of the "imsx_description" attribute for the "imsx_StatusInfo" class

Table 6.1.39.4 Description of the "imsx_CodeMinor" attribute for the "imsx_StatusInfo" class

Table 6.2.1 GUID class definitions

Table 6.2.2 Identifier class definitions

Table 6.2.3 ScoreStatusExtString class definitions

Table 6.2.3.1 Description of the "pattern" attribute for the "ScoreStatusExtString" class

Table 6.2.4 SourceExtensionString class definitions

Table 6.2.4.1 Description of the "pattern" attribute for the "SourceExtensionString" class

Table 6.2.5 UUID class definitions

Table 6.2.5.1 Description of the "pattern" attribute for the "UUID" class

Table 6.3.1 AcadSessionGUIDRefTypeEnum class definitions

Table 6.3.2 AssessmentLineItemGUIDRefTypeEnum class definitions

Table 6.3.3 BaseStatusEnum class definitions

Table 6.3.4 BooleanTrueFalseEnum class definitions

Table 6.3.5 CategoryGUIDRefTypeEnum class definitions

Table 6.3.6 ClassGUIDRefTypeEnum class definitions

Table 6.3.7 CourseGUIDRefTypeEnum class definitions

Table 6.3.8 LineItemGUIDRefTypeEnum class definitions

Table 6.3.9 OrgGUIDRefTypeEnum class definitions

Table 6.3.10 ScoreScaleGUIDRefTypeEnum class definitions

Table 6.3.11 ScoreStatusEnum class definitions

Table 6.3.12 SourceEnum class definitions

Table 6.3.13 UserGUIDRefTypeEnum class definitions

Table 6.3.14 imsx_CodeMajorEnum class definitions

Table 6.3.15 imsx_CodeMinorValueEnum class definitions

Table 6.3.16 imsx_SeverityEnum class definitions

Table 6.4.1 ScoreStatusExtEnum class description

Table 6.4.2 SourceExtEnum class description

Table 7.1 Description of the AcademicSession link data class.

Table 7.2 Description of the AssessmentLineItem link data class.

Table 7.3 Description of the CFItem link data class.

Table 7.4 Description of the Category link data class.

Table 7.5 Description of the Class link data class.

Table 7.6 Description of the Course link data class.

Table 7.7 Description of the LineItem link data class.

Table 7.8 Description of the Org link data class.

Table 7.9 Description of the ScoreScale link data class.

Table 7.10 Description of the User link data class.

Table A3.1 The key to the descriptions of data model diagrams

Table A3.2 The key to the descriptions of the data class tables

Table A3.3 The key to the descriptions of the data attribute/characteristic tables

Table A3.4 The key to the descriptions of the enumerated vocabulary tables

Table A3.5 The key to the descriptions of the external vocabulary tables

Table A3.6 The key to the descriptions of the import class tables

Table A3.7 The key to the descriptions of the link data tables

Table A3.8 The key to the descriptions of the common data model persistent identifier tables

Table B1.1 Interpretation of the CodeMajor/Severity behavior matrix

Table B1.2 Definition of the CodeMajor status code values

Table B1.3 Definition of the Severity status code values

Table B1.4 Definition of the CodeMinor status code field values

1. Introduction

1.1. Scope and Context

This document is the OneRoster Gradebook Service Model v1.2 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 1EdTech Model Driven Specification approach and the associated modelling toolkit [I-BAT, 06]. This means that this specification is based upon the concepts of:

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

1.5. Nomenclature

2. Use-cases

The set of use-cases addressed by the OR Gradebook Service are summarised in Table 2.1.

Table 2.1 - The list of use-cases enabled by this OneRoster service.
ID	Use-case Description
1	To enable a system to obtain information about the set of results for an assignment. To provide the details of the lineItem that have been created for recording the set of results for the assignment as part of a class. It MUST be possible to obtain a specific linteItem, all lineItems and the set of lineItems aligned to a class.
2	To enable a system to obtain information about the set of available scores (contained within a result object). To provide the details of the results that have been collected. It MUST be possible to obtain a specific result, all results and the set of lineItems aligned to a class and/or lineItem and/or a student.
3	To enable a system to obtain information about the set of categories To provide the details of the categories that have been created for aggregating lineItems. It MUST be possible to obtain a specific category all categories.
4	To enable a system to create a lineItem. The specified lineItem is to be created on the target system. The system creating the lineItem MUST supply the sourcedId under which the object is to be created and the target system MAY reject the request if that sourcedId is already allocated.
5	To enable a system to delete a lineItem. The specified lineItem is to be deleted i.e. subsequent attempts to 'read' this object will fail. The originally assigned sourcedId MUST NOT be reassigned. The nature of the deletion is implementation dependent.
6	To enable a system to create a result. The specified result is to be created on the target system. The system creating the lineItem MUST supply the sourcedId under which the object is to be created and the target system MAY reject the request if that sourcedId is already allocated.
7	To enable a system to delete a result. The specified result is to be deleted i.e. subsequent attempts to 'read' this object will fail. The originally assigned sourcedId MUST NOT be reassigned. The nature of the deletion is implementation dependent.
8	To enable a system to create a category. The specified category is to be created on the target system. The system creating the lineItem MUST supply the sourcedId under which the object is to be created and the target system MAY reject the request if that sourcedId is already allocated.
9	To enable a system to delete a category. The specified category is to be deleted i.e. subsequent attempts to 'read' this object will fail. The originally assigned sourcedId MUST NOT be reassigned. The nature of the deletion is implementation dependent.
10	To enable a system to obtain the set of identifiers for the academic standards assigned to a class or a school (added in version 1.2). In this version it is possible to annotate the results and lineItems with the academic standard identifier that addresses the host object (this identifier is a CASE Item UUID [CASE, 17]). This use-case covers obtaining the set of academic standards identifiers (CASE Item UUIDs) for a specific school or class.
11	To enable a system to manage the use of scoreScales (added in version 1.2). This management takes the form of enabling one or all scoreScales to be obtained, obtaining the scoreScales for a specific class or school, the deletion of a specific scoreScale (the originally assigned sourcedId MUST NOT be reassigned and the nature of the deletion is implementation dependent) and the creation of a speciifc scoreScale (the system creating the scoreScale MUST supply the sourcedId under which the object is to be created and the target system MAY reject the request if that sourcedId is already allocated).
12	To enable a system to manage the use of assessment lineItems (added in version 1.2). This management takes the form of enabling one or all assesmentLineItems to be obtained, the deletion of a specific assesmentLineItem (the originally assigned sourcedId MUST NOT be reassigned and the nature of the deletion is implementation dependent) and the creation of a specific assesmentLineItem (the system creating the assessmentLineItem MUST supply the sourcedId under which the object is to be created and the target system MAY reject the request if that sourcedId is already allocated).
13	To enable a system to manage the use of assessment results (added in version 1.2). This management takes the form of enabling one or all assesmentResults to be obtained, the deletion of a specific assesmentResult (the originally assigned sourcedId MUST NOT be reassigned and the nature of the deletion is implementation dependent) and the creation of a specific assesmentResult (the system creating the assessmentResult MUST supply the sourcedId under which the object is to be created and the target system MAY reject the request if that sourcedId is already allocated).
14	To enable a system to create a set of lineItems for a specific school or class (added in version 1.2). This enables a system to create a collection of lineItems on the target system. A set of sourcedIds are supplied by the requesting system but these MUST be replaced by the set of sourcedIds allocated by the target system (the latter MUST be reported back to the requesting system).
15	To enable a system to create a set of results for a specific lineItem or academicSession/class (added in version 1.2). This enables a system to create a collection of results on the target system. A set of sourcedIds are supplied by the requesting system but these MUST be replaced by the set of sourcedIds allocated by the target system (the latter MUST be reported back to the requesting system).

3. Service Architecture and Specification Model

3.1. An Abstract Representation

It is important to remember that this document contains a description of the underlying service model in terms of the abstract Application Programming Interface (API). The manner in which this abstract representation is visualized is not intended to dictate the implementation form of the Service. The breakdown of the service into its interface classes is a convenient way to document the set of behaviors. The objective for producing these interfaces is to identify and define the messages that are exchanged between the end-systems to realize the system behaviors required of the service.

The internal organization of an implementation of the full abstract API is beyond the scope of this specification. The only constraint is that the external behavior of the abstract API complies with this specification. This means that a .NET, J2EE, etc. physical implementation of this abstract API does not have to represent the functionality using the same breakdown of operations/methods. This physical implementation is not subject to the conformance specification.

It is important to note that the UML representation of the interfaces is used to help develop and document the Service Model and various Bindings. It is not a requirement for a system to implement this interface as defined i.e. to use the same parameters, etc. Conformance against this specification will be confirmed by inspecting the appropriate binding of the information model and ensuring that the relevant information is present and that different sequences of activity result in the predicted and mandated behavior. It is essential that the behaviors described by each of the operations are fully supported and that the behaviors described by different sequences are also maintained.

3.2. Service Providers and Service Consumers

The basic architectural model for the OR Gradebook Service specification is shown in Figure 3.1. In this architecture the scope of the OR Gradebook Service specification is shown as the dotted line. The scope of the interoperability is the data and behavioral models of the objects being exchanged.

3.3. Gradebooks and Assessment Results

The Gradebook Service enables the exchange of gradebooks. A schematic representation of a gradebook is shown in Figure 3.2.

3.3.1. Assessment Results

In this latest version, the Gradebook Service has been extended to support the exchange of detailed assessment results. A schematic representation of the structure for assessment results is shown in Figure 3.3.

3.4. Service Objects

The set of single objects that can be exchanged between OR Gradebook end-systems are:

The set of collection objects that can be exchanged between OR Gradebook end-systems are:

The relationships between the core classes in OR Gradebook are shown in Figure 3.4.

3.5. Synchronous and Asynchronous Services

The OR Gradebook Service is a synchronous service i.e. the initiator is blocked until the response from the respondent is received. This means that an initiator can only have one outstanding request with a service provider. The OR Gradebook Service is available as either a 'Pull' or 'Push' service. The corresponding sequence of actions for the 'Pull' and 'Push' services are shown in Figure 3.5 and 3.6 respectively.

3.6. OneRoster Rostering and Gradebook Choreography

The Gradebook Service has several dependencies on the data models supported in the Rostering Service e.g. Classes, Schools, etc. These interactions make use of the corresponding 'sourcedId' of the object. Therefore, any system that supports the Gradebook Service should also support the appropriate parts of the Rostering Service (this may require the system to be certified as OR 1.2 Roster Service compliant).

4. The Behavior Model

4.1 Service Definition

Table 4.1 The set of interfaces.
Interface	Description
AssessmentLineItemsManagement	This enables the management of the assessment lineItems i.e. lineitems that are used to store results about tests/assessments and where these test/assessments are not aligned to a class.
AssessmentResultsManagement	This enables the management of the assessment results i.e. results that are used to store scores for tests/assessments and where these test/assessments are not aligned to a class.
CategoriesManagement	This enables the management of Categories i.e. collections of LineItems.
ClassesManagement	This enables the management of Classes i.e. scheduled learning of courses, with respect to scoreScales. For this service this is the collection of operations that provide gradebook data in the context of a class identifier.
LineItemsManagement	This enables the management of lineItems i.e. the set of results for the assessment of some activity.
ResultsManagement	This enables the management of results i.e. the score allocated to a learner from the assessent of a learning activity. Results are collected as a set of 'lineItems'.
SchoolsManagement	This enables the management of information about schools with respect to scoreScales. A school is a type of 'org'. For this service this is the collection of operations that provide gradebook data in the context of a school identifier.
ScoreScalesManagement	This enables the management of scoreScales i.e. the set of scales for the results and lineItems.

4.2 AssessmentLineItemsManagement Interface Description

Table 4.2 The set of operations for the "AssessmentLineItemsManagement" interface.
Operation	Description
getAllAssessmentLineItems	Get all of the Assessment Line Items on the service provider.
getAssessmentLineItem	Get a specific Assessment LineItem on the service provider. If the corresponding record cannot be located then an 'unknown' error code is returned.
deleteAssessmentLineItem	Delete a specific Assessment LineItem on the service provider. If the corresponding record cannot be located then an 'unknown' error code is returned.
putAssessmentLineItem	To create a new Assessment LineItem. The associated sourcedId for this new record is supplied by the requesting system.

4.2.1 "getAllAssessmentLineItems" Operation

4.2.2 "getAssessmentLineItem" Operation

4.2.3 "deleteAssessmentLineItem" Operation

4.2.4 "putAssessmentLineItem" Operation

4.3 AssessmentResultsManagement Interface Description

Table 4.3 The set of operations for the "AssessmentResultsManagement" interface.
Operation	Description
getAllAssessmentResults	Get all of the Assessment Results on the service provider.
getAssessmentResult	Get a specific Assessment Result on the service provider. If the corresponding record cannot be located then an 'unknown' error code is returned.
deleteAssessmentResult	Delete a specific Assessment Result on the service provider. If the corresponding record cannot be located then an 'unknown' error code is returned.
putAssessmentResult	To create a new Assessment Result. The associated sourcedId for this new record is supplied by the requesting system.

4.3.1 "getAllAssessmentResults" Operation

4.3.2 "getAssessmentResult" Operation

4.3.3 "deleteAssessmentResult" Operation

4.3.4 "putAssessmentResult" Operation

4.4 CategoriesManagement Interface Description

Table 4.4 The set of operations for the "CategoriesManagement" interface.
Operation	Description
getAllCategories	Get all of the lineItem categories on the service provider.
getCategory	Get a specific lineItem category on the service provider. If the corresponding record cannot be located then an 'unknown' error code is returned.
deleteCategory	Delete a specific lineItem category on the service provider. If the corresponding record cannot be located then an 'unknown' error code is returned.
putCategory	To create a new lineItem category. The associated sourcedId for this new record is supplied by the requesting system.

4.4.1 "getAllCategories" Operation

4.4.2 "getCategory" Operation

4.4.3 "deleteCategory" Operation

4.4.4 "putCategory" Operation

4.5 ClassesManagement Interface Description

Table 4.5 The set of operations for the "ClassesManagement" interface.
Operation	Description
getResultsForClass	Get the set of results on the service provider for a specific class. If the corresponding class cannot be located then an 'unknown' error code is returned.
getLineItemsForClass	Get the set of lineItems on the service provider for a specific class. If the corresponding class cannot be located then an 'unknown' error code is returned.
getResultsForLineItemForClass	Get the set of results on the service provider for a specific lineItem and for a specific class. If the corresponding class cannot be located then an 'unknown' error code is returned.
getResultsForStudentForClass	Get the set of results on the service provider for a specific student and for a specific class. If the corresponding class cannot be located then an 'unknown' error code is returned.
getCategoriesForClass	Get the set of categories on the service provider for a specific class. If the corresponding class cannot be located then an 'unknown' error code is returned.
getScoreScalesForClass	Get the set of scoreScales on the service provider for a specific class. If the corresponding class cannot be located then an 'unknown' error code is returned.
postResultsForAcademicSessionForClass	To create a set of results for a specific academic session and specific class. The responding system must return the set of sourcedIds that have been allocated to the newly created result records. If the corresponding class or academic session cannot be located then an 'unknown' error code is returned.
postLineItemsForClass	To create a set of lineItems for a specific class. The responding system must return the set of sourcedIds that have been allocated to the newly created lineItem records. If the corresponding class cannot be located then an 'unknown' error code is returned.

4.5.1 "getResultsForClass" Operation

4.5.2 "getLineItemsForClass" Operation

4.5.3 "getResultsForLineItemForClass" Operation

4.5.4 "getResultsForStudentForClass" Operation

4.5.5 "getCategoriesForClass" Operation

4.5.6 "getScoreScalesForClass" Operation

4.5.7 "postResultsForAcademicSessionForClass" Operation

4.5.8 "postLineItemsForClass" Operation

4.6 LineItemsManagement Interface Description

Table 4.6 The set of operations for the "LineItemsManagement" interface.
Operation	Description
getAllLineItems	Get all of the Line Items on the service provider.
getLineItem	Get a specific LineItem on the service provider. If the corresponding record cannot be located then an 'unknown' error code is returned.
deleteLineItem	Delete a specific lineItem on the service provider. If the corresponding record cannot be located then an 'unknown' error code is returned.
putLineItem	To create a new lineItem. The associated sourcedId for this new record is supplied by the requesting system.
postResultsForLineItem	To create a set of results for a specific lineItem. The responding system must return the set of sourcedIds that have been allocated to the newly created result records.

4.6.1 "getAllLineItems" Operation

4.6.2 "getLineItem" Operation

4.6.3 "deleteLineItem" Operation

4.6.4 "putLineItem" Operation

4.6.5 "postResultsForLineItem" Operation

4.7 ResultsManagement Interface Description

Table 4.7 The set of operations for the "ResultsManagement" interface.
Operation	Description
getAllResults	Get all of the results on the service provider.
getResult	Get a specific result on the service provider. If the corresponding record cannot be located then an 'unknown' error code is returned.
deleteResult	Delete a specific result on the service provider. If the corresponding record cannot be located then an 'unknown' error code is returned.
putResult	To create a new result. The associated sourcedId for this new record is supplied by the requesting system.

4.7.1 "getAllResults" Operation

4.7.2 "getResult" Operation

4.7.3 "deleteResult" Operation

4.7.4 "putResult" Operation

4.8 SchoolsManagement Interface Description

Table 4.8 The set of operations for the "SchoolsManagement" interface.
Operation	Description
getScoreScalesForSchool	Get the set of scoreScales on the service provider for a specific school. If the corresponding school cannot be located then an 'unknown' error code is returned.
postLineItemsForSchool	To create a set of lineItems for a specific school. The responding system must return the set of sourcedIds that have been allocated to the newly created lineItem records.

4.8.1 "getScoreScalesForSchool" Operation

4.8.2 "postLineItemsForSchool" Operation

4.9 ScoreScalesManagement Interface Description

Table 4.9 The set of operations for the "ScoreScalesManagement" interface.
Operation	Description
getAllScoreScales	Get all of the ScoreScales on the service provider.
getScoreScale	Get a specific scoreScale on the service provider. If the corresponding record cannot be located then an 'unknown' error code is returned.
deleteScoreScale	Delete a specific scoreScale on the service provider. If the corresponding record cannot be located then an 'unknown' error code is returned.
putScoreScale	To create a new scoreScale. The associated sourcedId for this new record is supplied by the requesting system.

4.9.1 "getAllScoreScales" Operation

4.9.2 "getScoreScale" Operation

4.9.3 "deleteScoreScale" Operation

4.9.4 "putScoreScale" Operation

5. The Interface Data Model

5.1 AssessmentLineItemSet Class Description

Table 5.1 Description of the "AssessmentLineItemSet" class.
Descriptor	Definition
Class Name	AssessmentLineItemSet
Class Type	Container [ Sequence ]
Parents	Service parameter data-type used in the following operations: getAllAssessmentLineItems
Characteristics	There are no characteristics.
Children	The set of children attributes are: assessmentLineItems
Description	This is the container for a collection of assessment lineItem instances for a message payload. This may be empty if no instances are found that sustain the applied query constraints. The order is not significant.

5.1.1 "assessmentLineItems" Attribute Description

5.2 AssessmentResultSet Class Description

5.2.1 "assessmentResults" Attribute Description

5.3 CategoriesSet Class Description

5.3.1 "categories" Attribute Description

5.4 GUID Class Description

5.5 GUIDPairSet Class Description

5.5.1 "sourcedIdPairs" Attribute Description

5.6 LineItemSet Class Description

5.6.1 "lineItems" Attribute Description

5.7 ResultSet Class Description

5.7.1 "results" Attribute Description

5.8 ScoreScaleSet Class Description

5.8.1 "scoreScales" Attribute Description

5.9 SingleAssessmentLineItem Class Description

5.9.1 "assessmentLineItem" Attribute Description

5.10 SingleAssessmentResult Class Description

5.10.1 "assessmentResult" Attribute Description

5.11 SingleCategory Class Description

5.11.1 "category" Attribute Description

5.12 SingleLineItem Class Description

5.12.1 "lineItem" Attribute Description

5.13 SingleResult Class Description

5.13.1 "result" Attribute Description

5.14 SingleScoreScale Class Description

5.14.1 "scoreScale" Attribute Description

5.15 imsx_StatusInfo Class Description

5.15.1 "imsx_codeMajor" Attribute Description

5.15.2 "imsx_severity" Attribute Description

5.15.3 "imsx_description" Attribute Description

5.15.4 "imsx_CodeMinor" Attribute Description

6. The Data Model

6.1. Data Class Descriptions

All of the data classes used within this Information Model are described in this Section. The syntax and semantics for this representation is described in Appendix A3.2.

6.1.1 AcadSessionGUIDRef Class Description

6.1.1.1 "type" Attribute Description

6.1.2 AssessmentLineItem Class Description

6.1.2.1 "title" Attribute Description

6.1.2.2 "description" Attribute Description

6.1.2.3 "class" Attribute Description

6.1.2.4 "parentAssessmentLineItem" Attribute Description

6.1.2.5 "scoreScale" Attribute Description

6.1.2.6 "resultValueMin" Attribute Description

6.1.2.7 "resultValueMax" Attribute Description

6.1.2.8 "learningObjectiveSet" Attribute Description

6.1.3 AssessmentLineItemGUIDRef Class Description

6.1.3.1 "type" Attribute Description

6.1.4 AssessmentLineItemSet Class Description

6.1.4.1 "assessmentLineItems" Attribute Description

6.1.5 AssessmentResult Class Description

6.1.5.1 "assessmentLineItem" Attribute Description

6.1.5.2 "student" Attribute Description

6.1.5.3 "score" Attribute Description

6.1.5.4 "textScore" Attribute Description

6.1.5.5 "scoreDate" Attribute Description

6.1.5.6 "scoreScale" Attribute Description

6.1.5.7 "scorePercentile" Attribute Description

6.1.5.8 "scoreStatus" Attribute Description

6.1.5.9 "comment" Attribute Description

6.1.5.10 "learningObjectiveSet" Attribute Description

6.1.5.11 "inProgress" Attribute Description

6.1.5.12 "incomplete" Attribute Description

6.1.5.13 "late" Attribute Description

6.1.5.14 "missing" Attribute Description

6.1.6 AssessmentResultSet Class Description

6.1.6.1 "assessmentResults" Attribute Description

6.1.7 Base Class Description

6.1.7.1 "sourcedId" Attribute Description

6.1.7.2 "status" Attribute Description

6.1.7.3 "dateLastModified" Attribute Description

6.1.7.4 "metadata" Attribute Description

6.1.8 CategoriesSet Class Description

6.1.8.1 "categories" Attribute Description

6.1.9 Category Class Description

6.1.9.1 "title" Attribute Description

6.1.9.2 "weight" Attribute Description

6.1.10 CategoryGUIDRef Class Description

6.1.10.1 "type" Attribute Description

6.1.11 ClassGUIDRef Class Description

6.1.11.1 "type" Attribute Description

6.1.12 CourseGUIDRef Class Description

6.1.12.1 "type" Attribute Description

6.1.13 GUIDPair Class Description

6.1.13.1 "suppliedSourcedId" Attribute Description

6.1.13.2 "allocatedSourcedId" Attribute Description

6.1.14 GUIDPairSet Class Description

6.1.14.1 "sourcedIdPairs" Attribute Description

6.1.15 GUIDRef Class Description

6.1.15.1 "href" Attribute Description

6.1.15.2 "sourcedId" Attribute Description

6.1.16 LearningObjectiveResults Class Description

6.1.16.1 "learningObjectiveId" Attribute Description

6.1.16.2 "score" Attribute Description

6.1.16.3 "textScore" Attribute Description

6.1.17 LearningObjectiveScoreSet Class Description

6.1.17.1 "source" Attribute Description

6.1.17.2 "learningObjectiveResults" Attribute Description

6.1.18 LearningObjectiveSet Class Description

6.1.18.1 "source" Attribute Description

6.1.18.2 "learningObjectiveIds" Attribute Description

6.1.19 LineItem Class Description

6.1.19.1 "title" Attribute Description

6.1.19.2 "description" Attribute Description

6.1.19.3 "assignDate" Attribute Description

6.1.19.4 "dueDate" Attribute Description

6.1.19.5 "class" Attribute Description

6.1.19.6 "school" Attribute Description

6.1.19.7 "category" Attribute Description

6.1.19.8 "gradingPeriod" Attribute Description

6.1.19.9 "academicSession" Attribute Description

6.1.19.10 "scoreScale" Attribute Description

6.1.19.11 "resultValueMin" Attribute Description

6.1.19.12 "resultValueMax" Attribute Description

6.1.19.13 "learningObjectiveSet" Attribute Description

6.1.20 LineItemGUIDRef Class Description

6.1.20.1 "type" Attribute Description

6.1.21 LineItemSet Class Description

6.1.21.1 "lineItems" Attribute Description

6.1.22 Metadata Class Description

6.1.22.1 "extensions" Attribute Description

6.1.23 OrgGUIDRef Class Description

6.1.23.1 "type" Attribute Description

6.1.24 Result Class Description

6.1.24.1 "lineItem" Attribute Description

6.1.24.2 "student" Attribute Description

6.1.24.3 "class" Attribute Description

6.1.24.4 "scoreScale" Attribute Description

6.1.24.5 "scoreStatus" Attribute Description

6.1.24.6 "score" Attribute Description

6.1.24.7 "textScore" Attribute Description

6.1.24.8 "scoreDate" Attribute Description

6.1.24.9 "comment" Attribute Description

6.1.24.10 "learningObjectiveSet" Attribute Description

6.1.24.11 "inProgress" Attribute Description

6.1.24.12 "incomplete" Attribute Description

6.1.24.13 "late" Attribute Description

6.1.24.14 "missing" Attribute Description

6.1.25 ResultSet Class Description

6.1.25.1 "results" Attribute Description

6.1.26 ScoreScale Class Description

6.1.26.1 "title" Attribute Description

6.1.26.2 "type" Attribute Description

6.1.26.3 "course" Attribute Description

6.1.26.4 "class" Attribute Description

6.1.26.5 "scoreScaleValue" Attribute Description

6.1.27 ScoreScaleGUIDRef Class Description

6.1.27.1 "type" Attribute Description

6.1.28 ScoreScaleSet Class Description

6.1.28.1 "scoreScales" Attribute Description

6.1.29 ScoreScaleValue Class Description

6.1.29.1 "itemValueLHS" Attribute Description

6.1.29.2 "itemValueRHS" Attribute Description

6.1.30 SingleAssessmentLineItem Class Description

6.1.30.1 "assessmentLineItem" Attribute Description

6.1.31 SingleAssessmentResult Class Description

6.1.31.1 "assessmentResult" Attribute Description

6.1.32 SingleCategory Class Description

6.1.32.1 "category" Attribute Description

6.1.33 SingleLineItem Class Description

6.1.33.1 "lineItem" Attribute Description

6.1.34 SingleResult Class Description

6.1.34.1 "result" Attribute Description

6.1.35 SingleScoreScale Class Description

6.1.35.1 "scoreScale" Attribute Description

6.1.36 UserGUIDRef Class Description

6.1.36.1 "type" Attribute Description

6.1.37 imsx_CodeMinor Class Description

6.1.37.1 "imsx_codeMinorField" Attribute Description

6.1.38 imsx_CodeMinorField Class Description

6.1.38.1 "imsx_codeMinorFieldName" Attribute Description

6.1.38.2 "imsx_codeMinorFieldValue" Attribute Description

6.1.39 imsx_StatusInfo Class Description

6.1.39.1 "imsx_codeMajor" Attribute Description

6.1.39.2 "imsx_severity" Attribute Description

6.1.39.3 "imsx_description" Attribute Description

6.1.39.4 "imsx_CodeMinor" Attribute Description

6.2. Derived Class Descriptions

All of the derived data classes used within this Information Model are described in this Section. The syntax and semantics for this representation is described in Appendix A3.2.

6.2.1 GUID Class Description

6.2.2 Identifier Class Description

6.2.3 ScoreStatusExtString Class Description

6.2.3.1 "pattern" Attribute Description

6.2.4 SourceExtensionString Class Description

6.2.4.1 "pattern" Attribute Description

6.2.5 UUID Class Description

6.2.5.1 "pattern" Attribute Description

6.3. Enumerated Vocabulary Descriptions

All of the enumerated vocabularies used within this Information Model are described in this Section. The syntax and semantics for this representation is described in Appendix A3.4.

6.3.1 AcadSessionGUIDRefTypeEnum Vocabulary Description

6.3.2 AssessmentLineItemGUIDRefTypeEnum Vocabulary Description

6.3.3 BaseStatusEnum Vocabulary Description

6.3.4 BooleanTrueFalseEnum Vocabulary Description

6.3.5 CategoryGUIDRefTypeEnum Vocabulary Description

6.3.6 ClassGUIDRefTypeEnum Vocabulary Description

6.3.7 CourseGUIDRefTypeEnum Vocabulary Description

6.3.8 LineItemGUIDRefTypeEnum Vocabulary Description

6.3.9 OrgGUIDRefTypeEnum Vocabulary Description

6.3.10 ScoreScaleGUIDRefTypeEnum Vocabulary Description

6.3.11 ScoreStatusEnum Vocabulary Description

6.3.12 SourceEnum Vocabulary Description

6.3.13 UserGUIDRefTypeEnum Vocabulary Description

6.3.14 imsx_CodeMajorEnum Vocabulary Description

6.3.15 imsx_CodeMinorValueEnum Vocabulary Description

6.3.16 imsx_SeverityEnum Vocabulary Description

6.4. Union Class Descriptions

6.4.1 ScoreStatusExtEnum Class Description

6.4.2 SourceExtEnum Class Description

7. Link Data Definitions

7.1 AcademicSession Link Data Description

7.2 AssessmentLineItem Link Data Description

7.3 CFItem Link Data Description

7.4 Category Link Data Description

7.5 Class Link Data Description

7.6 Course Link Data Description

7.7 LineItem Link Data Description

7.8 Org Link Data Description

7.9 ScoreScale Link Data Description

7.10 User Link Data Description

8. Extending and Profiling the Service

8.1. Extending the Specification

It is NOT permitted to change the behavior of the current set of operations. Such changes MUST be supported by the creation of new operations.

8.1.1. Proprietary Operations

The definition of new operations should follow the same format as adopted herein. The new operations should be defined using a new interface type. Every operation must result in the return of a status code that describes the final state of the request on the target end system.

An example of creating such an extension is given in the accompanying Best Practices document [OR-IMPL-12].

8.1.2. Proprietary Data Elements

It is recognized that implementers may wish to extend the specification. The preferred mechanism for doing this is for implementers to use an extension space within the OneRoster data model, and then set their parsers to read those extension attributes. Extensions are ONLY permitted using the 'metadata' attribute within the 'Base' class (see Sub-section 6.1.2 for more details).

8.1.3. Proprietary Vocabulary Terms

In this version the ability to extend some of the enumerated vocabularies has been added: currently, ONLY the 'ScoreStatusEnum' and 'SourceEnum' vocabularies MAY be extended. Each proprietary term must start with the characters 'ext:'.

8.2. Profiling the Specification

Valid Profiles must be restrictive i.e. optional features can be removed or constraints increased but new features must not be added. A Profile of this service is made by annotating the UML supplied with the documentation for the specification.

It is strongly recommended that a profile of this specification is undertaken either by, or with the close support, of 1EdTech. However, no matter who is responsible for creating the profile artefacts (documents, OpenAPI files, XSDs, etc.), it is strongly recommended that the 1EdTech specification tools are used. This will ensure that the artefacts are consistent with the base specifications and that useful support documentation is automatically produced e.g. creation of a document that summarises the differences between the base specification and the profile. Organizations wishing to produce a profile of this specification should contact the 1EdTech VP of Operations at: operations@1edtech.org.

References

Appendix A Modelling Concepts and Terms

A1 Behavior Descriptions Explanations

A1.1 Service Model Diagrams

A1.2 Operation Descriptions

A2 InterfaceDescriptions Explanations

A2.1 Parameter Model Diagrams

A2.2 Class Descriptions

A2.3 Attribute Descriptions

A3 Data Model Descriptions Explanantions

A3.1 Data Model Diagrams

A3.2 Class Descriptions

A3.3 Attribute and Characteristic Descriptions

Table A3.3 provides the key to the descriptions of the data attributes/characteristics for the data classes.

A3.4 Enumerated Vocabulary Descriptions

Table A3.4 provides the key to the descriptions of the enumerated vocabulary classes. These are vocabularies that will be contained within the binding form itself. They are contained within a class that has a stereotype of either « Enumeration » or « EnumeratedList ».

A3.5 External Vocabulary Descriptions

Table A3.5 provides the key to the descriptions of the external vocabulary classes. These are vocabularies that will be contained in some independent format e.g. using the IMS VDEX [VDEX, 04].

A3.6 Import Class Descriptions

A3.7 Link Data Descriptions

A3.8 Common Data Model Persistent Identifier Descriptions

Table A3.8 provides the key to the descriptions of the common data model persistent identifier definitions.

Appendix B Service Status Codes

B1 Definition of the Status Codes

The interpretation of the "CodeMajor/Severity" behavior matrix is summarized in Table B1.1.

B1.1 Definition of the "CodeMajor" Values

B1.2 Definition of the "Severity" Values

B1.3 Definition of the "CodeMinor" Values

About this Document

List of Contributors

Revision History

IMS Global Learning Consortium, Inc. ("IMS Global") is publishing the information contained in this document ("Specification") for purposes of scientific, experimental, and scholarly collaboration only.

IMS Global makes no warranty or representation regarding the accuracy or completeness of the Specification.

The Specification is at all times subject to change and revision without notice.

It is your sole responsibility to evaluate the usefulness, accuracy, and completeness of the Specification as it relates to you.

Date Issued:	19th September 2022
Latest version:	http://www.imsglobal.org/activity/onerosterlis/

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

Name:	getAllAssessmentLineItems ()
Return Function Parameter:	imsx_StatusInfo : imsx_StatusInfo - the status information report for the request. This report has end-to-end significance and must map between the messaging technology approach and the business transaction API. For REST-based bindings this structure describes the message payload that must be returned when the request has not been successfully completed.
Supplied (in) Parameters:	None.
Returned (out) Parameters:	assessmentLineItems : AssessmentLineItemSet - the set of assessment lineItems that have been read from the service provider.
Behavior:	Get all of the Assessment Line Items on the service provider.
Notes:	Query Parameters for the REST-based binding have been defined for this operation, namely: limit - to define the download segmentation value i.e. the maximum number of records to be contained in the response. offset - the number of the first record to be supplied in the segmented response message. sort - 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. orderBy - 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. filter - the filtering rules to be applied when identifying the records to be supplied in the response message. fields - to identify the range of fields that should be supplied in the response message.

Name:	getAssessmentLineItem ()
Return Function Parameter:	imsx_StatusInfo : imsx_StatusInfo - the status information report for the request. This report has end-to-end significance and must map between the messaging technology approach and the business transaction API. For REST-based bindings this structure describes the message payload that must be returned when the request has not been successfully completed.
Supplied (in) Parameters:	sourcedId : GUID - the unique identifier, GUID, for this assessment lineItem.
Returned (out) Parameters:	assessmentLineItem : SingleAssessmentLineItem - the assessment lineItem that has been read from the service provider.
Behavior:	Get a specific Assessment LineItem on the service provider. If the corresponding record cannot be located then an 'unknown' error code is returned.
Notes:	Query Parameters for the REST-based binding have been defined for this operation, namely: fields - to identify the range of fields that should be supplied in the response message.

Name:	deleteAssessmentLineItem ()
Return Function Parameter:	imsx_StatusInfo : imsx_StatusInfo - the status information report for the request. This report has end-to-end significance and must map between the messaging technology approach and the business transaction API. For REST-based bindings this structure describes the message payload that must be returned when the request has not been successfully completed.
Supplied (in) Parameters:	sourcedId : GUID - the unique identifier, GUID, for the assessment lineItem to be deleted.
Returned (out) Parameters:	None.
Behavior:	Delete a specific Assessment LineItem on the service provider. If the corresponding record cannot be located then an 'unknown' error code is returned.

2. Use-cases	The set of gradebook use-cases that are a supported by this service. Only a one-line summary of each use-case is provided;
3. Service Architecture and Specification Model	An overview of the service including the key use-cases and the underlying service architecture and end-system service objects;
4. The Behavior Model	The definition of the operations of the service. This focuses on the description of the behaviors supported by the service. The behaviors are grouped as interfaces;
5. The Interface Data Model	The definition of the data models exchanged between the service End Systems. These are the parameters exchanged across the interoperability interface. These are an abbreviated description with the full set of details in the corresponding data class description;
6. The Data Model	The definition of the data classes for the full data exchange. This addresses the data classes used to supplement the interface parameters. The descriptions are grouped according to their type e.g. data, enumeration, derived, etc.
7. Link Data Definitions	The set of descriptions for the link data definitions that are used to establish the intra- and inter- specification relationships;
8. Extending and Profiling the Service	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 Modelling Concepts and Terms	An overview of the model driven approach, the concepts and the terms used by IMS to create the service model representations (based upon a profile of UML), the corresponding set of bindings and the accompanying documentation (including this information model);
Appendix B Service Status Codes	A summary list of the status codes, and their causes, that can be returned by each of the operations forming the service. These describe the end-to-end status of the transaction.

Name:	putAssessmentLineItem ()
Return Function Parameter:	imsx_StatusInfo : imsx_StatusInfo - the status information report for the request. This report has end-to-end significance and must map between the messaging technology approach and the business transaction API. For REST-based bindings this structure describes the message payload that must be returned when the request has not been successfully completed.
Supplied (in) Parameters:	sourcedId : GUID - the unique identifier, GUID, to be allocated to this new assessment lineItem. assessmentLineItem : SingleAssessmentLineItem - the assessment lineItem data that is to be stored.
Returned (out) Parameters:	None.
Behavior:	To create a new Assessment LineItem. The associated sourcedId for this new record is supplied by the requesting system.

Name:	getAllAssessmentResults ()
Return Function Parameter:	imsx_StatusInfo : imsx_StatusInfo - the status information report for the request. This report has end-to-end significance and must map between the messaging technology approach and the business transaction API. For REST-based bindings this structure describes the message payload that must be returned when the request has not been successfully completed.
Supplied (in) Parameters:	None.
Returned (out) Parameters:	assessmentResults : AssessmentResultSet - the set of assessment results that have been read from the service provider.
Behavior:	Get all of the Assessment Results on the service provider.
Notes:	Query Parameters for the REST-based binding have been defined for this operation, namely: limit - to define the download segmentation value i.e. the maximum number of records to be contained in the response. offset - the number of the first record to be supplied in the segmented response message. sort - 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. orderBy - 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. filter - the filtering rules to be applied when identifying the records to be supplied in the response message. fields - to identify the range of fields that should be supplied in the response message.

Name:	getAssessmentResult ()
Return Function Parameter:	imsx_StatusInfo : imsx_StatusInfo - the status information report for the request. This report has end-to-end significance and must map between the messaging technology approach and the business transaction API. For REST-based bindings this structure describes the message payload that must be returned when the request has not been successfully completed.
Supplied (in) Parameters:	sourcedId : GUID - tthe unique identifier, GUID, for this assessment result.
Returned (out) Parameters:	assessmentResult : SingleAssessmentResult - the assessment result that has been read from the service provider.
Behavior:	Get a specific Assessment Result on the service provider. If the corresponding record cannot be located then an 'unknown' error code is returned.
Notes:	Query Parameters for the REST-based binding have been defined for this operation, namely: fields - to identify the range of fields that should be supplied in the response message.

Name:	deleteAssessmentResult ()
Return Function Parameter:	imsx_StatusInfo : imsx_StatusInfo - the status information report for the request. This report has end-to-end significance and must map between the messaging technology approach and the business transaction API. For REST-based bindings this structure describes the message payload that must be returned when the request has not been successfully completed.
Supplied (in) Parameters:	sourcedId : GUID - the unique identifier, GUID, for the assessment result to be deleted.
Returned (out) Parameters:	None.
Behavior:	Delete a specific Assessment Result on the service provider. If the corresponding record cannot be located then an 'unknown' error code is returned.

Name:	putAssessmentResult ()
Return Function Parameter:	imsx_StatusInfo : imsx_StatusInfo - the status information report for the request. This report has end-to-end significance and must map between the messaging technology approach and the business transaction API. For REST-based bindings this structure describes the message payload that must be returned when the request has not been successfully completed.
Supplied (in) Parameters:	sourcedId : GUID - the unique identifier, GUID, to be allocated to this new assessment result. assessmentResult : SingleAssessmentResult - the assessment result data that is to be stored.
Returned (out) Parameters:	None.
Behavior:	To create a new Assessment Result. The associated sourcedId for this new record is supplied by the requesting system.

Name:	getAllCategories ()
Return Function Parameter:	statusInfo : imsx_StatusInfo - the status information report for the request. This report has end-to-end significance and must map between the messaging technology approach and the business transaction API. For REST-based bindings this structure describes the message payload that must be returned when the request has not been successfully completed.
Supplied (in) Parameters:	None.
Returned (out) Parameters:	categories : CategoriesSet - the set of categories that have been read from the service provider.
Behavior:	Get all of the lineItem categories on the service provider.
Notes:	Query Parameters for the REST-based binding have been defined for this operation, namely: limit - to define the download segmentation value i.e. the maximum number of records to be contained in the response. offset - the number of the first record to be supplied in the segmented response message. sort - 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. orderBy - 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. filter - the filtering rules to be applied when identifying the records to be supplied in the response message. fields - to identify the range of fields that should be supplied in the response message.

Name:	getCategory ()
Return Function Parameter:	statusInfo : imsx_StatusInfo - the status information report for the request. This report has end-to-end significance and must map between the messaging technology approach and the business transaction API. For REST-based bindings this structure describes the message payload that must be returned when the request has not been successfully completed.
Supplied (in) Parameters:	sourcedId : GUID - the unique identifier, GUID, for this category.
Returned (out) Parameters:	category : SingleCategory - the category that has been read from the service provider.
Behavior:	Get a specific lineItem category on the service provider. If the corresponding record cannot be located then an 'unknown' error code is returned.
Notes:	Query Parameters for the REST-based binding have been defined for this operation, namely: fields - to identify the range of fields that should be supplied in the response message.

Name:	deleteCategory ()
Return Function Parameter:	statusInfo : imsx_StatusInfo - the status information report for the request. This report has end-to-end significance and must map between the messaging technology approach and the business transaction API. For REST-based bindings this structure describes the message payload that must be returned when the request has not been successfully completed.
Supplied (in) Parameters:	sourcedId : GUID - the unique identifier, GUID, for the category to be deleted.
Returned (out) Parameters:	None.
Behavior:	Delete a specific lineItem category on the service provider. If the corresponding record cannot be located then an 'unknown' error code is returned.

Name:	putCategory ()
Return Function Parameter:	statusInfo : imsx_StatusInfo - the status information report for the request. This report has end-to-end significance and must map between the messaging technology approach and the business transaction API. For REST-based bindings this structure describes the message payload that must be returned when the request has not been successfully completed.
Supplied (in) Parameters:	sourcedId : GUID - the unique identifier, GUID, to be allocated to this new category. category : SingleCategory - the category data that is to be stored.
Returned (out) Parameters:	None.
Behavior:	To create a new lineItem category. The associated sourcedId for this new record is supplied by the requesting system.

Name:	getResultsForClass ()
Return Function Parameter:	statusInfo : imsx_StatusInfo - the status information report for the request. This report has end-to-end significance and must map between the messaging technology approach and the business transaction API. For REST-based bindings this structure describes the message payload that must be returned when the request has not been successfully completed.
Supplied (in) Parameters:	classSourcedId : GUID - the unique identifier, GUID, for the class.
Returned (out) Parameters:	results : ResultSet - the set of results for the specified class. This payload may be empty if there are no records that conform to any of the selection constraints.
Behavior:	Get the set of results on the service provider for a specific class. If the corresponding class cannot be located then an 'unknown' error code is returned.
Notes:	Query Parameters for the REST-based binding have been defined for this operation, namely: limit - to define the download segmentation value i.e. the maximum number of records to be contained in the response. offset - the number of the first record to be supplied in the segmented response message. sort - 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. orderBy - 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. filter - the filtering rules to be applied when identifying the records to be supplied in the response message. fields - to identify the range of fields that should be supplied in the response message.

Name:	getLineItemsForClass ()
Return Function Parameter:	statusInfo : imsx_StatusInfo - the status information report for the request. This report has end-to-end significance and must map between the messaging technology approach and the business transaction API. For REST-based bindings this structure describes the message payload that must be returned when the request has not been successfully completed.
Supplied (in) Parameters:	classSourcedId : GUID - the unique identifier, GUID, for the class.
Returned (out) Parameters:	lineItems : LineItemSet - the set of lineItems for the specified class. This payload may be empty if there are no records that conform to any of the selection constraints.
Behavior:	Get the set of lineItems on the service provider for a specific class. If the corresponding class cannot be located then an 'unknown' error code is returned.
Notes:	Query Parameters for the REST-based binding have been defined for this operation, namely: limit - to define the download segmentation value i.e. the maximum number of records to be contained in the response. offset - the number of the first record to be supplied in the segmented response message. sort - 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. orderBy - 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. filter - the filtering rules to be applied when identifying the records to be supplied in the response message. fields - to identify the range of fields that should be supplied in the response message.

Name:	getResultsForLineItemForClass ()
Return Function Parameter:	statusInfo : imsx_StatusInfo - the status information report for the request. This report has end-to-end significance and must map between the messaging technology approach and the business transaction API. For REST-based bindings this structure describes the message payload that must be returned when the request has not been successfully completed.
Supplied (in) Parameters:	classSourcedId : GUID - the unique identifier, GUID, for the class. lineItemSourcedId : GUID - the unique identifier, GUID, for the lineItem.
Returned (out) Parameters:	results : ResultSet - the set of results for the specified class and lineItem. This payload may be empty if there are no records that conform to any of the selection constraints.
Behavior:	Get the set of results on the service provider for a specific lineItem and for a specific class. If the corresponding class cannot be located then an 'unknown' error code is returned.
Notes:	Query Parameters for the REST-based binding have been defined for this operation, namely: limit - to define the download segmentation value i.e. the maximum number of records to be contained in the response. offset - the number of the first record to be supplied in the segmented response message. sort - 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. orderBy - 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. filter - the filtering rules to be applied when identifying the records to be supplied in the response message. fields - to identify the range of fields that should be supplied in the response message.

Name:	getResultsForStudentForClass ()
Return Function Parameter:	statusInfo : imsx_StatusInfo - the status information report for the request. This report has end-to-end significance and must map between the messaging technology approach and the business transaction API. For REST-based bindings this structure describes the message payload that must be returned when the request has not been successfully completed.
Supplied (in) Parameters:	classSourcedId : GUID - the unique identifier, GUID, for the class. studentSourcedId : GUID - the unique identifier, GUID, for the student.
Returned (out) Parameters:	results : ResultSet - the set of results for the specified student and lineItem. This payload may be empty if there are no records that conform to any of the selection constraints.
Behavior:	Get the set of results on the service provider for a specific student and for a specific class. If the corresponding class cannot be located then an 'unknown' error code is returned.
Notes:	Query Parameters for the REST-based binding have been defined for this operation, namely: limit - to define the download segmentation value i.e. the maximum number of records to be contained in the response. offset - the number of the first record to be supplied in the segmented response message. sort - 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. orderBy - 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. filter - the filtering rules to be applied when identifying the records to be supplied in the response message. fields - to identify the range of fields that should be supplied in the response message.

Name:	getCategoriesForClass ()
Return Function Parameter:	imsx_StatusInfo : imsx_StatusInfo - the status information report for the request. This report has end-to-end significance and must map between the messaging technology approach and the business transaction API. For REST-based bindings this structure describes the message payload that must be returned when the request has not been successfully completed.
Supplied (in) Parameters:	classSourcedId : GUID - the unique identifier, GUID, for the class.
Returned (out) Parameters:	categories : CategoriesSet - the set of categories for the specified class. This payload may be empty if there are no records that conform to any of the selection constraints.
Behavior:	Get the set of categories on the service provider for a specific class. If the corresponding class cannot be located then an 'unknown' error code is returned.
Notes:	Query Parameters for the REST-based binding have been defined for this operation, namely: limit - to define the download segmentation value i.e. the maximum number of records to be contained in the response. offset - the number of the first record to be supplied in the segmented response message. sort - 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. orderBy - 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. filter - the filtering rules to be applied when identifying the records to be supplied in the response message. fields - to identify the range of fields that should be supplied in the response message.

Name:	getScoreScalesForClass ()
Return Function Parameter:	imsx_StatusInfo : imsx_StatusInfo - the status information report for the request. This report has end-to-end significance and must map between the messaging technology approach and the business transaction API. For REST-based bindings this structure describes the message payload that must be returned when the request has not been successfully completed.
Supplied (in) Parameters:	classSourcedId : GUID - the unique identifier, GUID, for the class.
Returned (out) Parameters:	scoreScales : ScoreScaleSet - the set of scoreScales for the specified class. This payload may be empty if there are no records that conform to any of the selection constraints.
Behavior:	Get the set of scoreScales on the service provider for a specific class. If the corresponding class cannot be located then an 'unknown' error code is returned.
Notes:	Query Parameters for the REST-based binding have been defined for this operation, namely: limit - to define the download segmentation value i.e. the maximum number of records to be contained in the response. offset - the number of the first record to be supplied in the segmented response message. sort - 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. orderBy - 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. filter - the filtering rules to be applied when identifying the records to be supplied in the response message. fields - to identify the range of fields that should be supplied in the response message.

Name:	postResultsForAcademicSessionForClass ()
Return Function Parameter:	imsx_StatusInfo : imsx_StatusInfo - the status information report for the request. This report has end-to-end significance and must map between the messaging technology approach and the business transaction API. For REST-based bindings this structure describes the message payload that must be returned when the request has not been successfully completed.
Supplied (in) Parameters:	classSourcedId : GUID - the unique identifier, GUID, for the class. academicSessionSourcedId : GUID - the unique identifier, GUID, for the academic session. results : ResultSet - the set of result records to be created in response to this request. This includes an initial assignment of sourcedId so that the mapping between this and the actually assigned sourcedId can be reported.
Returned (out) Parameters:	resultSourcedIds : GUIDPairSet - the sourcedIds assigned to the result records by the responding system. This information is passed as a set of original/assigned sourcedId tuples.
Behavior:	To create a set of results for a specific academic session and specific class. The responding system must return the set of sourcedIds that have been allocated to the newly created result records. If the corresponding class or academic session cannot be located then an 'unknown' error code is returned.

Name:	postLineItemsForClass ()
Return Function Parameter:	imsx_StatusInfo : imsx_StatusInfo - the status information report for the request. This report has end-to-end significance and must map between the messaging technology approach and the business transaction API. For REST-based bindings this structure describes the message payload that must be returned when the request has not been successfully completed.
Supplied (in) Parameters:	classSourcedId : GUID - the unique identifier, GUID, for the class. lineItems : LineItemSet - the set of lineItem records to be created in response to this request. This includes an initial assignment of sourcedId so that the mapping between this and the actually assigned sourcedId can be reported.
Returned (out) Parameters:	lineItemSourcedIds : GUIDPairSet - the sourcedIds assigned to the lineItem records by the responding system. This information is passed as a set of original/assigned sourcedId tuples.
Behavior:	To create a set of lineItems for a specific class. The responding system must return the set of sourcedIds that have been allocated to the newly created lineItem records. If the corresponding class cannot be located then an 'unknown' error code is returned.

Name:	getAllLineItems ()
Return Function Parameter:	statusInfo : imsx_StatusInfo - the status information report for the request. This report has end-to-end significance and must map between the messaging technology approach and the business transaction API. For REST-based bindings this structure describes the message payload that must be returned when the request has not been successfully completed.
Supplied (in) Parameters:	None.
Returned (out) Parameters:	lineItems : LineItemSet - the set of lineItems that have been read from the service provider.
Behavior:	Get all of the Line Items on the service provider.
Notes:	Query Parameters for the REST-based binding have been defined for this operation, namely: limit - to define the download segmentation value i.e. the maximum number of records to be contained in the response. offset - the number of the first record to be supplied in the segmented response message. sort - 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. orderBy - 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. filter - the filtering rules to be applied when identifying the records to be supplied in the response message. fields - to identify the range of fields that should be supplied in the response message.

Name:	getLineItem ()
Return Function Parameter:	statusInfo : imsx_StatusInfo - the status information report for the request. This report has end-to-end significance and must map between the messaging technology approach and the business transaction API. For REST-based bindings this structure describes the message payload that must be returned when the request has not been successfully completed.
Supplied (in) Parameters:	sourcedId : GUID - the unique identifier, GUID, for this lineItem.
Returned (out) Parameters:	lineItem : SingleLineItem - the lineItem that has been read from the service provider.
Behavior:	Get a specific LineItem on the service provider. If the corresponding record cannot be located then an 'unknown' error code is returned.
Notes:	Query Parameters for the REST-based binding have been defined for this operation, namely: fields - to identify the range of fields that should be supplied in the response message.

IMS OneRoster Gradebook Service Version 1.2

IMS Final ReleaseVersion 1.0

IMS Final Release
Version 1.0

Name:	deleteLineItem ()
Return Function Parameter:	statusInfo : imsx_StatusInfo - the status information report for the request. This report has end-to-end significance and must map between the messaging technology approach and the business transaction API. For REST-based bindings this structure describes the message payload that must be returned when the request has not been successfully completed.
Supplied (in) Parameters:	sourcedId : GUID - the unique identifier, GUID, for the lineItem to be deleted.
Returned (out) Parameters:	None.
Behavior:	Delete a specific lineItem on the service provider. If the corresponding record cannot be located then an 'unknown' error code is returned.

Name:	putLineItem ()
Return Function Parameter:	statusInfo : imsx_StatusInfo - the status information report for the request. This report has end-to-end significance and must map between the messaging technology approach and the business transaction API. For REST-based bindings this structure describes the message payload that must be returned when the request has not been successfully completed.
Supplied (in) Parameters:	sourcedId : GUID - the unique identifier, GUID, to be allocated to this new lineItem. lineItem : SingleLineItem - the lineItem data that is to be stored.
Returned (out) Parameters:	None.
Behavior:	To create a new lineItem. The associated sourcedId for this new record is supplied by the requesting system.

Name:	postResultsForLineItem ()
Return Function Parameter:	imsx_StatusInfo : imsx_StatusInfo - the status information report for the request. This report has end-to-end significance and must map between the messaging technology approach and the business transaction API. For REST-based bindings this structure describes the message payload that must be returned when the request has not been successfully completed.
Supplied (in) Parameters:	lineItemSourcedId : GUID - the unique identifier, GUID, for the lineItem. results : ResultSet - the set of result records to be created in response to this request. This includes an initial assignment of sourcedId so that the mapping between this and the actually assigned sourcedId can be reported.
Returned (out) Parameters:	resultSourcedIds : GUIDPairSet - the sourcedIds assigned to the result records by the responding system. This information is passed as a set of original/assigned sourcedId tuples.
Behavior:	To create a set of results for a specific lineItem. The responding system must return the set of sourcedIds that have been allocated to the newly created result records.

Name:	getAllResults ()
Return Function Parameter:	statusInfo : imsx_StatusInfo - the status information report for the request. This report has end-to-end significance and must map between the messaging technology approach and the business transaction API. For REST-based bindings this structure describes the message payload that must be returned when the request has not been successfully completed.
Supplied (in) Parameters:	None.
Returned (out) Parameters:	results : ResultSet - the set of results that have been read from the service provider.
Behavior:	Get all of the results on the service provider.
Notes:	Query Parameters for the REST-based binding have been defined for this operation, namely: limit - to define the download segmentation value i.e. the maximum number of records to be contained in the response. offset - the number of the first record to be supplied in the segmented response message. sort - 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. orderBy - 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. filter - the filtering rules to be applied when identifying the records to be supplied in the response message. fields - to identify the range of fields that should be supplied in the response message.

Name:	getResult ()
Return Function Parameter:	statusInfo : imsx_StatusInfo - the status information report for the request. This report has end-to-end significance and must map between the messaging technology approach and the business transaction API. For REST-based bindings this structure describes the message payload that must be returned when the request has not been successfully completed.
Supplied (in) Parameters:	sourcedId : GUID - the unique identifier, GUID, for this result.
Returned (out) Parameters:	result : SingleResult - the result that has been read from the service provider.
Behavior:	Get a specific result on the service provider. If the corresponding record cannot be located then an 'unknown' error code is returned.
Notes:	Query Parameters for the REST-based binding have been defined for this operation, namely: fields - to identify the range of fields that should be supplied in the response message.

Name:	deleteResult ()
Return Function Parameter:	statusInfo : imsx_StatusInfo - the status information report for the request. This report has end-to-end significance and must map between the messaging technology approach and the business transaction API. For REST-based bindings this structure describes the message payload that must be returned when the request has not been successfully completed.
Supplied (in) Parameters:	sourcedId : GUID - the unique identifier, GUID, for the result to be deleted.
Returned (out) Parameters:	None.
Behavior:	Delete a specific result on the service provider. If the corresponding record cannot be located then an 'unknown' error code is returned.

Name:	putResult ()
Return Function Parameter:	statusInfo : imsx_StatusInfo - the status information report for the request. This report has end-to-end significance and must map between the messaging technology approach and the business transaction API. For REST-based bindings this structure describes the message payload that must be returned when the request has not been successfully completed.
Supplied (in) Parameters:	sourcedId : GUID - the unique identifier, GUID, to be allocated to this new result. result : SingleResult - the result data that is to be stored.
Returned (out) Parameters:	None.
Behavior:	To create a new result. The associated sourcedId for this new record is supplied by the requesting system.

Name:	getScoreScalesForSchool ()
Return Function Parameter:	imsx_StatusInfo : imsx_StatusInfo - the status information report for the request. This report has end-to-end significance and must map between the messaging technology approach and the business transaction API. For REST-based bindings this structure describes the message payload that must be returned when the request has not been successfully completed.
Supplied (in) Parameters:	schoolSourcedId : GUID - the unique identifier, GUID, for the school.
Returned (out) Parameters:	scoreScales : ScoreScaleSet - the set of scoreScales used by the specified school. This payload may be empty if there are no records that conform to any of the selection constraints.
Behavior:	Get the set of scoreScales on the service provider for a specific school. If the corresponding school cannot be located then an 'unknown' error code is returned.
Notes:	Query Parameters for the REST-based binding have been defined for this operation, namely: limit - to define the download segmentation value i.e. the maximum number of records to be contained in the response. offset - the number of the first record to be supplied in the segmented response message. sort - 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. orderBy - 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. filter - the filtering rules to be applied when identifying the records to be supplied in the response message. fields - to identify the range of fields that should be supplied in the response message.

Name:	postLineItemsForSchool ()
Return Function Parameter:	imsx_StatusInfo : imsx_StatusInfo - the status information report for the request. This report has end-to-end significance and must map between the messaging technology approach and the business transaction API. For REST-based bindings this structure describes the message payload that must be returned when the request has not been successfully completed.
Supplied (in) Parameters:	schoolSourcedId : GUID - the unique identifier, GUID, for the school. lineItems : LineItemSet - the set of lineItem records to be created in response to this request. This includes an initial assignment of sourcedId so that the mapping between this and the actually assigned sourcedId can be reported.
Returned (out) Parameters:	lineItemSourcedIds : GUIDPairSet - the sourcedIds assigned to the lineItem records by the responding system. This information is passed as a set of original/assigned sourcedId tuples.
Behavior:	To create a set of lineItems for a specific school. The responding system must return the set of sourcedIds that have been allocated to the newly created lineItem records.

Name:	getAllScoreScales ()
Return Function Parameter:	imsx_StatusInfo : imsx_StatusInfo - the status information report for the request. This report has end-to-end significance and must map between the messaging technology approach and the business transaction API. For REST-based bindings this structure describes the message payload that must be returned when the request has not been successfully completed.
Supplied (in) Parameters:	None.
Returned (out) Parameters:	scoreScales : ScoreScaleSet - the set of scoreScales that have been read from the service provider.
Behavior:	Get all of the ScoreScales on the service provider.
Notes:	Query Parameters for the REST-based binding have been defined for this operation, namely: limit - to define the download segmentation value i.e. the maximum number of records to be contained in the response. offset - the number of the first record to be supplied in the segmented response message. sort - 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. orderBy - 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. filter - the filtering rules to be applied when identifying the records to be supplied in the response message. fields - to identify the range of fields that should be supplied in the response message.