POST

/employees

Request an Employee object for a specified Employee at a School.

Endpoint bewerken Terug naar API

Veldspecificaties

54 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[] 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)

 Object Ja - 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
response.200
response 200

OK

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

The Employee object with its identifiers and name information.

Based on the scopes additional attributes can be included in this object.

employee.communication

Communication data of the Employee. For Employees this is the e-mail address, phone number or mobile phone number as provided by the School.

employee.roles

organisationRoles of the Employee within the school.

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

An additional field to distinct employees on screen who carry the same name.

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

Indicates the date and time the object was first created. Format: Conform openapi in ZULU time zoals gespecificeerd 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: Conform openapi in ZULU time zoals gespecificeerd in RFC 3339, section 5.6.

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

E-mail address hosted by school (e.g. L123456@school.nl).

 Tekenreeks Nee - Bewerken
response.200[*].familyName
familyName
 Tekenreeks Ja - Bewerken
response.200[*].familyNamePrefix
familyNamePrefix
 Tekenreeks Nee - Bewerken
response.200[*].givenName
givenName
 Tekenreeks Ja - Bewerken
response.200[*].mobile
mobile

Mobile phone number as provided by the school.

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

The organisation roles the Employee has within the organisation.

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

The organisation roles the Employee has within the organisation.

 Object Nee - Bewerken
response.200[*].organisationRoles[*].beginDate
beginDate

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

 Datum Ja - Bewerken
response.200[*].organisationRoles[*].endDate
endDate

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

 Datum Nee - Bewerken
response.200[*].organisationRoles[*].organisation
organisation

A reference to a School organisation.

 Object Ja - Bewerken
response.200[*].organisationRoles[*].organisation.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
response.200[*].organisationRoles[*].organisation.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
response.200[*].organisationRoles[*].organisation.organisationIds[*].organisationId
organisationId
 Tekenreeks Ja - Bewerken
response.200[*].organisationRoles[*].organisation.organisationIds[*].organisationIdType
organisationIdType
 Keuzelijst Ja toegestaan ["OIE_CODE","BP_ID","DD_ID","AS_ID","V_ID"] Bewerken
response.200[*].organisationRoles[*].organisation.organisationMasterIdentifier
organisationMasterIdentifier

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

 Tekenreeks Nee - Bewerken
response.200[*].organisationRoles[*].organisationRole
organisationRole

The organisation role the Employee has within the organisation.

 Keuzelijst Ja toegestaan ["administratief-medewerker","applicatiebeheerder","begeleider","invalkracht","ibp-er","leermiddelencoordinator","leraar","mentor","onderwijsbestuurder","onderwijsdirecteur","stagiair"] Bewerken
response.200[*].phone
phone

Phone number as provided by the school.

 Tekenreeks Nee - Bewerken
response.200[*].preferredFirstName
preferredFirstName
 Tekenreeks Nee - 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[*].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[] Ja - Bewerken
response.200[*].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 Ja - Bewerken
response.200[*].userIds[*].userId
userId
 Tekenreeks Ja - Bewerken
response.200[*].userIds[*].userIdType
userIdType
 Keuzelijst Ja toegestaan ["NEPPI","BPI","eduID","NEPRI","ASI","eckId"] Bewerken
response.200[*].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.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