Veldspecificaties

38 items
Veld Beschrijving Type Verplicht Beperkingen
request.query.orgMasterId
orgMasterId
Tekenreeks Nee -
request.query.orgId
orgId
Tekenreeks Nee -
request.query.orgIdType
orgIdType
Keuzelijst Nee -
request.query.filterByOrgId
filterByOrgId
Boolean Nee -
request.query.schoolPeriodId
schoolPeriodId
Tekenreeks Nee -
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/school:
    parameters:
      - schema:
          type: string
        name: orgMasterId
        in: query
        required: false
        description: |
          The organisationMasterIdentifier of the school.
          This parameter is used when the primary identifier for a school (being the `OnderwijsaanbiederId`) is available.
      - schema:
          type: string
        name: orgId
        in: query
        required: false
        description: |
          The organisationIdentifier (secondary identifier) of the school.
          This parameter is used in combination with the orgIdType when the organisationMasterIdentifier is not available.
      - schema:
          type: string
          example: DD_ID
          enum:
            - OIE_CODE
            - BP_ID
            - DD_ID
            - AS_ID
            - V_ID
        name: orgIdType
        in: query
        required: false
        description: |
          The type of the organisationIdentifier.
          This parameter is used in combination with the orgId when the organisationMasterIdentifier is not available.
          The following values are supported:
          - `OIE_CODE`: OnderwijsInstellingserkenningcode
          - `BP_ID`: Basispoort-generated identifier for the school
          - `DD_ID`: DigiDeliveryId generated by the Central Registration of Edu-iX
          - `AS_ID`: LAS-generated identifier (LAS-Key) for the school
          - `V_ID`: VestigingsId – BRIN6-format identifier, including dummy locations
      - schema:
          type: boolean
        name: filterByOrgId
        in: query
        required: false
        description: |
          Controls whether the response is filtered to only include Employees belonging to the
          specific organisation identified by `orgId` and `orgIdType`, or whether all Employees
          of the associated Onderwijsaanbieder are returned.
          - `true`: Only Employees belonging to the specified secondary identifier are returned.
          - `false`: All Employees of the associated Onderwijsaanbieder are returned (to the extent authorisations have been configured).
          When omitted, a sector-specific default applies:
          - **PO (primary education):** defaults to `true` – response is filtered to the specified identifier.
          - **VO (secondary education):** defaults to `false` – response covers the full Onderwijsaanbieder scope.
          This parameter is only relevant in combination with `orgId` and `orgIdType`.
          When `orgMasterId` is used, this parameter must be absent or `false`.
          It is the responsibility of the consuming party to verify whether the Source supports
          filtering via this parameter before using it.
      - schema:
          type: string
        name: schoolPeriodId
        in: query
        required: false
        description: 'Optional filter to request all Employee objects within a specified SchoolPeriod and its corresponding schoolPeriodId.'
    get:
      summary: Get Employees for School
      x-tags:
        - Employee
      tags:
        - Administratiesysteem onderwijsmedewerker
      operationId: get-employees-for-school
      description: 'Request all Employee objects including basic information (identifiers and names) for a specified school.'
      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