POST

/assignments/school/employee

Request Assignment objects for a specified Employee at a School.

Endpoint bewerken Terug naar API

Veldspecificaties

51 items
Path Naam Type Verplicht Beperkingen
request.body
body
 Object Nee - Bewerken
request.body.employee
employee
 Object Ja - Bewerken
request.body.employee.userIds
userIds

A secondary identifier for a User. This value is used whenever the primary identifier is not available. For Employees this value is mandatory. (either userMasterIdentifier or userIds is required)

 Lijst[] Nee - Bewerken
request.body.employee.userIds[*]
userIds

A secondary identifier for a User. This value is used whenever the primary identifier is not available. For Employees this value is mandatory. (either userMasterIdentifier or userIds is required)

 Object Nee - Bewerken
request.body.employee.userIds[*].userId
userId
 Tekenreeks Ja - Bewerken
request.body.employee.userIds[*].userIdType
userIdType
 Keuzelijst Ja toegestaan ["NEPPI","BPI","eduID","NEPRI","ASI","eckId"] Bewerken
request.body.employee.userMasterIdentifier
userMasterIdentifier

The primary identifier for a User. For Students the ECK iD is used. For Employees this value is empty. There is no primary identifier for Employees. (either userMasterIdentifier or userIds is required)

 Tekenreeks Nee - Bewerken
request.body.school
school

A reference to a School organisation.

 Object Ja - Bewerken
request.body.school.organisationIds
organisationIds

A secondary identifier for the School. This value is used whenever the primary identifier is not available. (either organisationMasterIdentifier or organisationIds is required)

 Lijst[] Nee - Bewerken
request.body.school.organisationIds[*]
organisationIds

A secondary identifier for the School. This value is used whenever the primary identifier is not available. (either organisationMasterIdentifier or organisationIds is required)

 Object Nee - Bewerken
request.body.school.organisationIds[*].organisationId
organisationId
 Tekenreeks Ja - Bewerken
request.body.school.organisationIds[*].organisationIdType
organisationIdType
 Keuzelijst Ja toegestaan ["OIE_CODE","BP_ID","DD_ID","AS_ID","V_ID"] Bewerken
request.body.school.organisationMasterIdentifier
organisationMasterIdentifier

The primary identifier for a School. For Schools the OnderwijsaanbiederId is used. (either organisationMasterIdentifier or organisationIds is required)

 Tekenreeks Nee - Bewerken
request.query.assignmentType
assignmentType

Optional filter to request all Assignment objects for a specified assignmentType.

 Keuzelijst Nee toegestaan ["class-teacher","teacher","coach"] Bewerken
request.query.schoolPeriodId
schoolPeriodId

Optional filter to request all Assignment objects within a specified SchoolPeriod and its corresponding schoolPeriodId.

 Tekenreeks Nee - Bewerken
response.200
response 200

OK

 Lijst[] Nee - Bewerken
response.200[*]
response 200

The Assignment object for an employee to a Group or Student for a SchoolPeriod.

 Object Nee - Bewerken
response.200[*].assignmentId
assignmentId

A unique identifier for this Assignment object. This is the identifier that Consumers will refer to when making API calls, or when needing to identify an object.

 Tekenreeks Ja - Bewerken
response.200[*].assignmentType
assignmentType

The type of assignment, being one of:

  • class-teacher: an assignment to a class.
  • teacher: an assignment to a lesson group for a subject.
  • coach: an assignment to an individual student.
 Keuzelijst Ja toegestaan ["class-teacher","teacher","coach"] Bewerken
response.200[*].beginDate
beginDate

The start date on which the assignment becomes active (inclusive). Format: YYYY-MM-DD (according to RFC3339).

 Datum Ja - Bewerken
response.200[*].dateCreated
dateCreated

Indicates the date and time the object was first created. Format: According to openapi in ZULU time as specified in RFC 3339, section 5.6.

 Datum/tijd Ja - Bewerken
response.200[*].dateLastModified
dateLastModified

Indicates the date and time the object was last modified. Format: According to openapi in ZULU time as specified in RFC 3339, section 5.6.

 Datum/tijd Ja - Bewerken
response.200[*].employee
employee

The Employee to which this assignment object belongs.

 Object Ja - Bewerken
response.200[*].employee.userIds
userIds

A secondary identifier for a User. This value is used whenever the primary identifier is not available. For Employees this value is mandatory. (either userMasterIdentifier or userIds is required)

 Lijst[] Nee - Bewerken
response.200[*].employee.userIds[*]
userIds

A secondary identifier for a User. This value is used whenever the primary identifier is not available. For Employees this value is mandatory. (either userMasterIdentifier or userIds is required)

 Object Nee - Bewerken
response.200[*].employee.userIds[*].userId
userId
 Tekenreeks Ja - Bewerken
response.200[*].employee.userIds[*].userIdType
userIdType
 Keuzelijst Ja toegestaan ["NEPPI","BPI","eduID","NEPRI","ASI","eckId"] Bewerken
response.200[*].employee.userMasterIdentifier
userMasterIdentifier

The primary identifier for a User. For Students the ECK iD is used. For Employees this value is empty. There is no primary identifier for Employees. (either userMasterIdentifier or userIds is required)

 Tekenreeks Nee - Bewerken
response.200[*].endDate
endDate

The end date on which the assignment becomes inactive (exclusive). Format: YYYY-MM-DD (according to RFC3339).

 Datum Nee - Bewerken
response.200[*].group
group

A reference to the groupId of the Group in case this assignment is of the assignmentType class-teacher or teacher and the student is assigned to a Group for a single subject .

 Tekenreeks Nee - Bewerken
response.200[*].schoolPeriod
schoolPeriod

A reference to the schoolPeriodId of the SchoolPeriod where this assignment is part of.

 Tekenreeks Ja - Bewerken
response.200[*].status
status

The status field gives an indication to Consumers about the status of an object. Consumers can delete objects that are flagged tobedeleted as such if they wish.

The status attribute is based on the Base Class from OneRoster.

 Keuzelijst Ja toegestaan ["active","tobedeleted"] Bewerken
response.200[*].student
student

A reference to a Student in case this assignment is of the assignmentType coach.

 Object Nee - Bewerken
response.200[*].student.userIds
userIds

A secondary identifier for a User. This value is used whenever the primary identifier is not available. For Employees this value is mandatory. (either userMasterIdentifier or userIds is required)

 Lijst[] Nee - Bewerken
response.200[*].student.userIds[*]
userIds

A secondary identifier for a User. This value is used whenever the primary identifier is not available. For Employees this value is mandatory. (either userMasterIdentifier or userIds is required)

 Object Nee - Bewerken
response.200[*].student.userIds[*].userId
userId
 Tekenreeks Ja - Bewerken
response.200[*].student.userIds[*].userIdType
userIdType
 Keuzelijst Ja toegestaan ["NEPPI","BPI","eduID","NEPRI","ASI","eckId"] Bewerken
response.200[*].student.userMasterIdentifier
userMasterIdentifier

The primary identifier for a User. For Students the ECK iD is used. For Employees this value is empty. There is no primary identifier for Employees. (either userMasterIdentifier or userIds is required)

 Tekenreeks Nee - Bewerken
response.200[*].subject
subject

A reference to the subjectOfferingId of the SubjectOffering in case this assignment is of the assignmentType teacher.

 Tekenreeks Nee - Bewerken
response.400
response 400

Functional status code and status message.

 Object Nee - Bewerken
response.400.status
status

See functional status codes within the Documentation.

 Geheel getal Ja - Bewerken
response.400.statusMessage
statusMessage

See functional status messages within the Documentation.

 Tekenreeks Nee - Bewerken
response.401
response 401

Functional status code and status message.

 Object Nee - Bewerken
response.401.status
status

See functional status codes within the Documentation.

 Geheel getal Ja - Bewerken
response.401.statusMessage
statusMessage

See functional status messages within the Documentation.

 Tekenreeks Nee - Bewerken
response.403
response 403

Functional status code and status message.

 Object Nee - Bewerken
response.403.status
status

See functional status codes within the Documentation.

 Geheel getal Ja - Bewerken
response.403.statusMessage
statusMessage

See functional status messages within the Documentation.

 Tekenreeks Nee - Bewerken
response.404
response 404

Functional status code and status message.

 Object Nee - Bewerken
response.404.status
status

See functional status codes within the Documentation.

 Geheel getal Ja - Bewerken
response.404.statusMessage
statusMessage

See functional status messages within the Documentation.

 Tekenreeks Nee - Bewerken

Verwachte statuscodes

5 items
Code Betekenis Uitkomst
200 OK Succes Bewerken
400 Bad Request Fout Bewerken
401 Unauthorized Fout Bewerken
403 Forbidden Fout Bewerken
404 Not Found Fout Bewerken