Skip to main content
GET
/
ims
/
oneroster
/
rostering
/
v1p2
/
enrollments
/
{sourcedId}
Get a specific Enrollment
curl --request GET \
  --url https://api.alpha-1edtech.ai/ims/oneroster/rostering/v1p2/enrollments/{sourcedId} \
  --header 'Authorization: Bearer <token>'
{
  "enrollment": {
    "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": {}
  }
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
sourcedId
string
required

The unique identifier for the enrollment

Query Parameters

​
fields
string

Comma-separated list of fields to include in the response

Example:

"sourcedId,name"

Response

Successful response

​
enrollment
object
required

Represents an enrollment.