Skip to main content
POST
/
ims
/
oneroster
/
rostering
/
v1p2
/
enrollments
Create a new Enrollment
curl --request POST \
  --url https://api.alpha-1edtech.ai/ims/oneroster/rostering/v1p2/enrollments/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "enrollment": {
    "role": "administrator",
    "user": {
      "sourcedId": "<string>"
    },
    "class": {
      "sourcedId": "<string>"
    },
    "sourcedId": "<string>",
    "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
      }
    },
    "primary": "false",
    "beginDate": "2024-01-01",
    "endDate": "2024-01-01",
    "school": {
      "sourcedId": "<string>"
    }
  }
}
'
{
  "sourcedIdPairs": {
    "suppliedSourcedId": "<string>",
    "allocatedSourcedId": "<string>"
  }
}

Authorizations

Authorization
string
header
required

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

Body

application/json
enrollment
object
required

Response

Successfully created

sourcedIdPairs
object
required