Status- en foutcodes 1.0.0
Titel | Status- en foutcodes |
Status | Final Recommended |
Versie | V 1.0.0 |
Datum | 11 November 2024 |
Auteur | Architectenraad Edu-V |
Acties |
|
In het afsprakenstelsel zijn diverse APIs gedefinieerd. Binnen deze APIs zijn status- en foutcodes op een uniforme wijze gespecificeerd. Op deze pagina zijn alle status- en foutcodes terug te vinden.
Voor transactiepatroon asynchrone gegevensuitwisseling geldt: voor API-verzoeken met ontbrekende verplichte velden moet de ontvangende partij direct in de response body een foutcode retourneren. Dit zorgt ervoor dat verzenders onmiddellijk inzicht hebben in schemafouten en hun verzoek kunnen corrigeren zonder te wachten op de asynchrone bevestigingsberichten.
Er wordt onderscheid gemaakt in de volgende categorieën:
00xx: Algemeen
Voor alle APIs gelden de HTTP Status Codes en een aantal aanvullende status en statusmessages specifiek voor de gegevensuitwisselingen binnen Edu-V. Deze zijn hieronder weergegeven.
HTTP | Status | statusMessage | Omschrijving |
200 | 0000 | OK | Bevraging succesvol. |
201 | 0001 | Created | Bericht heeft geleid tot registratie van een nieuwe entiteit. |
202 | 0002 | Accepted | Bericht geaccepteerd. |
400 | 0011 | Schema incorrect | Schemavalidatie niet succesvol |
400 | 0012 | schemaVersion not supported | De ontvanger kan de gehanteerde schemaVersion niet verwerken |
401 | 0021 | scope required | Leverancier is niet geautoriseerd voor scope |
403 | 0022 | consent required | Het informatieobject is van classificatie IV. Dit vereist een activering van de gegevensdienst. Dit is in dit foutscenario niet het geval. |
400 | 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 |
404 |
|
| De URL van de endpoint is niet bekend |
405 |
|
| De request method is niet toegestaan |
500 |
|
| Algemene fout bij de server. |
10xx: Consent API
In onderstaande tabel zijn de foutcodes die opgenomen moeten worden in bevestigingsberichten uit de Consent API.
Status | statusMessage | Omschrijving |
1001 | providerReferenceId unknown | De providerReferenceId is onbekend. |
1002 | providerReferenceId already used | De providerReferenceId is al eerder gebruikt. |
1003 | consumerReferenceId unknown | De consumerReferenceId is onbekend. |
1004 | consumerReferenceId already used | De consumerReferenceId is al eerder gebruikt. |
1011 | school unknown | Onderwijsaanbieder onbekend |
1012 | api not supported | API wordt niet aangeboden door Data Provider |
1013 | scope not supported | Scope wordt niet aangeboden door Data Provider. |
1021 | api not authorised | Data Consumer is niet geautoriseerd om gegevens uit te wisselen voor de gespecificeerde api. |
1022 | scope not authorised | Data Consumer is niet geautoriseerd om gegevens uit te wisselen voor de gespecificeerde scope. |
1031 | ConsentRequests not supported | Consentverzoeken worden niet ondersteund door Data Provider. |
11xx: DPA (Data Processing Agreement) API
In onderstaande tabel zijn de foutcodes die opgenomen moeten worden in de response op een bevraging uit de DPA API.
Status | statusMessage | Omschrijving |
1111 | School Board unkown | Onderwijsbestuur onbekend |
1112 | Supplier unknown | Leverancier onbekend |
1121 | No agreement with School Board | De bevrager van het endpoint heeft zelf geen verwerkersovereenkomst met het onderwijsbestuur. |
20xx: Education, Association, Students en Employees API
In onderstaande tabel zijn de foutcodes die opgenomen moeten worden in de response op een bevraging van de Education API, Association API, Students API en Employees API.
Status | statusMessage | Omschrijving |
2001 | School unknown | De identifier van de onderwijsorganisatie is onbekend. |
2002 | SubjectOffering unknown | De identifier van het SchoolVak is onbekend. |
2003 | StudyOffering unknown | De aangeboden opleiding is onbekend. |
2004 | Student unknown | De identifier van de onderwijsdeelnemer is onbekend. |
2005 | Employee unknown | De identifier van de onderwijsmedewerker is onbekend. |
2006 | Assignment unknown | De identifier van de toewijzing is onbekend. |
2007 | Group unknown | De identifier van de groep is onbekend. |
2008 | SchoolPeriod unknown | De identifier van de schoolperiode is onbekend. |
2009 | Enrollment unknown | De identifier van de inschrijving is onbekend. |
2011 | Board unknown | De identifier van de board is onbekend |
Onderstaand tabel geeft de foutcodes per endpoint weer voor Assocation API:
Ref. component | Endpoint / object | Method | Locatie | Foutcodes |
Administratiesysteem onderwijsdeelnemer | /schoolperiods/school/{id} | GET |
Response Body | 2001, 2008 |
/schoolperiods/school | GET | 2001 | ||
/enrollments/school/{id} | GET | 2001, 2009 | ||
/enrollments/school | GET | 2001, 2002, 2003, 2008 | ||
/enrollments/school/student | POST | 2001, 2002, 2003, 2004, 2008 | ||
/assignments/school/{id} | GET | 2001, 2006 | ||
/assignments/school | GET | 2001, 2008 | ||
/assignments/school/employee | POST | 2001, 2005, 2008 | ||
/groups/school/{id} | GET | 2001, 2007 | ||
/groups/school | GET | 2001, 2002, 2003, 2008 |
Onderstaand tabel geeft de foutcodes per endpoint weer voor Education API:
Ref. component | Endpoint / object | Method | Locatie | Foutcodes |
Administratiesysteem onderwijsdeelnemer | /organisations | GET |
Response Body | 2001, 2011 |
/studyofferings/school/{id} | GET | 2001, 2003 | ||
/studyofferings/school | GET | 2001, 2003, 2008 | ||
/subjectofferings/school/{id} | GET | 2001, 2002 | ||
/subjectofferings/school | GET | 2001, 2002, 2003, 2008 |
Onderstaand tabel geeft de foutcodes per endpoint weer voor Employees API:
Ref. component | Endpoint | Method | Locatie | Foutcodes |
Administratiesysteem onderwijsmedewerker | /employees | POST | Response Body | 2001, 2005 |
/employees/school | GET | 2001, 2008 |
Onderstaand tabel geeft de foutcodes per endpoint weer voor Students API:
Ref. component | Endpoint | Method | Locatie | Foutcodes |
Administratiesysteem onderwijsdeelnemer | /students | POST | Response Body | 2001, 2004 |
/students/school | GET | 2001, 2002, 2003, 2008 |
30xx: Catalogue API
In onderstaande tabel zijn de foutcodes die opgenomen moeten worden in de response op een bevraging uit de Catalogue API.
Status | statusMessage | Omschrijving |
3001 | Product unknown | De identifier van het Product is onbekend. |
Onderstaand tabel geeft de foutcodes per endpoint weer:
Ref.component | Endpoint | Method | Locatie | Foutcodes |
Leveranciersspecifieke leermiddelencatalogus | /products | GET | - | - |
/products/{id} | GET | Response Body | 3001 | |
/products/info | GET | - | - | |
/products/info/{id} | GET | Response Body | 3001 |
40xx: Entitlement API
In onderstaande tabel zijn de foutcodes die opgenomen moeten worden in de response op een bevraging en in de bevestigingsberichten uit de Entitlement API.
Status | statusMessage | EntitlementTypes | Omschrijving |
4001 | entitlementReferenceId missing | – | entitlementReferenceId ontbreekt. |
4002 | entitlementReferenceId unknown | – | Het entitlementReferenceId is onbekend. |
4003 | entitlementReferenceId already used | – | Het entitlementReferenceId is al eerder gebruikt. |
4004 | entitlementReceiveId missing | – | Het entitlement ReceiveId ontbreekt. |
4005 | entitlementReceiveId already used | – |