getClassesForTeacher

GET 
/ims/oneroster/v1p1/teachers/:teacherId/classes

Return the collection of classes that this teacher is teaching.

Request

Path Parameters

id uuidrequired
Teacher id
Example: 3a3a8554-daa0-45ff-8fbe-347c8853d4ec

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

200

application/json

Schema

Schema

classes object[]required
Array [
status stringrequired
Possible values: [active, tobedeleted]
dateLastModified stringrequired
Date string (ISO 8601)
sourcedId uuidrequired
title stringrequired
classType objectrequired
classCode string
course objectrequired
sourcedId uuidrequired
type stringrequired
school objectrequired
sourcedId uuidrequired
type stringrequired
terms object[]required
Array [
type string
Possible values: [org, course, term, class, user, lineItem]
sourcedId stringrequired
]
subjects string[]
subjectCodes string[]
]

Example (from schema)

{
  "classes": [
    {
      "status": "active",
      "dateLastModified": "string",
      "sourcedId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "title": "string",
      "classType": {},
      "classCode": "string",
      "course": {
        "sourcedId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "type": "string"
      },
      "school": {
        "sourcedId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "type": "string"
      },
      "terms": [
        {
          "type": "org",
          "sourcedId": "string"
        }
      ],
      "subjects": [
        "string"
      ],
      "subjectCodes": [
        "string"
      ]
    }
  ]
}

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Loading...