Status- en foutcodes
Titel | Status- en foutcodes |
Status | In ontwikkeling ROSA-Architectuurscan BEsluitvorming implementatie in beheer |
Versie | 0.9.1 |
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. 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 |
10xx: Consent API
In onderstaande tabel zijn de foutcodes opgenomen die opgenomen kunnen 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 opgenomen die opgenomen kunnen 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 opgenomen die opgenomen kunnen 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 schoolperiode is onbekend. |
2004 | Student unknown | De identifier van de onderwijsdeelnemer is onbekend. |
2005 | Employee unknown | De identifier van de onderwijsmedewerker is onbekend. |
2005 | Enrolment unknown | De identifier van de inschrijving 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. |
30xx: Catalogue API
In onderstaande tabel zijn de foutcodes opgenomen die opgenomen kunnen worden in de response op een bevraging uit de Catalogue API.
Status | statusMessage | Omschrijving |
3001 | Product unknown | De identifier van het Product is onbekend. |
31xx: Course API
In onderstaande tabel zijn de foutcodes opgenomen die opgenomen kunnen worden in de response op een bevraging uit de Course API.
Status | statusMessage | Omschrijving |
3101 | Course unknown | De identifier van de Course is onbekend. |
3102 | CourseStructure unknown | De identifier van de CourseStructure is onbekend. |
40xx: Entitlement API
In onderstaande tabel zijn de foutcodes opgenomen die opgenomen kunnen worden in de response op een bevraging en in de bevestigingsberichten uit de Entitlement API.
Status | statusMessage | EntitlementTypes | Omschrijving |
4001 | entitlementReferenceId unknown | – | Het entitlementReferenceId is onbekend. |
4002 | entitlementReferenceId already used | – | Het entitlementReferenceId is al eerder gebruikt. |
4003 | entitlementReceiveId unknown | – | Het entitlementReferenceId is onbekend. |
4004 | entitlementReceiveId already used | – | Het entitlementReceiveId is al eerder gebruikt. |
4011 | entitlementId unknown | – | Het entitlementId is onbekend. |
4021 | productId missing | Allen | Specificatie van Product ontbreekt |
4022 | productId unknown | Allen | Gespecificeerd Product onbekend bij Ontvanger |
4023 | Product not yet for sale | Allen | Gespecificeerd Product is nog niet in de verkoop |
4024 | Product not available | Allen | Gespecificeerd Product is niet beschikbaar. |
4025 | Product no longer for sale | Allen | Gespecificeerd Product is niet langer in de verkoop |
4031 | School missing | school-student | Onderwijsorganisatie is niet gespecificeerd |
4032 | School unknown | school-student | Gespecificeerde Onderwijsorganisatie is niet bekend bij Ontvanger |
4033 | User missing | school-student | Specificatie van entitlees of activatiecodes niet volledig |
4034 | User unknown | school-student | Gespecificeerde entitlees zijn niet bekend bij Ontvanger |
4041 | contractId unknown | Allen | Gespecificeerd contractId is onbekend bij de ontvangende Licentieregistratie |
4042 | Contract restrictions | Allen | Bericht niet toegestaan als gevolg van contractuele afspraken tussen de leverancier van het leermiddel en de leverancier die de verwerving faciliteert. |
4051 | startDate before firstPublishedDate | Allen | Gespecificeerde startdatum van de activatieperiode ligt voor de datum dat het product op de markt verschijnt |
4061 | Entitlement is licensed | Allen | Indien een Aanspraakmanager een aanspraak wil annuleren dan mag er geen licentie geregistreerd zijn op de aanspraak |
4071 | activationCode unknown | School-activationcode | Gespecificeerde activatiecode is onbekend bij de ontvangende Licentieregistratie |
4072 | activationCode already used | School-activationcode | Gespecificeerde activatiecode is reeds gebruikt voor een aanspraak |
4073 | activationCode revoked | School-activationcode | Gespecificeerde activatiecode is ingetrokken |
41xx: Delivery API
In onderstaande tabel zijn de foutcodes opgenomen die opgenomen kunnen worden in de response op een bevraging en in de bevestigingsberichten uit de Delivery API.
Status | statusMessage | DeliveryType | Omschrijving |
4101 | deliveryOrderReferenceId unknown | – | Het deliveryOrderReferenceId is onbekend. |
4102 | deliveryOrderReferenceId already used | – | Het deliveryOrderReferenceId is al eerder gebruikt. |
4103 | deliveryOrderReceiveId unknown | – | Het deliveryOrderReceiveId is onbekend. |
4104 | deliveryOrderReceiveId already used | – | Het deliveryOrderReceiveId is al eerder gebruikt. |
4111 | deliveryOrderId unknown | – | Het deliveryOrderId is onbekend. |
4121 | productId missing | Allen | Specificatie van Product ontbreekt |
4122 | productId unknown | Allen | Gespecificeerd Product onbekend bij Ontvanger |
4123 | Product not yet for sale | Allen | Gespecificeerd Product is nog niet in de verkoop |
4124 | Product not available | Allen | Gespecificeerd Product is niet beschikbaar. |
4125 | Product no longer for sale | Allen | Gespecificeerd Product is niet langer in de verkoop |
4131 | School missing | School |