POST

/employees

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

Terug naar Employees

Veldspecificaties

45 items
Veld Beschrijving Type Verplicht Beperkingen
response.
response

A reference to a School organisation.

 Object Nee -
response..organisationMasterIdentifier
organisationMasterIdentifier

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

 Tekenreeks Nee -
response..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 -
response..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 -
response..organisationIds[*].organisationId
organisationId
 Tekenreeks Ja -
response..organisationIds[*].organisationIdType
organisationIdType
 Keuzelijst Ja toegestaan ["OIE_CODE","BP_ID","DD_ID","AS_ID","V_ID"]
response.
response
Object Nee -
response..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 -
response..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 -
response..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 -
response..userIds[*].userId
userId
 Tekenreeks Ja -
response..userIds[*].userIdType
userIdType
 Keuzelijst Ja toegestaan ["NEPPI","BPI","eduID","NEPRI","ASI","eckId"]
response.200
response 200
 Object Nee -
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 -
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 -
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 Nee -
response.200.userIds[*].userId
userId
 Tekenreeks Ja -
response.200.userIds[*].userIdType
userIdType
 Keuzelijst Ja toegestaan ["NEPPI","BPI","eduID","NEPRI","ASI","eckId"]
response.200.givenName
givenName
 Tekenreeks Ja -
response.200.preferredFirstName
preferredFirstName
 Tekenreeks Nee -
response.200.familyName
familyName
 Tekenreeks Ja -
response.200.familyNamePrefix
familyNamePrefix
 Tekenreeks Nee -
response.200.email
email

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

 Tekenreeks Nee -
response.200.phone
phone

Phone number as provided by the school.

 Tekenreeks Nee -
response.200.mobile
mobile

Mobile phone number as provided by the school.

 Tekenreeks Nee -
response.200.organisationRoles
organisationRoles

The organisation roles the Employee has within the organisation.

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

The organisation roles the Employee has within the organisation.

 Object Nee -
response.200.organisationRoles[*].userId
userId
 Tekenreeks Ja -
response.200.organisationRoles[*].userIdType
userIdType
 Keuzelijst Ja toegestaan ["NEPPI","BPI","eduID","NEPRI","ASI","eckId"]
response.200.alias
alias

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

 Tekenreeks Nee -
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"]
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 -
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 -
response.400
response 400

Functional status code and status message.

 Object Nee -
response.400.status
status

See functional status codes within the Documentation.

 Geheel getal Ja -
response.400.statusMessage
statusMessage

See functional status messages within the Documentation.

 Tekenreeks Nee -
response.401
response 401

Functional status code and status message.

 Object Nee -
response.401.status
status

See functional status codes within the Documentation.

 Geheel getal Ja -
response.401.statusMessage
statusMessage

See functional status messages within the Documentation.

 Tekenreeks Nee -
response.403
response 403

Functional status code and status message.

 Object Nee -
response.403.status
status

See functional status codes within the Documentation.

 Geheel getal Ja -
response.403.statusMessage
statusMessage

See functional status messages within the Documentation.

 Tekenreeks Nee -
response.404
response 404

Functional status code and status message.

 Object Nee -
response.404.status
status

See functional status codes within the Documentation.

 Geheel getal Ja -
response.404.statusMessage
statusMessage

See functional status messages within the Documentation.

 Tekenreeks Nee -

Verwachte statuscodes

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

Bronspecificatie (YAML)

Ruwe definitie uit het afsprakenstelsel.

  /employees:
    post:
      summary: Search Employee
      x-tags:
        - Employee
      tags:
        - Administratiesysteem onderwijsmedewerker
      operationId: search-employee
      description: 'Request an Employee object for a specified Employee at a School.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                school:
                  $ref: '#/components/schemas/SchoolReference'
                employee:
                  $ref: '#/components/schemas/UserReference'
              required:
                - school
                - employee
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Employee'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatusResponse'
      security:
        - OAuth2:
            - eduv.employee.basic
            - eduv.employee.communication
            - eduv.employee.roles