POST

/students

Request a Student object for a specified Student at a School.

Terug naar Students

Veldspecificaties

51 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. (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. (either userMasterIdentifier or userIds is required)

 Lijst[] Nee -
response..userIds[*]
userIds

A secondary identifier for a User. This value is used whenever the primary identifier is not available. (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 the Student. For Students the ECK iD is used.

 Tekenreeks Nee -
response.200.userIds
userIds

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

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

A secondary identifier for a User. This value is used whenever the primary identifier is not available. (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"]
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.dateOfBirth
dateOfBirth

format: YYYY-MM-DD (according to RFC3339)

 Datum Nee -
response.200.gender
gender

The gender of the Student. The following values are used: - female: gender is Female - male: gender is Male - other: gender that is known but which is not either Male or Female. - unspecified: unspecified as no data entry for this field has been made.

 Keuzelijst Nee toegestaan ["female","male","other","unspecified"]
response.200.email
email

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

 Tekenreeks Nee -
response.200.language
language

The language preference of the Student. Format according to ISO639 Set 3 values for Language tags. On Wikipedia an example list can be found.

 Tekenreeks Nee -
response.200.accessibility
accessibility

Accessibility preferences for this student. Based on IMS Global Access for All (AfA) Personal Needs and Preferences (PNP) Information model

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

Accessibility preferences for this student. Based on IMS Global Access for All (AfA) Personal Needs and Preferences (PNP) Information model

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

The home address of the Student.

 Object Nee -
response.200.street
street
 Tekenreeks Ja -
response.200.houseNumber
houseNumber

the house number

 Geheel getal Ja -
response.200.houseNumberSuffix
houseNumberSuffix

additions to the house number, e.g. A or -104

 Tekenreeks Nee -
response.200.zipCode
zipCode
 Tekenreeks Ja -
response.200.city
city
 Tekenreeks Ja -
response.200.countryCode
countryCode

According to Alpha-2 code from ISO 3166, e.g. NL

 Tekenreeks Nee -
response.200.country
country
 Tekenreeks Ja -
response.200.country
country
 Tekenreeks 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.

  /students:
    post:
      summary: Search Student
      x-tags:
        - Student
      tags:
        - Administratiesysteem onderwijsdeelnemer
      operationId: search-student
      description: 'Request a Student object for a specified Student at a School.'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                school:
                  $ref: '#/components/schemas/SchoolReference'
                student:
                  $ref: '#/components/schemas/UserReference'
              required:
                - school
                - student
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Student'
        '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.student.basic
            - eduv.student.demographics
            - eduv.student.communication
            - eduv.student.accessibility
            - eduv.student.deliveryaddress