OneRoster Absence v1p0
OneRoster Absences provides read-only access to student absences based on the 1EdTech OneRoster Specification: Norwegian Profile: Spec Version 1.0.
Note: This API is currently in beta and subject to change. The standard is still evolving and not yet finalized. The API may change, as the working group continues to evolve the specification.
Base URL
https://api.<environment>.onedhub.io/<orgId>/ims/oneroster/absences/v1p0/
For more information about environments and URL structure, see the environments section.
Open API Specifications
Note: The Open API specifications are currently not available.
You can find the Open API specifications for the different environments at the following URLs:
https://api.<environment>.onedhub.io/<orgId>/ims/oneroster/absences/v1p0/swagger-ui/index.html
Examples:
* https://api.staging.onedhub.io/vigilo.no/ims/oneroster/absences/v1p0//swagger-ui/index.html* https://api.onedhub.io/vigilo.no/ims/oneroster/absences/v1p0//swagger-ui/index.html
Authentication
Authentication follows the same OAuth 2.0 client credentials flow as the rest of OnEdHub. See Authentication for details.
The following scopes grant access to the Gradebook API:
| Scope | Description |
|---|---|
roster.readonly | Full read access to rostering and gradebook data |
roster-core.readonly | Read access to core rostering and gradebook data |
Endpoints
Absence Details
| Method | Endpoint | Description |
|---|---|---|
GET | /absences/detail | Returns all absences |
GET | /absences/detail/{sourcedId} | Returns a single result by sourcedId |
Query Parameters
All collection endpoints support the following query parameters:
| Parameter | Type | Default | Description |
|---|---|---|---|
limit | integer | 100 | Maximum number of records to return |
offset | integer | 0 | Number of records to skip before returning results |
sort | String | — | Field name to sort by (e.g. dateLastModified) |
orderBy | String | asc | Sort direction: asc or desc |
filter | String | — | Filter expression (e.g. student.sourcedId='abc') |
fields | — |
Data Models
See the Primitive Data-types for more details on the primitive data types used in OneRoster.
AbsenceDetails
A AbsenceDetails represents a student's absence record.
AbsenceDetails is an immutable resource. Any changes to an AbsenceDetails must be done by creating a new AbsenceDetails resource. You can see the whole chain of changes by following the replacedBy and replaces fields.
| Field | Type | Cardinality | Description |
|---|---|---|---|
sourcedId | String | 1 | See "sourcedId" Attribute Description |
status | String | 1 | See "status" Attribute Description |
dateLastModified | DateTime | 1 | See "dateLastModified" Attribute Description |
metadata | Metadata | 0..1 | See Metadata |
fromTime | DateTime | 1 | The timestamp for the start time of the absence. The format MUST be 'YYYY-MM-DDTHH:MM:SSZ'. Full-day absence is indicated with time 00:00:00. |
toTime | DateTime | 1 | The timestamp for the end time of the absence. The format MUST be 'YYYY-MM-DDTHH:MM:SSZ'. Full-day absence is indicated with time 00:00:00. |
absenceDurationUnit | AbsenceDurationUnit | 1 | Could be either Days or Minutes |
absenceDurationValue | NonNegativeInteger | 1 | The duration of absence in either minutes or days. |
registeredInfo | SignRegInfo | 1 | See SignRegInfo |
signingInfo | SignRegInfo | 1 | See SignRegInfo |
classesAffected | GUIDRef | 0..1 | See GUIDRef |
school | GUIDRef | 1..* | See GUIDRef |
student | GUIDRef | 1 | See GUIDRef |
term | GUIDRef | 1 | See GUIDRef |
deletedTime | DateTime | 0..1 | The timestamp for when the absence was removed. |
replaces | GUIDRef | 0..1 | If a absence is update a new absence will occure. This is a refrence to the absance being replaced. See GUIDRef |
replacedBy | GUIDRef | 0..1 | If a absence is update a new absence will occure. This is a refrence to the absance replaceing the absence. See GUIDRef |
SignRegInfo
| Field | Type | Cardinality | Description |
|---|---|---|---|
time | DateTime | 1 | The timestamp for when the absence was registered/signed. |
comment | String | 0..1 | A comment on the absence. |
byUserId | GUIDRef | 1 | See GUIDRef |
GUIDRef
A GUIDRef is a lightweight reference to another resource. It contains:
| Field | Type | Cardinality | Description |
|---|---|---|---|
sourcedId | String | 1 | See "sourcedId" Attribute Description |
type | String | 1 | The resource type (e.g. user, class, lineItem) |
href | String | 1 | The full URL to retrieve the referenced resource |
Metadata
Metadata provides additional information about a resource. It contains:
| Field | Type | Cardinality | Description |
|---|---|---|---|
1edtech.language | String | 1 | Is always nb-NO |