Overview
Caliper
CASE
CLR
EduBridge
OneRoster
- GETGet Score Scales for a School
- GETGet all Schools
- POSTCreate a new School
- GETGet a specific School
- PUTUpdate a School
- DELDelete a School
- GETGet Line Items for a School
- POSTCreate Line Items for a School
- GETGet all Classes for a School
- GETGet all Terms for a School
- GETGet Teachers for a specific Class in a School
- GETGet all teachers for a school
- GETGet Students for a specific Class in a School
- GETGet all Students for a School
- GETGet Enrollments for a specific Class in a School
- GETGet all Enrollments for a School
- GETGet all Courses for a School
PowerPath
QTI
Timeback Events
Webhooks
curl --request GET \
--url https://api.alpha-1edtech.ai/ims/oneroster/rostering/v1p2/schools/{schoolSourcedId}/classes/{classSourcedId}/enrollments \
--header 'Authorization: Bearer <token>'{
"enrollments": [
{
"sourcedId": "<string>",
"status": "active",
"role": "administrator",
"primary": "false",
"beginDate": "2024-01-01",
"endDate": "2024-01-01",
"user": {
"href": "<string>",
"sourcedId": "<string>",
"type": "<string>",
"name": "<string>"
},
"class": {
"href": "<string>",
"sourcedId": "<string>",
"type": "<string>",
"name": "<string>"
},
"school": {
"href": "<string>",
"sourcedId": "<string>",
"type": "<string>",
"name": "<string>"
},
"course": {
"href": "<string>",
"sourcedId": "<string>",
"type": "<string>",
"name": "<string>"
},
"dateLastModified": "2023-11-07T05:31:56Z",
"metadata": {}
}
],
"totalCount": 123,
"pageCount": 123,
"pageNumber": 123,
"offset": 123,
"limit": 123
}Get Enrollments for a specific Class in a School
To get all Enrollments for a Class in a School on the service provider. If the specified school and/or class cannot be identified within the service provider, the api will return a 404 error code and message ‘School or class not found.’
curl --request GET \
--url https://api.alpha-1edtech.ai/ims/oneroster/rostering/v1p2/schools/{schoolSourcedId}/classes/{classSourcedId}/enrollments \
--header 'Authorization: Bearer <token>'{
"enrollments": [
{
"sourcedId": "<string>",
"status": "active",
"role": "administrator",
"primary": "false",
"beginDate": "2024-01-01",
"endDate": "2024-01-01",
"user": {
"href": "<string>",
"sourcedId": "<string>",
"type": "<string>",
"name": "<string>"
},
"class": {
"href": "<string>",
"sourcedId": "<string>",
"type": "<string>",
"name": "<string>"
},
"school": {
"href": "<string>",
"sourcedId": "<string>",
"type": "<string>",
"name": "<string>"
},
"course": {
"href": "<string>",
"sourcedId": "<string>",
"type": "<string>",
"name": "<string>"
},
"dateLastModified": "2023-11-07T05:31:56Z",
"metadata": {}
}
],
"totalCount": 123,
"pageCount": 123,
"pageNumber": 123,
"offset": 123,
"limit": 123
}Documentation Index
Fetch the complete documentation index at: https://docs.timeback.com/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
School sourced ID
Class sourced ID
Query Parameters
Comma-separated list of fields to include in the response
"sourcedId,name"
The maximum number of items to return in the paginated response. While the OneRoster specification does not define a maximum limit, this implementation enforces a maximum of 3000 to prevent abuse and ensure optimal performance.
1 <= x <= 3000100
The number of items to skip in the paginated response
x >= 00
The field to sort the response by
The order to sort the response by
asc, desc The filter to apply to the response
"status='active'"
PROPRIETARY EXTENSION: Free-text search across multiple fields. Provides convenient text-based querying beyond the standard OneRoster filter parameter.
"john"