OneRoster Rostering 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 Rostering Service provides the ability to manage the exchange of information about people, classes, courses, organizations and enrollments. 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 "AcademicSessionsManagement" interface.

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

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

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

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

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

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

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

Table 4.10 The set of operations for the "StudentsManagement" interface.

Table 4.11 The set of operations for the "TeachersManagement" interface.

Table 4.12 The set of operations for the "TermsManagement" interface.

Table 4.13 The set of operations for the "UsersManagement" interface.

Table 5.1 "AcademicSessionSet" Class Description

Table 5.1.1 "academicSessions" Attribute Description

Table 5.2 "ClassSet" Class Description

Table 5.2.1 "classes" Attribute Description

Table 5.3 "CourseSet" Class Description

Table 5.3.1 "courses" Attribute Description

Table 5.4 "DemographicsSet" Class Description

Table 5.4.1 "demographics" Attribute Description

Table 5.5 "EnrollmentSet" Class Description

Table 5.5.1 "enrollments" Attribute Description

Table 5.6 "GUID" Class Description

Table 5.7 "OrgSet" Class Description

Table 5.7.1 "orgs" Attribute Description

Table 5.8 "SingleAcademicSession" Class Description

Table 5.8.1 "academicSession" Attribute Description

Table 5.9 "SingleClass" Class Description

Table 5.9.1 "class" Attribute Description

Table 5.10 "SingleCourse" Class Description

Table 5.10.1 "course" Attribute Description

Table 5.11 "SingleDemographics" Class Description

Table 5.11.1 "demographics" Attribute Description

Table 5.12 "SingleEnrollment" Class Description

Table 5.12.1 "enrollment" Attribute Description

Table 5.13 "SingleOrg" Class Description

Table 5.13.1 "org" Attribute Description

Table 5.14 "SingleUser" Class Description

Table 5.14.1 "user" Attribute Description

Table 5.15 "UserSet" Class Description

Table 5.15.1 "users" Attribute Description

Table 5.16 "imsx_StatusInfo" Class Description

Table 5.16.1 "imsx_codeMajor" Attribute Description

Table 5.16.2 "imsx_severity" Attribute Description

Table 5.16.3 "imsx_description" Attribute Description

Table 5.16.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 AcademicSession class definitions

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

Table 6.1.2.2 Description of the "startDate" attribute for the "AcademicSession" class

Table 6.1.2.3 Description of the "endDate" attribute for the "AcademicSession" class

Table 6.1.2.4 Description of the "type" attribute for the "AcademicSession" class

Table 6.1.2.5 Description of the "parent" attribute for the "AcademicSession" class

Table 6.1.2.6 Description of the "children" attribute for the "AcademicSession" class

Table 6.1.2.7 Description of the "schoolYear" attribute for the "AcademicSession" class

Table 6.1.3 AcademicSessionSet class definitions

Table 6.1.3.1 Description of the "academicSessions" attribute for the "AcademicSessionSet" class

Table 6.1.4 Base class definitions

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

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

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

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

Table 6.1.5 Class class definitions

Table 6.1.5.1 Description of the "title" attribute for the "Class" class

Table 6.1.5.2 Description of the "classCode" attribute for the "Class" class

Table 6.1.5.3 Description of the "classType" attribute for the "Class" class

Table 6.1.5.4 Description of the "location" attribute for the "Class" class

Table 6.1.5.5 Description of the "grades" attribute for the "Class" class

Table 6.1.5.6 Description of the "subjects" attribute for the "Class" class

Table 6.1.5.7 Description of the "course" attribute for the "Class" class

Table 6.1.5.8 Description of the "school" attribute for the "Class" class

Table 6.1.5.9 Description of the "terms" attribute for the "Class" class

Table 6.1.5.10 Description of the "subjectCodes" attribute for the "Class" class

Table 6.1.5.11 Description of the "periods" attribute for the "Class" class

Table 6.1.5.12 Description of the "resources" attribute for the "Class" class

Table 6.1.6 ClassGUIDRef class definitions

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

Table 6.1.7 ClassSet class definitions

Table 6.1.7.1 Description of the "classes" attribute for the "ClassSet" class

Table 6.1.8 Course class definitions

Table 6.1.8.1 Description of the "title" attribute for the "Course" class

Table 6.1.8.2 Description of the "schoolYear" attribute for the "Course" class

Table 6.1.8.3 Description of the "courseCode" attribute for the "Course" class

Table 6.1.8.4 Description of the "grades" attribute for the "Course" class

Table 6.1.8.5 Description of the "subjects" attribute for the "Course" class

Table 6.1.8.6 Description of the "org" attribute for the "Course" class

Table 6.1.8.7 Description of the "subjectCodes" attribute for the "Course" class

Table 6.1.8.8 Description of the "resources" attribute for the "Course" class

Table 6.1.9 CourseGUIDRef class definitions

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

Table 6.1.10 CourseSet class definitions

Table 6.1.10.1 Description of the "courses" attribute for the "CourseSet" class

Table 6.1.11 Credential class definitions

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

Table 6.1.11.2 Description of the "username" attribute for the "Credential" class

Table 6.1.11.3 Description of the "password" attribute for the "Credential" class

Table 6.1.11.4 Description of the "extensions" attribute for the "Credential" class

Table 6.1.12 Demographics class definitions

Table 6.1.12.1 Description of the "birthDate" attribute for the "Demographics" class

Table 6.1.12.2 Description of the "sex" attribute for the "Demographics" class

Table 6.1.12.3 Description of the "americanIndianOrAlaskaNative" attribute for the "Demographics" class

Table 6.1.12.4 Description of the "asian" attribute for the "Demographics" class

Table 6.1.12.5 Description of the "blackOrAfricanAmerican" attribute for the "Demographics" class

Table 6.1.12.6 Description of the "nativeHawaiianOrOtherPacificIslander" attribute for the "Demographics" class

Table 6.1.12.7 Description of the "white" attribute for the "Demographics" class

Table 6.1.12.8 Description of the "demographicRaceTwoOrMoreRaces" attribute for the "Demographics" class

Table 6.1.12.9 Description of the "hispanicOrLatinoEthnicity" attribute for the "Demographics" class

Table 6.1.12.10 Description of the "countryOfBirthCode" attribute for the "Demographics" class

Table 6.1.12.11 Description of the "stateOfBirthAbbreviation" attribute for the "Demographics" class

Table 6.1.12.12 Description of the "cityOfBirth" attribute for the "Demographics" class

Table 6.1.12.13 Description of the "publicSchoolResidenceStatus" attribute for the "Demographics" class

Table 6.1.13 DemographicsSet class definitions

Table 6.1.13.1 Description of the "demographics" attribute for the "DemographicsSet" class

Table 6.1.14 Enrollment class definitions

Table 6.1.14.1 Description of the "user" attribute for the "Enrollment" class

Table 6.1.14.2 Description of the "class" attribute for the "Enrollment" class

Table 6.1.14.3 Description of the "school" attribute for the "Enrollment" class

Table 6.1.14.4 Description of the "role" attribute for the "Enrollment" class

Table 6.1.14.5 Description of the "primary" attribute for the "Enrollment" class

Table 6.1.14.6 Description of the "beginDate" attribute for the "Enrollment" class

Table 6.1.14.7 Description of the "endDate" attribute for the "Enrollment" class

Table 6.1.15 EnrollmentSet class definitions

Table 6.1.15.1 Description of the "enrollments" attribute for the "EnrollmentSet" class

Table 6.1.16 GUIDRef class definitions

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

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

Table 6.1.17 Metadata class definitions

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

Table 6.1.18 Org class definitions

Table 6.1.18.1 Description of the "name" attribute for the "Org" class

Table 6.1.18.2 Description of the "type" attribute for the "Org" class

Table 6.1.18.3 Description of the "identifier" attribute for the "Org" class

Table 6.1.18.4 Description of the "parent" attribute for the "Org" class

Table 6.1.18.5 Description of the "children" attribute for the "Org" class

Table 6.1.19 OrgGUIDRef class definitions

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

Table 6.1.20 OrgSet class definitions

Table 6.1.20.1 Description of the "orgs" attribute for the "OrgSet" class

Table 6.1.21 ResourceGUIDRef class definitions

Table 6.1.21.1 Description of the "type" attribute for the "ResourceGUIDRef" class

Table 6.1.22 Role class definitions

Table 6.1.22.1 Description of the "roleType" attribute for the "Role" class

Table 6.1.22.2 Description of the "role" attribute for the "Role" class

Table 6.1.22.3 Description of the "org" attribute for the "Role" class

Table 6.1.22.4 Description of the "userProfile" attribute for the "Role" class

Table 6.1.22.5 Description of the "beginDate" attribute for the "Role" class

Table 6.1.22.6 Description of the "endDate" attribute for the "Role" class

Table 6.1.23 SingleAcademicSession class definitions

Table 6.1.23.1 Description of the "academicSession" attribute for the "SingleAcademicSession" class

Table 6.1.24 SingleClass class definitions

Table 6.1.24.1 Description of the "class" attribute for the "SingleClass" class

Table 6.1.25 SingleCourse class definitions

Table 6.1.25.1 Description of the "course" attribute for the "SingleCourse" class

Table 6.1.26 SingleDemographics class definitions

Table 6.1.26.1 Description of the "demographics" attribute for the "SingleDemographics" class

Table 6.1.27 SingleEnrollment class definitions

Table 6.1.27.1 Description of the "enrollment" attribute for the "SingleEnrollment" class

Table 6.1.28 SingleOrg class definitions

Table 6.1.28.1 Description of the "org" attribute for the "SingleOrg" class

Table 6.1.29 SingleUser class definitions

Table 6.1.29.1 Description of the "user" attribute for the "SingleUser" class

Table 6.1.30 User class definitions

Table 6.1.30.1 Description of the "userMasterIdentifier" attribute for the "User" class

Table 6.1.30.2 Description of the "username" attribute for the "User" class

Table 6.1.30.3 Description of the "userIds" attribute for the "User" class

Table 6.1.30.4 Description of the "enabledUser" attribute for the "User" class

Table 6.1.30.5 Description of the "givenName" attribute for the "User" class

Table 6.1.30.6 Description of the "familyName" attribute for the "User" class

Table 6.1.30.7 Description of the "middleName" attribute for the "User" class

Table 6.1.30.8 Description of the "preferredFirstName" attribute for the "User" class

Table 6.1.30.9 Description of the "preferredMiddleName" attribute for the "User" class

Table 6.1.30.10 Description of the "preferredLastName" attribute for the "User" class

Table 6.1.30.11 Description of the "pronouns" attribute for the "User" class

Table 6.1.30.12 Description of the "roles" attribute for the "User" class

Table 6.1.30.13 Description of the "userProfiles" attribute for the "User" class

Table 6.1.30.14 Description of the "primaryOrg" attribute for the "User" class

Table 6.1.30.15 Description of the "identifier" attribute for the "User" class

Table 6.1.30.16 Description of the "email" attribute for the "User" class

Table 6.1.30.17 Description of the "sms" attribute for the "User" class

Table 6.1.30.18 Description of the "phone" attribute for the "User" class

Table 6.1.30.19 Description of the "agents" attribute for the "User" class

Table 6.1.30.20 Description of the "grades" attribute for the "User" class

Table 6.1.30.21 Description of the "password" attribute for the "User" class

Table 6.1.30.22 Description of the "resources" attribute for the "User" class

Table 6.1.31 UserGUIDRef class definitions

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

Table 6.1.32 UserId class definitions

Table 6.1.32.1 Description of the "type" attribute for the "UserId" class

Table 6.1.32.2 Description of the "identifier" attribute for the "UserId" class

Table 6.1.33 UserProfile class definitions

Table 6.1.33.1 Description of the "profileId" attribute for the "UserProfile" class

Table 6.1.33.2 Description of the "profileType" attribute for the "UserProfile" class

Table 6.1.33.3 Description of the "vendorId" attribute for the "UserProfile" class

Table 6.1.33.4 Description of the "applicationId" attribute for the "UserProfile" class

Table 6.1.33.5 Description of the "description" attribute for the "UserProfile" class

Table 6.1.33.6 Description of the "credentials" attribute for the "UserProfile" class

Table 6.1.34 UserSet class definitions

Table 6.1.34.1 Description of the "users" attribute for the "UserSet" class

Table 6.1.35 imsx_CodeMinor class definitions

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

Table 6.1.36 imsx_CodeMinorField class definitions

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

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

Table 6.1.37 imsx_StatusInfo class definitions

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

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

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

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

Table 6.2.1 EnumExtString class definitions

Table 6.2.1.1 Description of the "pattern" attribute for the "EnumExtString" class

Table 6.2.2 GUID class definitions

Table 6.2.3 Identifier class definitions

Table 6.3.1 AcadSessionGUIDRefTypeEnum class definitions

Table 6.3.2 BaseStatusEnum class definitions

Table 6.3.3 ClassGUIDRefTypeEnum class definitions

Table 6.3.4 ClassTypeEnum class definitions

Table 6.3.5 CourseGUIDRefTypeEnum class definitions

Table 6.3.6 EnrolRoleEnum class definitions

Table 6.3.7 GenderEnum class definitions

Table 6.3.8 OrgGUIDRefTypeEnum class definitions

Table 6.3.9 OrgTypeEnum class definitions

Table 6.3.10 ResourceGUIDRefTypeEnum class definitions

Table 6.3.11 RoleEnum class definitions

Table 6.3.12 RoleTypeEnum class definitions

Table 6.3.13 SessionTypeEnum class definitions

Table 6.3.14 TrueFalseEnum class definitions

Table 6.3.15 UserGUIDRefTypeEnum class definitions

Table 6.3.16 imsx_CodeMajorEnum class definitions

Table 6.3.17 imsx_CodeMinorValueEnum class definitions

Table 6.3.18 imsx_SeverityEnum class definitions

Table 6.4.1 ClassTypeEnumExt class description

Table 6.4.2 EnrolRoleEnumExt class description

Table 6.4.3 GenderEnumExt class description

Table 6.4.4 OrgTypeEnumExt class description

Table 6.4.5 RoleEnumExt class description

Table 6.4.6 SessionTypeEnumExt class description

Table 7.1 Description of the AcademicSession link data class.

Table 7.2 Description of the Class link data class.

Table 7.3 Description of the Course link data class.

Table 7.4 Description of the Org link data class.

Table 7.5 Description of the Resource link data class.

Table 7.6 Description of the User link data class.

Table 7.7 Description of the UserProfile 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 1.2 Rostering Service Model and as such it is used as the basis for the development of the following documents:

This information model defines the OneRoster Rostering 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 Rostering Service 1.2

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

1.4. Structure of this Document

1.5. Nomenclature

2. Use-cases

The set of use-cases addressed by the OR Rostering 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 people engaged in the teaching activities. To provide the details of the teachers, students or users (in general) that are involved in the teaching activities: this includes their demographics.
2	To enable a system to obtain information about the set of courses used for the teaching activities. To provide the details of the set of courses that are available including segmenting them by school.
3	To enable a system to obtain information about the set of classes used for the teaching activities. To provide the details of the set of classes that are available including segmenting them by course, school and user.
4	To enable a system to obtain the set of enrollments on a class. To provide the details of the set of enrollments on the various classes that are being supplied. This includes segmentation by class and/or school.
5	To enable a system to obtain information about the set of academic sessions across which the teaching is delivered. To provide the details of the set of academic sessions used in the organization. This includes identification of the set of terms and grading periods.
6	To enable a system to obtain information about the set of organizations responsible for delivering the teaching activities. To provide a list of the schools, districts and other organizations that are involved in the teaching activities. To enable details about each of these organizations to be obtained.

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 information 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 Rostering Service specification is shown in Figure 3.1. In this architecture the scope of the IMS OR Rostering 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. Service Objects

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

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

The relationships between the core classes in OR Rostering are shown in Figure 3.2.

3.4. Synchronous and Asynchronous Services

The OR Rostering Service is a synchronous service i.e. the consumer is blocked until the response from the provider is received. This means that a consumer can only have one outstanding request with a service provider. The corresponding sequence of actions is shown in Figure 3.3.

3.5. OneRoster Rostering, Resources and Gradebook Choreography

The rostering data model, and associated services, is the core of the OneRoster specification. Choreography with the other OneRoster services is dependent upon:

4. The Behavior Model

4.1 Service Definition

Table 4.1 The set of interfaces.
Interface	Description
AcademicSessionsManagement	This enables the management of academic sessions i.e. periods of academic activity.
ClassesManagement	This enables the management of Classes i.e. scheduled learning of courses.
CoursesManagement	This enables the management of Courses i.e. programme of study.
DemographicsManagement	This enables the management of demographics information (each assigned to a specific user). The sourcedIds for the user and the demograohics records should be the same.
EnrollmentsManagement	This enables the management of the enrollments of users (teachers, students, etc.) on classes supplied by schools.
GradingPeriodsManagement	This enables the management of grading periods i.e. specific academic sessions.
OrgsManagement	This enables the management of orgs i.e. an organization involved in the learning in some form or other.
SchoolsManagement	This enables the management of information about schools. A school is a type of 'org'.
StudentsManagement	This enables the management of information about students (a student is a type of 'user').
TeachersManagement	This enables the management of information about teachers (a teacher is a type of 'user').
TermsManagement	This enables the management of information about terms (a term is a type of 'academicSession').
UsersManagement	This enables the management of information about users (including students and teachers).

4.2 AcademicSessionsManagement Interface Description

Table 4.2 The set of operations for the "AcademicSessionsManagement" interface.
Operation	Description
getAllAcademicSessions	To read, get, a collection of academic sessions i.e. all academic sessions.
getAcademicSession	To read, get, a specific academic session. If the specified academic session cannot be identified within the service provider then a status code of 'unknownobject' must be reported.

4.2.1 "getAllAcademicSessions" Operation

4.2.2 "getAcademicSession" Operation

4.3 ClassesManagement Interface Description

Table 4.3 The set of operations for the "ClassesManagement" interface.
Operation	Description
getAllClasses	To read, get, a collection of classes i.e. all classes.
getClass	To read, get, a specific class. If the specified class cannot be identified within the service provider then a status code of 'unknownobject' must be reported.
getStudentsForClass	To read, get, the collection of students associated with a specific class. If the specified class cannot be identified within the service provider then a status code of 'unknownobject' must be reported.
getTeachersForClass	To read, get, the collection of teachers associated with a specific class. If the specified class cannot be identified within the service provider then a status code of 'unknownobject' must be reported.

4.3.1 "getAllClasses" Operation

4.3.2 "getClass" Operation

4.3.3 "getStudentsForClass" Operation

4.3.4 "getTeachersForClass" Operation

4.4 CoursesManagement Interface Description

Table 4.4 The set of operations for the "CoursesManagement" interface.
Operation	Description
getAllCourses	To read, get, a collection of courses i.e. all courses.
getCourse	To read, get, a specific course. If the specified course cannot be identified within the service provider then a status code of 'unknownobject' must be reported.
getClassesForCourse	To get the set of classes related to a specific course. If the specified course cannot be identified within the service provider then a status code of 'unknownobject' must be reported.

4.4.1 "getAllCourses" Operation

4.4.2 "getCourse" Operation

4.4.3 "getClassesForCourse" Operation

4.5 DemographicsManagement Interface Description

Table 4.5 The set of operations for the "DemographicsManagement" interface.
Operation	Description
getAllDemographics	To read, get, a collection of demographics i.e. all demographics.
getDemographics	To read, get, a specific user demographics. If the specified user and/or demographics recrds cannot be identified within the service provider then a status code of 'unknownobject' must be reported.

4.5.1 "getAllDemographics" Operation

4.5.2 "getDemographics" Operation

4.6 EnrollmentsManagement Interface Description

Table 4.6 The set of operations for the "EnrollmentsManagement" interface.
Operation	Description
getAllEnrollments	To read, get, a collection of enrollments i.e. all enrollments.
getEnrollment	To read, get, a specific enrollment. If the specified enrollment cannot be identified within the service provider then a status code of 'unknownobject' must be reported.

4.6.1 "getAllEnrollments" Operation

4.6.2 "getEnrollment" Operation

4.7 GradingPeriodsManagement Interface Description

Table 4.7 The set of operations for the "GradingPeriodsManagement" interface.
Operation	Description
getAllGradingPeriods	To read, get, a collection of grading periods i.e. all academic sessions.
getGradingPeriod	To read, get, a specific grading period. If the specified grading period cannot be identified within the service provider then a status code of 'unknownobject' must be reported.

4.7.1 "getAllGradingPeriods" Operation

4.7.2 "getGradingPeriod" Operation

4.8 OrgsManagement Interface Description

Table 4.8 The set of operations for the "OrgsManagement" interface.
Operation	Description
getAllOrgs	To read, get, a collection of orgs i.e. all orgs.
getOrg	To read, get, a specific org. If the specified org cannot be identified within the service provider then a status code of 'unknownobject' must be reported.

4.8.1 "getAllOrgs" Operation

4.8.2 "getOrg" Operation

4.9 SchoolsManagement Interface Description

Table 4.9 The set of operations for the "SchoolsManagement" interface.
Operation	Description
getAllSchools	To read, get, a collection of schools i.e. all schools.
getSchool	To read, get, a specific school. If the specified school cannot be identified within the service provider then a status code of 'unknownobject' must be reported.
getCoursesForSchool	To read, get, the collection of courses associated with a specific school. If the specified school cannot be identified within the service provider then a status code of 'unknownobject' must be reported.
getEnrollmentsForClassInSchool	To read, get, the collection of enrollments associated with a specific class at a specific school. If the specified school and/or class cannot be identified within the service provider then a status code of 'unknownobject' must be reported.
getStudentsForClassInSchool	To read, get, the collection of students associated with a specific class at a specific school. If the specified school and/or class cannot be identified within the service provider then a status code of 'unknownobject' must be reported.
getTeachersForClassInSchool	To read, get, the collection of teachers associated with a specific class at a specific school. If the specified school and/or class cannot be identified within the service provider then a status code of 'unknownobject' must be reported.
getEnrollmentsForSchool	To read, get, the collection of enrollments associated with a specific school. If the specified school cannot be identified within the service provider then a status code of 'unknownobject' must be reported.
getStudentsForSchool	To read, get, the collection of students associated with a specific school. If the specified school cannot be identified within the service provider then a status code of 'unknownobject' must be reported.
getTeachersForSchool	To read, get, the collection of teachers associated with a specific school. If the specified school cannot be identified within the service provider then a status code of 'unknownobject' must be reported.
getTermsForSchool	To read, get, the collection of terms associated with a specific school. If the specified school cannot be identified within the service provider then a status code of 'unknownobject' must be reported.
getClassesForSchool	To read, get, the collection of classes associated with a specific school. If the specified school cannot be identified within the service provider then a status code of 'unknownobject' must be reported.

4.9.1 "getAllSchools" Operation

4.9.2 "getSchool" Operation

4.9.3 "getCoursesForSchool" Operation

4.9.4 "getEnrollmentsForClassInSchool" Operation

4.9.5 "getStudentsForClassInSchool" Operation

4.9.6 "getTeachersForClassInSchool" Operation

4.9.7 "getEnrollmentsForSchool" Operation

4.9.8 "getStudentsForSchool" Operation

4.9.9 "getTeachersForSchool" Operation

4.9.10 "getTermsForSchool" Operation

4.9.11 "getClassesForSchool" Operation

4.10 StudentsManagement Interface Description

Table 4.10 The set of operations for the "StudentsManagement" interface.
Operation	Description
getAllStudents	To read, get, a collection of students i.e. all students.
getStudent	To read, get, a specific student. If the specified student cannot be identified within the service provider then a status code of 'unknownobject' must be reported.
getClassesForStudent	To get the set of classes related to a specific student. If the specified student cannot be identified within the service provider then a status code of 'unknownobject' must be reported.

4.10.1 "getAllStudents" Operation

4.10.2 "getStudent" Operation

4.10.3 "getClassesForStudent" Operation

4.11 TeachersManagement Interface Description

Table 4.11 The set of operations for the "TeachersManagement" interface.
Operation	Description
getAllTeachers	To read, get, a collection of teachers i.e. all teachers.
getTeacher	To read, get, a specific teacher. If the specified teacher cannot be identified within the service provider then a status code of 'unknownobject' must be reported.
getClassesForTeacher	To get the set of classes related to a specific teacher. If the specified teacher cannot be identified within the service provider then a status code of 'unknownobject' must be reported.

4.11.1 "getAllTeachers" Operation

4.11.2 "getTeacher" Operation

4.11.3 "getClassesForTeacher" Operation

4.12 TermsManagement Interface Description

4.12.1 "getAllTerms" Operation

4.12.2 "getTerm" Operation

4.12.3 "getClassesForTerm" Operation

4.12.4 "getGradingPeriodsForTerm" Operation

4.13 UsersManagement Interface Description

4.13.1 "getAllUsers" Operation

4.13.2 "getUser" Operation

4.13.3 "getClassesForUser" Operation

5. The Interface Data Model

5.1 AcademicSessionSet Class Description

5.1.1 "academicSessions" Attribute Description

5.2 ClassSet Class Description

5.2.1 "classes" Attribute Description

5.3 CourseSet Class Description

5.3.1 "courses" Attribute Description

5.4 DemographicsSet Class Description

5.4.1 "demographics" Attribute Description

5.5 EnrollmentSet Class Description

5.5.1 "enrollments" Attribute Description

5.6 GUID Class Description

5.7 OrgSet Class Description

5.7.1 "orgs" Attribute Description

5.8 SingleAcademicSession Class Description

5.8.1 "academicSession" Attribute Description

5.9 SingleClass Class Description

5.9.1 "class" Attribute Description

5.10 SingleCourse Class Description

5.10.1 "course" Attribute Description

5.11 SingleDemographics Class Description

5.11.1 "demographics" Attribute Description

5.12 SingleEnrollment Class Description

5.12.1 "enrollment" Attribute Description

5.13 SingleOrg Class Description

5.13.1 "org" Attribute Description

5.14 SingleUser Class Description

5.14.1 "user" Attribute Description

5.15 UserSet Class Description

5.15.1 "users" Attribute Description

5.16 imsx_StatusInfo Class Description

5.16.1 "imsx_codeMajor" Attribute Description

5.16.2 "imsx_severity" Attribute Description

5.16.3 "imsx_description" Attribute Description

5.16.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 AcademicSession Class Description

6.1.2.1 "title" Attribute Description

6.1.2.2 "startDate" Attribute Description

6.1.2.3 "endDate" Attribute Description

6.1.2.4 "type" Attribute Description

6.1.2.5 "parent" Attribute Description

6.1.2.6 "children" Attribute Description

6.1.2.7 "schoolYear" Attribute Description

6.1.3 AcademicSessionSet Class Description

6.1.3.1 "academicSessions" Attribute Description

6.1.4 Base Class Description

6.1.4.1 "sourcedId" Attribute Description

6.1.4.2 "status" Attribute Description

6.1.4.3 "dateLastModified" Attribute Description

6.1.4.4 "metadata" Attribute Description

6.1.5 Class Class Description

6.1.5.1 "title" Attribute Description

6.1.5.2 "classCode" Attribute Description

6.1.5.3 "classType" Attribute Description

6.1.5.4 "location" Attribute Description

6.1.5.5 "grades" Attribute Description

6.1.5.6 "subjects" Attribute Description

6.1.5.7 "course" Attribute Description

6.1.5.8 "school" Attribute Description

6.1.5.9 "terms" Attribute Description

6.1.5.10 "subjectCodes" Attribute Description

6.1.5.11 "periods" Attribute Description

6.1.5.12 "resources" Attribute Description

6.1.6 ClassGUIDRef Class Description

6.1.6.1 "type" Attribute Description

6.1.7 ClassSet Class Description

6.1.7.1 "classes" Attribute Description

6.1.8 Course Class Description

6.1.8.1 "title" Attribute Description

6.1.8.2 "schoolYear" Attribute Description

6.1.8.3 "courseCode" Attribute Description

6.1.8.4 "grades" Attribute Description

6.1.8.5 "subjects" Attribute Description

6.1.8.6 "org" Attribute Description

6.1.8.7 "subjectCodes" Attribute Description

6.1.8.8 "resources" Attribute Description

6.1.9 CourseGUIDRef Class Description

6.1.9.1 "type" Attribute Description

6.1.10 CourseSet Class Description

6.1.10.1 "courses" Attribute Description

6.1.11 Credential Class Description

6.1.11.1 "type" Attribute Description

6.1.11.2 "username" Attribute Description

6.1.11.3 "password" Attribute Description

6.1.11.4 "extensions" Attribute Description

6.1.12 Demographics Class Description

6.1.12.1 "birthDate" Attribute Description

6.1.12.2 "sex" Attribute Description

6.1.12.3 "americanIndianOrAlaskaNative" Attribute Description

6.1.12.4 "asian" Attribute Description

6.1.12.5 "blackOrAfricanAmerican" Attribute Description

6.1.12.6 "nativeHawaiianOrOtherPacificIslander" Attribute Description

6.1.12.7 "white" Attribute Description

6.1.12.8 "demographicRaceTwoOrMoreRaces" Attribute Description

6.1.12.9 "hispanicOrLatinoEthnicity" Attribute Description

6.1.12.10 "countryOfBirthCode" Attribute Description

6.1.12.11 "stateOfBirthAbbreviation" Attribute Description

6.1.12.12 "cityOfBirth" Attribute Description

6.1.12.13 "publicSchoolResidenceStatus" Attribute Description

6.1.13 DemographicsSet Class Description

6.1.13.1 "demographics" Attribute Description

6.1.14 Enrollment Class Description

6.1.14.1 "user" Attribute Description

6.1.14.2 "class" Attribute Description

6.1.14.3 "school" Attribute Description

6.1.14.4 "role" Attribute Description

6.1.14.5 "primary" Attribute Description

6.1.14.6 "beginDate" Attribute Description

6.1.14.7 "endDate" Attribute Description

6.1.15 EnrollmentSet Class Description

6.1.15.1 "enrollments" Attribute Description

6.1.16 GUIDRef Class Description

6.1.16.1 "href" Attribute Description

6.1.16.2 "sourcedId" Attribute Description

6.1.17 Metadata Class Description

6.1.17.1 "extensions" Attribute Description

6.1.18 Org Class Description

6.1.18.1 "name" Attribute Description

6.1.18.2 "type" Attribute Description

6.1.18.3 "identifier" Attribute Description

6.1.18.4 "parent" Attribute Description

6.1.18.5 "children" Attribute Description

6.1.19 OrgGUIDRef Class Description

6.1.19.1 "type" Attribute Description

6.1.20 OrgSet Class Description

6.1.20.1 "orgs" Attribute Description

6.1.21 ResourceGUIDRef Class Description

6.1.21.1 "type" Attribute Description

6.1.22 Role Class Description

6.1.22.1 "roleType" Attribute Description

6.1.22.2 "role" Attribute Description

6.1.22.3 "org" Attribute Description

6.1.22.4 "userProfile" Attribute Description

6.1.22.5 "beginDate" Attribute Description

6.1.22.6 "endDate" Attribute Description

6.1.23 SingleAcademicSession Class Description

6.1.23.1 "academicSession" Attribute Description

6.1.24 SingleClass Class Description

6.1.24.1 "class" Attribute Description

6.1.25 SingleCourse Class Description

6.1.25.1 "course" Attribute Description

6.1.26 SingleDemographics Class Description

6.1.26.1 "demographics" Attribute Description

6.1.27 SingleEnrollment Class Description

6.1.27.1 "enrollment" Attribute Description

6.1.28 SingleOrg Class Description

6.1.28.1 "org" Attribute Description

6.1.29 SingleUser Class Description

6.1.29.1 "user" Attribute Description

6.1.30 User Class Description

6.1.30.1 "userMasterIdentifier" Attribute Description

6.1.30.2 "username" Attribute Description

6.1.30.3 "userIds" Attribute Description

6.1.30.4 "enabledUser" Attribute Description

6.1.30.5 "givenName" Attribute Description

6.1.30.6 "familyName" Attribute Description

6.1.30.7 "middleName" Attribute Description

6.1.30.8 "preferredFirstName" Attribute Description

6.1.30.9 "preferredMiddleName" Attribute Description

6.1.30.10 "preferredLastName" Attribute Description

6.1.30.11 "pronouns" Attribute Description

6.1.30.12 "roles" Attribute Description

6.1.30.13 "userProfiles" Attribute Description

6.1.30.14 "primaryOrg" Attribute Description

6.1.30.15 "identifier" Attribute Description

6.1.30.16 "email" Attribute Description

6.1.30.17 "sms" Attribute Description

6.1.30.18 "phone" Attribute Description

6.1.30.19 "agents" Attribute Description

6.1.30.20 "grades" Attribute Description

6.1.30.21 "password" Attribute Description

6.1.30.22 "resources" Attribute Description

6.1.31 UserGUIDRef Class Description

6.1.31.1 "type" Attribute Description

6.1.32 UserId Class Description

6.1.32.1 "type" Attribute Description

6.1.32.2 "identifier" Attribute Description

6.1.33 UserProfile Class Description

6.1.33.1 "profileId" Attribute Description

6.1.33.2 "profileType" Attribute Description

6.1.33.3 "vendorId" Attribute Description

6.1.33.4 "applicationId" Attribute Description

6.1.33.5 "description" Attribute Description

6.1.33.6 "credentials" Attribute Description

6.1.34 UserSet Class Description

6.1.34.1 "users" Attribute Description

6.1.35 imsx_CodeMinor Class Description

6.1.35.1 "imsx_codeMinorField" Attribute Description

6.1.36 imsx_CodeMinorField Class Description

6.1.36.1 "imsx_codeMinorFieldName" Attribute Description

6.1.36.2 "imsx_codeMinorFieldValue" Attribute Description

6.1.37 imsx_StatusInfo Class Description

6.1.37.1 "imsx_codeMajor" Attribute Description

6.1.37.2 "imsx_severity" Attribute Description

6.1.37.3 "imsx_description" Attribute Description

6.1.37.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 EnumExtString Class Description

6.2.1.1 "pattern" Attribute Description

6.2.2 GUID Class Description

6.2.3 Identifier Class 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 BaseStatusEnum Vocabulary Description

6.3.3 ClassGUIDRefTypeEnum Vocabulary Description

6.3.4 ClassTypeEnum Vocabulary Description

6.3.5 CourseGUIDRefTypeEnum Vocabulary Description

6.3.6 EnrolRoleEnum Vocabulary Description

6.3.7 GenderEnum Vocabulary Description

6.3.8 OrgGUIDRefTypeEnum Vocabulary Description

6.3.9 OrgTypeEnum Vocabulary Description

6.3.10 ResourceGUIDRefTypeEnum Vocabulary Description

6.3.11 RoleEnum Vocabulary Description

6.3.12 RoleTypeEnum Vocabulary Description

6.3.13 SessionTypeEnum Vocabulary Description

6.3.14 TrueFalseEnum Vocabulary Description

6.3.15 UserGUIDRefTypeEnum Vocabulary Description

6.3.16 imsx_CodeMajorEnum Vocabulary Description

6.3.17 imsx_CodeMinorValueEnum Vocabulary Description

6.3.18 imsx_SeverityEnum Vocabulary Description

6.4. Union Class Descriptions

6.4.1 ClassTypeEnumExt Class Description

6.4.2 EnrolRoleEnumExt Class Description

6.4.3 GenderEnumExt Class Description

6.4.4 OrgTypeEnumExt Class Description

6.4.5 RoleEnumExt Class Description

6.4.6 SessionTypeEnumExt Class Description

7. Link Data Definitions

7.1 AcademicSession Link Data Description

7.2 Class Link Data Description

7.3 Course Link Data Description

7.4 Org Link Data Description

7.5 Resource Link Data Description

7.6 User Link Data Description

7.7 UserProfile 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 5.1.1 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 'ClassTypeEnum', 'GenderEnum', 'OrgTypeEnum', 'RoleEnum' and 'SessionTypeEnum' 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, 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
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:	getAllAcademicSessions ()
Return Function Parameter:	statusInfo : imsx_StatusInfo - the transaction-level status information 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:	academicSessions : AcademicSessionSet - the set of academic sessions that have been read from the service provider.
Behavior:	To read, get, a collection of academic sessions i.e. all academic sessions.
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. The sort order should follow the [UNICODE, 16] standard. fields - to identify the range of fields that should be supplied in the response message.

Name:	getAcademicSession ()
Return Function Parameter:	statusInfo : imsx_StatusInfo - the transaction-level status information 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 academic session.
Returned (out) Parameters:	academicSession : SingleAcademicSession - the academic Session that has been read from the service provider.
Behavior:	To read, get, a specific academic session. If the specified academic session cannot be identified within the service provider then a status code of 'unknownobject' must be reported.
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:	getAllClasses ()
Return Function Parameter:	statusInfo : imsx_StatusInfo - the transaction-level status information 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:	classes : ClassSet - the set of classes that have been read from the service provider.
Behavior:	To read, get, a collection of classes i.e. all classes.
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. The sort order should follow the [UNICODE, 16] standard. fields - to identify the range of fields that should be supplied in the response message.

2. Use-cases	The set of rostering 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 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:	getClass ()
Return Function Parameter:	statusInfo : imsx_StatusInfo - the transaction-level status information 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 class.
Returned (out) Parameters:	class : SingleClass - the class that has been read from the service provider.
Behavior:	To read, get, a specific class. If the specified class cannot be identified within the service provider then a status code of 'unknownobject' must be reported.
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:	getStudentsForClass ()
Return Function Parameter:	statusInfo : imsx_StatusInfo - the transaction-level status information 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:	students : UserSet - the set of students that have been read from the service provider.
Behavior:	To read, get, the collection of students associated with a specific class. If the specified class cannot be identified within the service provider then a status code of 'unknownobject' must be reported.
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. The sort order should follow the [UNICODE, 16] standard. fields - to identify the range of fields that should be supplied in the response message.

Name:	getTeachersForClass ()
Return Function Parameter:	statusInfo : imsx_StatusInfo - the transaction-level status information 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:	teachers : UserSet - the set of teachers that have been read from the service provider.
Behavior:	To read, get, the collection of teachers associated with a specific class. If the specified class cannot be identified within the service provider then a status code of 'unknownobject' must be reported.
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. The sort order should follow the [UNICODE, 16] standard. fields - to identify the range of fields that should be supplied in the response message.

Name:	getAllCourses ()
Return Function Parameter:	statusInfo : imsx_StatusInfo - the transaction-level status information 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:	courses : CourseSet - the set of courses that have been read from the service provider.
Behavior:	To read, get, a collection of courses i.e. all courses.
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. The sort order should follow the [UNICODE, 16] standard. fields - to identify the range of fields that should be supplied in the response message.

Name:	getCourse ()
Return Function Parameter:	statusInfo : imsx_StatusInfo - the transaction-level status information 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 course.
Returned (out) Parameters:	course : SingleCourse - the course that has been read from the service provider.
Behavior:	To read, get, a specific course. If the specified course cannot be identified within the service provider then a status code of 'unknownobject' must be reported.
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:	getClassesForCourse ()
Return Function Parameter:	statusInfo : imsx_StatusInfo - the transaction-level status information 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:	courseSourcedId : GUID - the unique identifier, GUID, for the specific course.
Returned (out) Parameters:	classes : ClassSet - the set of classes that have been read from the service provider.
Behavior:	To get the set of classes related to a specific course. If the specified course cannot be identified within the service provider then a status code of 'unknownobject' must be reported.
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. The sort order should follow the [UNICODE, 16] standard. fields - to identify the range of fields that should be supplied in the response message.

Name:	getAllDemographics ()
Return Function Parameter:	statusInfo : imsx_StatusInfo - the transaction-level status information 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:	demographics : DemographicsSet - the set of user demographics that have been read from the service provider.
Behavior:	To read, get, a collection of demographics i.e. all demographics.
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. The sort order should follow the [UNICODE, 16] standard. fields - to identify the range of fields that should be supplied in the response message.

Name:	getDemographics ()
Return Function Parameter:	statusInfo : imsx_StatusInfo - the transaction-level status information 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 user demographics.
Returned (out) Parameters:	demographics : SingleDemographics - the user demographics that has been read from the service provider.
Behavior:	To read, get, a specific user demographics. If the specified user and/or demographics recrds cannot be identified within the service provider then a status code of 'unknownobject' must be reported.
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:	getAllEnrollments ()
Return Function Parameter:	statusInfo : imsx_StatusInfo - the transaction-level status information 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:	enrollments : EnrollmentSet - the set of enrollments that have been read from the service provider.
Behavior:	To read, get, a collection of enrollments i.e. all enrollments.
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. The sort order should follow the [UNICODE, 16] standard. fields - to identify the range of fields that should be supplied in the response message.

Name:	getEnrollment ()
Return Function Parameter:	statusInfo : imsx_StatusInfo - the transaction-level status information 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 enrollment.
Returned (out) Parameters:	enrollment : SingleEnrollment - the enrollment that has been read from the service provider.
Behavior:	To read, get, a specific enrollment. If the specified enrollment cannot be identified within the service provider then a status code of 'unknownobject' must be reported.
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:	getAllGradingPeriods ()
Return Function Parameter:	statusInfo : imsx_StatusInfo - the transaction-level status information 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:	academicSessions : AcademicSessionSet - the set of grading periods that have been read from the service provider.
Behavior:	To read, get, a collection of grading periods i.e. all academic sessions.
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. The sort order should follow the [UNICODE, 16] standard. fields - to identify the range of fields that should be supplied in the response message.

Name:	getGradingPeriod ()
Return Function Parameter:	statusInfo : imsx_StatusInfo - the transaction-level status information 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 grading period.
Returned (out) Parameters:	academicSession : SingleAcademicSession - the grading period that has been read from the service provider.
Behavior:	To read, get, a specific grading period. If the specified grading period cannot be identified within the service provider then a status code of 'unknownobject' must be reported.
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:	getAllOrgs ()
Return Function Parameter:	statusInfo : imsx_StatusInfo - the transaction-level status information 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:	orgs : OrgSet - the set of orgs that have been read from the service provider.
Behavior:	To read, get, a collection of orgs i.e. all orgs.
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. The sort order should follow the [UNICODE, 16] standard. fields - to identify the range of fields that should be supplied in the response message.

Name:	getOrg ()
Return Function Parameter:	statusInfo : imsx_StatusInfo - the transaction-level status information 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 org.
Returned (out) Parameters:	org : SingleOrg - the org that has been read from the service provider.
Behavior:	To read, get, a specific org. If the specified org cannot be identified within the service provider then a status code of 'unknownobject' must be reported.
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:	getAllSchools ()
Return Function Parameter:	statusInfo : imsx_StatusInfo - the transaction-level status information 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:	orgs : OrgSet - the set of schools that have been read from the service provider.
Behavior:	To read, get, a collection of schools i.e. all schools.
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. The sort order should follow the [UNICODE, 16] standard. fields - to identify the range of fields that should be supplied in the response message.

Name:	getSchool ()
Return Function Parameter:	statusInfo : imsx_StatusInfo - the transaction-level status information 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 school.
Returned (out) Parameters:	org : SingleOrg - the school that has been read from the service provider.
Behavior:	To read, get, a specific school. If the specified school cannot be identified within the service provider then a status code of 'unknownobject' must be reported.
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:	getCoursesForSchool ()
Return Function Parameter:	statusInfo : imsx_StatusInfo - the transaction-level status information 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:	courses : CourseSet - the set of courses that have been read from the service provider.
Behavior:	To read, get, the collection of courses associated with a specific school. If the specified school cannot be identified within the service provider then a status code of 'unknownobject' must be reported.
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. The sort order should follow the [UNICODE, 16] standard. fields - to identify the range of fields that should be supplied in the response message.

Name:	getEnrollmentsForClassInSchool ()
Return Function Parameter:	statusInfo : imsx_StatusInfo - the transaction-level status information 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. classSourcedId : GUID - the unique identifier, GUID, for the class.
Returned (out) Parameters:	enrollments : EnrollmentSet - the set of enrollments that have been read from the service provider.
Behavior:	To read, get, the collection of enrollments associated with a specific class at a specific school. If the specified school and/or class cannot be identified within the service provider then a status code of 'unknownobject' must be reported.
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. The sort order should follow the [UNICODE, 16] standard. fields - to identify the range of fields that should be supplied in the response message.

Name:	getStudentsForClassInSchool ()
Return Function Parameter:	statusInfo : imsx_StatusInfo - the transaction-level status information 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 specific school. classSourcedId : GUID - the unique identifier, GUID, for the class.
Returned (out) Parameters:	students : UserSet - the set of students that have been read from the service provider.
Behavior:	To read, get, the collection of students associated with a specific class at a specific school. If the specified school and/or class cannot be identified within the service provider then a status code of 'unknownobject' must be reported.
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. The sort order should follow the [UNICODE, 16] standard. fields - to identify the range of fields that should be supplied in the response message.

IMS OneRoster Rostering Service Version 1.2

IMS Final ReleaseVersion 1.0

IMS Final Release
Version 1.0

Name:	getTeachersForClassInSchool ()
Return Function Parameter:	statusInfo : imsx_StatusInfo - the transaction-level status information 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 specific school. classSourcedId : GUID - the unique identifier, GUID, for the class.
Returned (out) Parameters:	teachers : UserSet - the set of teachers that have been read from the service provider.
Behavior:	To read, get, the collection of teachers associated with a specific class at a specific school. If the specified school and/or class cannot be identified within the service provider then a status code of 'unknownobject' must be reported.
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. The sort order should follow the [UNICODE, 16] standard. fields - to identify the range of fields that should be supplied in the response message.

Name:	getEnrollmentsForSchool ()
Return Function Parameter:	statusInfo : imsx_StatusInfo - the transaction-level status information 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 specific school.
Returned (out) Parameters:	enrollments : EnrollmentSet - the set of enrollments that have been read from the service provider.
Behavior:	To read, get, the collection of enrollments associated with a specific school. If the specified school cannot be identified within the service provider then a status code of 'unknownobject' must be reported.
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. The sort order should follow the [UNICODE, 16] standard. fields - to identify the range of fields that should be supplied in the response message.

Name:	getStudentsForSchool ()
Return Function Parameter:	statusInfo : imsx_StatusInfo - the transaction-level status information 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 specific school.
Returned (out) Parameters:	students : UserSet - the set of students that have been read from the service provider.
Behavior:	To read, get, the collection of students associated with a specific school. If the specified school cannot be identified within the service provider then a status code of 'unknownobject' must be reported.
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. The sort order should follow the [UNICODE, 16] standard. fields - to identify the range of fields that should be supplied in the response message.

Name:	getTeachersForSchool ()
Return Function Parameter:	statusInfo : imsx_StatusInfo - the transaction-level status information 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 specific school.
Returned (out) Parameters:	teachers : UserSet - the set of teachers that have been read from the service provider.
Behavior:	To read, get, the collection of teachers associated with a specific school. If the specified school cannot be identified within the service provider then a status code of 'unknownobject' must be reported.
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. The sort order should follow the [UNICODE, 16] standard. fields - to identify the range of fields that should be supplied in the response message.

Name:	getTermsForSchool ()
Return Function Parameter:	statusInfo : imsx_StatusInfo - the transaction-level status information 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 specific school.
Returned (out) Parameters:	terms : AcademicSessionSet - the set of terms that have been read from the service provider.
Behavior:	To read, get, the collection of terms associated with a specific school. If the specified school cannot be identified within the service provider then a status code of 'unknownobject' must be reported.
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. The sort order should follow the [UNICODE, 16] standard. fields - to identify the range of fields that should be supplied in the response message.

Name:	getClassesForSchool ()
Return Function Parameter:	statusInfo : imsx_StatusInfo - the transaction-level status information 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 specific school.
Returned (out) Parameters:	classes : ClassSet - the set of classes that have been read from the service provider.
Behavior:	To read, get, the collection of classes associated with a specific school. If the specified school cannot be identified within the service provider then a status code of 'unknownobject' must be reported.
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. The sort order should follow the [UNICODE, 16] standard. fields - to identify the range of fields that should be supplied in the response message.

Name:	getAllStudents ()
Return Function Parameter:	statusInfo : imsx_StatusInfo - the transaction-level status information 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:	users : UserSet - the set of students that have been read from the service provider.
Behavior:	To read, get, a collection of students i.e. all students.
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. The sort order should follow the [UNICODE, 16] standard. fields - to identify the range of fields that should be supplied in the response message.

Name:	getStudent ()
Return Function Parameter:	statusInfo : imsx_StatusInfo - the transaction-level status information 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 student.
Returned (out) Parameters:	user : SingleUser - the student that has been read from the service provider.
Behavior:	To read, get, a specific student. If the specified student cannot be identified within the service provider then a status code of 'unknownobject' must be reported.
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:	getClassesForStudent ()
Return Function Parameter:	statusInfo : imsx_StatusInfo - the transaction-level status information 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:	studentSourcedId : GUID - the unique identifier, GUID, for the specific student.
Returned (out) Parameters:	classes : ClassSet - the set of classes that have been read from the service provider.
Behavior:	To get the set of classes related to a specific student. If the specified student cannot be identified within the service provider then a status code of 'unknownobject' must be reported.
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. The sort order should follow the [UNICODE, 16] standard. fields - to identify the range of fields that should be supplied in the response message.

Name:	getAllTeachers ()
Return Function Parameter:	statusInfo : imsx_StatusInfo - the transaction-level status information 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:	users : UserSet - the set of teachers that have been read from the service provider.
Behavior:	To read, get, a collection of teachers i.e. all teachers.
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. The sort order should follow the [UNICODE, 16] standard. fields - to identify the range of fields that should be supplied in the response message.