getTeacher

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

Return specific teacher

Request

Path Parameters

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

Responses

200

application/json

Schema

Schema

user objectrequired
status stringrequired
Possible values: [active, tobedeleted]
dateLastModified stringrequired
Date string (ISO 8601)
enabledUser stringrequired
Possible values: [true, false]
Boolean string
role stringrequired
Possible values: [administrator, aide, guardian, parent, proctor, relative, student, teacher]
sourcedId uuidrequired
username stringrequired
givenName stringrequired
familyName stringrequired
email string
identifier stringrequired
orgs object[]required
Array [
type string
Possible values: [org, course, term, class, user, lineItem]
sourcedId stringrequired
]

Example (from schema)

{
  "user": {
    "status": "active",
    "dateLastModified": "string",
    "enabledUser": "true",
    "role": "administrator",
    "sourcedId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "username": "string",
    "givenName": "string",
    "familyName": "string",
    "email": "string",
    "identifier": "string",
    "orgs": [
      {
        "type": "org",
        "sourcedId": "string"
      }
    ]
  }
}

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Loading...