GET

/enrollments/school

Association API (PullSynchronous) · ADMINISTRATIESYSTEEMONDERWIJSDEELNEMER - Administratiesysteem onderwijsdeelnemer · Ontvanger / PullSynchronous / Server

Terug naar sandbox

Sandbox endpoint

http://eduvtestlab.bloemendaalconsultancy.nl/sandbox/11111111-1111-1111-1111-111111111111/api/enrollments/school

Request Enrollment objects for a specified School.

Databankdekking

Hosted sandbox gebruikt faker fallback
Captures
0
0 requests · 0 responses
Laatst: -
Validatie
0 valide
0 ongeldig volgens huidige fieldspecs
Verouderde specificatie
0 captures
Gebaseerd op deprecated runtimeversies

Bad flows

Code Status HTTP
0000
OK
Bevraging succesvol.
 200
0001
Created
Bericht heeft geleid tot registratie van een nieuwe entiteit.
 201
0002
Accepted
Bericht geaccepteerd.
 202
0011
Schema incorrect
Schemavalidatie niet succesvol
 400
0012
schemaVersion not supported
De ontvanger kan de gehanteerde schemaVersion niet verwerken
 400
0021
scope required
Deelnemer is niet geautoriseerd voor scope
 401
0022
consent required
Het informatieobject is van classificatie IV. Dit vereist een activering van de gegevensdienst. Dit is in dit foutscenario niet het geval.
 403
0023
school unknown
De client communiceert in de context van een Onderwijsorganisatie die niet bekend is bij server
 400
0099
Vullingsregel: in statusMessage een beschrijving van de reden opnemen
Overige reden
 400
2001
School unknown
De identifier van de onderwijsorganisatie is onbekend.
 - Negatieve flow
2002
SubjectOffering unknown
De identifier van het SchoolVak is onbekend.
 - Negatieve flow
2003
StudyOffering unknown
De aangeboden opleiding is onbekend.
 - Negatieve flow
2008
SchoolPeriod unknown
De identifier van de schoolperiode is onbekend.
 - Negatieve flow

Statuscodes

HTTP Betekenis
200 OK Succes
400 Bad Request Foutpad
401 Unauthorized Foutpad
403 Forbidden Foutpad
404 Not Found Foutpad

Recente databankcaptures

Geen captures beschikbaar
Dit endpoint heeft nog geen opgeslagen request- of responsepayloads in de gedeelde databank.

Veldspecificaties

Pad Naam Type Verplicht Regels
request.query.enrollmentType enrollmentType Enum Nee Min: - · Max: - · Pattern: -
request.query.filterByOrgId filterByOrgId Boolean Nee Min: - · Max: - · Pattern: -
request.query.orgId orgId String Nee Min: - · Max: - · Pattern: -
request.query.orgIdType orgIdType Enum Nee Min: - · Max: - · Pattern: -
request.query.orgMasterId orgMasterId String Nee Min: - · Max: - · Pattern: -
request.query.schoolPeriodId schoolPeriodId String Nee Min: - · Max: - · Pattern: -
request.query.studyOfferingId studyOfferingId String Nee Min: - · Max: - · Pattern: -
request.query.subjectOfferingId subjectOfferingId String Nee Min: - · Max: - · Pattern: -
response.200 response 200 Array Nee Min: - · Max: - · Pattern: -
response.200[*] response 200 Object Nee Min: - · Max: - · Pattern: -
response.200[*].beginDate beginDate Date Ja Min: - · Max: - · Pattern: -
response.200[*].dateCreated dateCreated DateTime Ja Min: - · Max: - · Pattern: -
response.200[*].dateLastModified dateLastModified DateTime Ja Min: - · Max: - · Pattern: -
response.200[*].endDate endDate Date Nee Min: - · Max: - · Pattern: -
response.200[*].enrollmentId enrollmentId Uuid Ja Min: - · Max: - · Pattern: -
response.200[*].enrollmentType enrollmentType Enum Ja Min: - · Max: - · Pattern: -
response.200[*].location location Object Nee Min: - · Max: - · Pattern: -
response.200[*].location.locationIds locationIds Array Nee Min: - · Max: - · Pattern: -
response.200[*].location.locationIds[*] locationIds Object Nee Min: - · Max: - · Pattern: -
response.200[*].location.locationIds[*].locationId locationId String Ja Min: - · Max: - · Pattern: -
response.200[*].location.locationIds[*].locationIdType locationIdType Enum Ja Min: - · Max: - · Pattern: -
response.200[*].location.locationMasterIdentifier locationMasterIdentifier String Nee Min: - · Max: - · Pattern: -
response.200[*].location.name name String Ja Min: - · Max: - · Pattern: -
response.200[*].schoolPeriod schoolPeriod String Ja Min: - · Max: - · Pattern: -
response.200[*].status status Enum Ja Min: - · Max: - · Pattern: -
response.200[*].student student Object Ja Min: - · Max: - · Pattern: -
response.200[*].student.userIds userIds Array Nee Min: - · Max: - · Pattern: -
response.200[*].student.userIds[*] userIds Object Nee Min: - · Max: - · Pattern: -
response.200[*].student.userIds[*].userId userId String Ja Min: - · Max: - · Pattern: -
response.200[*].student.userIds[*].userIdType userIdType Enum Ja Min: - · Max: - · Pattern: -
response.200[*].student.userMasterIdentifier userMasterIdentifier String Nee Min: - · Max: - · Pattern: -
response.200[*].study study Uuid Nee Min: - · Max: - · Pattern: -
response.200[*].studyPublicId studyPublicId Uuid Nee Min: - · Max: - · Pattern: -
response.200[*].studyYear studyYear Integer Nee Min: - · Max: - · Pattern: -
response.200[*].subject subject Uuid Nee Min: - · Max: - · Pattern: -
response.400 response 400 Object Nee Min: - · Max: - · Pattern: -
response.400.status status Integer Ja Min: - · Max: - · Pattern: -
response.400.statusMessage statusMessage String Nee Min: - · Max: - · Pattern: -
response.401 response 401 Object Nee Min: - · Max: - · Pattern: -
response.401.status status Integer Ja Min: - · Max: - · Pattern: -
response.401.statusMessage statusMessage String Nee Min: - · Max: - · Pattern: -
response.403 response 403 Object Nee Min: - · Max: - · Pattern: -
response.403.status status Integer Ja Min: - · Max: - · Pattern: -
response.403.statusMessage statusMessage String Nee Min: - · Max: - · Pattern: -
response.404 response 404 Object Nee Min: - · Max: - · Pattern: -
response.404.status status Integer Ja Min: - · Max: - · Pattern: -
response.404.statusMessage statusMessage String Nee Min: - · Max: - · Pattern: -

Business rules

Geen business rules
Voor deze API-definitie zijn geen business rules vastgelegd.