Skip to main content

getAllEnrollments

GET 
/ims/oneroster/v1p1/enrollments

Return collection of all enrollments.

Request​

Query Parameters

    limit number

    Possible values: >= 1 and <= 2500

    Default value: 100

    The number of results to return

    Example: https://public-api-ap-se-2.ehgqa.com/ims/oneroster/v1p1/orgs?limit=10
    offset number

    The index of the first record to return. (zero indexed)

    Example: https://public-api-ap-se-2.ehgqa.com/ims/oneroster/v1p1/orgs?limit=10&offset=10
    sort string

    Default value: dateLastModified

    The sort query parameter allows collections to be returned in a specific order based on a single data element from the resource's core attributes. The sort parameter specifies the field to sort by (e.g., ?sort=familyName).

    Example: https://public-api-ap-se-2.ehgqa.com/ims/oneroster/v1p1/orgs?sort=familyName
    orderBy string

    Possible values: [asc, desc]

    Default value: desc

    orderBy MAY be used in the request to ask for the collection to be ordered ascending (asc) or descending (desc).

    Example: https://public-api-ap-se-2.ehgqa.com/ims/oneroster/v1p1/orgs?sort=familyName&orderBy=asc
    filter any

    Please find the following link to see information on filtering here.

Responses​

Schema
    enrollments object[]required
  • Array [
    • status stringrequired

    Possible values: [active, tobedeleted]

    dateLastModified stringrequired

    Date string (ISO 8601)

    sourcedId uuidrequired
    role objectrequired
    user objectrequired
    type string

    Possible values: [org, course, term, class, user, lineItem]

    sourcedId stringrequired
    class objectrequired
    type string

    Possible values: [org, course, term, class, user, lineItem]

    sourcedId stringrequired
    school objectrequired
    type string

    Possible values: [org, course, term, class, user, lineItem]

    sourcedId stringrequired
  • ]
Loading...