Skip to main content
PATCH
/
ims
/
oneroster
/
rostering
/
v1p2
/
enrollments
/
{sourcedId}
Partially Update an Enrollment
curl --request PATCH \
  --url https://api.alpha-1edtech.ai/ims/oneroster/rostering/v1p2/enrollments/{sourcedId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "enrollment": {
    "status": "active",
    "metadata": {
      "goals": {
        "dailyXp": 123,
        "dailyLessons": 123,
        "dailyActiveMinutes": 123,
        "dailyAccuracy": 123,
        "dailyMasteredUnits": 123
      },
      "metrics": {
        "totalXp": 123,
        "totalLessons": 123,
        "totalGrades": 123,
        "courseType": "<string>",
        "isSupplemental": true
      }
    },
    "role": "administrator",
    "primary": "false",
    "beginDate": "2024-01-01",
    "endDate": "2024-01-01",
    "user": {
      "sourcedId": "<string>"
    },
    "class": {
      "sourcedId": "<string>"
    },
    "school": {
      "sourcedId": "<string>"
    }
  }
}
'
{}

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 to update

Body

application/json
enrollment
object
required

Response

Successfully updated

The response is of type object.