Titel | Status- en foutcodes | |||||||||||||||||||||||
Status |
| |||||||||||||||||||||||
Versie | 0.09.1 | |||||||||||||||||||||||
Datum20 December 2023 | 11 November 2024 | |||||||||||||||||||||||
Auteur | Architectenraad Edu-V | |||||||||||||||||||||||
Acties |
|
...
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 | De gegevenssoort Het informatieobject is van classificatie IV. Dit vereist een activering van de gegevensuitwisselinggegevensdienst. Dit is in dit foutscenario niet het geval. |
400 | 0023 | edu_org_id 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 |
...
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 | edu_org_id 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. |
...
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 uit de SIS 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. |
20032005 | Employee unknown | De identifier van de onderwijsmedewerker is onbekend. |
20042005 | Class Enrolment unknown | De identifier van de stamklas of stamgroep inschrijving is onbekend. |
20052006 | Group Assignment unknown | De identifier van de lesgroep toewijzing is onbekend. |
20062007 | SchoolSubject Group unknown | De identifier van het SchoolVak de groep is onbekend. |
20072008 | SchoolPeriod unknown | De identifier van de schoolperiode is onbekend. |
...
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. | |||
4005 | entitlementAndLicenseReferenceId unknown | – | Het entitlementAndLicenseReferenceId is onbekend | |||
4006 | entitlementAndLicenseReferenceId already used | – | Het entitlementAndLicenseReferenceId is al eerder gebruikt. | |||
4007 | entitlementAndLicenseReceiveId unknown | – | Het entitlementAndLicenseReceiveId is onbekend | |||
4008 | entitlementAndLicenseReceiveId already used | – | Het entitlementAndLicenseReceiveId 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 unknown | – | De identifier van de onderwijsorganisatie is onbekend.missing | school-student | Onderwijsorganisatie is niet gespecificeerd | |
4032 | User School unknown | – | De identifier van de onderwijsdeelnemer of onderwijsmederker is onbekend. | |||
4033 | userId, eckID or activationCode missing | Personal, SchoolStudent, SchoolEmployee | Specificatie van entitlees of activatiecodes niet volledig | |||
4034 | userId or eckId unknown | Personal, SchoolStudent, SchoolEmployee | Gespecificeerde entitlees zijn school-student | Gespecificeerde Onderwijsorganisatie is niet bekend bij Ontvanger | ||
40354033 | schoolSubject User missing | SchoolSubject | Specificatie van schoolSubjects ontbreekt | |||
4035 | schoolSubject unknown | SchoolSubject | Gespecificeerde schoolSubjects zijn niet bekend bij Ontvanger | |||
4036 | Group missing | SchoolGroup | Specificatie van Groups ontbreekt | |||
4037 | Group unknown | SchoolGroup | Gespecificeerde Groups zijn niet bekend bij Ontvanger | |||
4038 | schoolId missing | School | Onderwijsorganisatie is niet gespecificeerd | |||
4039 | schoolId unknown | School | Gespecificeerde Onderwijsorganisatie is 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 verschijnt4052 | Quantity at least 1 | School | Het gespecificeerde aantal voor open School aanspraken is minimaal 1 |
4053 | newAmount is not allowed | School | Indien het aantal door de Aanspraakmanager wordt gewijzigd in een wijzigingsbericht dan dient deze:
| |||
4061 | License registered on Entitlement SchoolStudent | Allen | Indien een Aanspraakmanager een aanspraak wil annuleren dan mag er geen licentie geregistreerd zijn op de aanspraak | |||
4071 | activationCode unknown | SchoolStudent | Gespecificeerde activatiecode is onbekend bij de ontvangende Licentieregistratie | |||
4072 | activationCode already used | SchoolStudent | Gespecificeerde activatiecode is reeds gebruikt voor een aanspraak | |||
4073 | activationCode revoked | SchoolStudent | Gespecificeerde activatiecode is ingetrokken |
...
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 | EntitlementTypesDeliveryType | 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. | |||||
4112 | deliveryOrderLineId unkown | – | Het deliveryOrderLineId 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 unknown | – | De identifier van de onderwijsorganisatie is onbekend. | Onderwijsorganisatie is niet gespecificeerd | |||
4132 | User unknown | – | De identifier van de onderwijsdeelnemer of onderwijsmederker is onbekend. | 4133 | userId, eckID or activationCode missing | Personal, SchoolStudent, SchoolEmployeeSchool unknown | School | Gespecificeerde Onderwijsorganisatie is niet bekend bij Ontvanger |
4133 | User missing | Onderwijsdeelnemers | Specificatie van entitlees of activatiecodes niet volledig | |||||
4134 | userId or eckId unknown | Personal, SchoolStudent, SchoolEmployeeUser unknown | Onderwijsdeelnemers | Gespecificeerde entitlees zijn niet bekend bij Ontvanger | ||||
4135 | schoolSubject StudyYears missing | SchoolSubjectOpleiding | Specificatie van schoolSubjects opleidingsjaren ontbreekt | |||||
4135 | schoolSubject StudyYears unknown | SchoolSubjectOpleiding | Gespecificeerde schoolSubjects opleidingsjaren zijn niet bekend bij Ontvanger | |||||
4136 | Group Subjects missing | SchoolGroupVak | Specificatie van Groups vakken ontbreekt | |||||
4137 | Group Subjects unknown | SchoolGroupVak | Gespecificeerde Groups vakken zijn niet bekend bij Ontvanger | |||||
4138 | schoolId Groups missing | School | Onderwijsorganisatie is niet gespecificeerdGroep | Specificatie van groepen ontbreekt | ||||
4139 | schoolId Groups unknown | School | Gespecificeerde Onderwijsorganisatie is groepen zijn niet bekend bij Ontvanger | |||||
4141 | contractId unknown | Allen | Gespecificeerd contractId is onbekend bij de ontvangende Licentieregistratie | |||||
4142 | Contract restrictions | Allen | Bericht niet toegestaan als gevolg van contractuele afspraken tussen de leverancier van het leermiddel en de leverancier die de verwerving faciliteert. | |||||
4151 | startDate before firstPublishedDate | Allen | Gespecificeerde startdatum van de activatieperiode ligt voor de datum dat het product op de markt verschijnt | |||||
4152 | Quantity at least 1 | School | Het gespecificeerde aantal voor open School aanspraken is minimaal 1 | |||||
4153 | newAmount is not allowed | School | Indien het aantal door de Aanspraakmanager wordt gewijzigd in een wijzigingsbericht dan dient deze:
| |||||
4161 | License registered on Entitlement | SchoolStudent | Allen | Indien een Aanspraakmanager Bestelomgeving leermiddelen een aanspraak leveringsorder wil annuleren dan mag er geen licentie geregistreerd zijn op een aanspraak van de aanspraakleveringsorder | ||||
4171 | activationCode unknown | SchoolStudent | Gespecificeerde activatiecode is onbekend bij de ontvangende Licentieregistratie | |||||
4172 | activationCode already used | SchoolStudent | Gespecificeerde activatiecode is reeds gebruikt voor een aanspraak | |||||
4173 | activationCode revoked | SchoolStudent | Gespecificeerde activatiecode is ingetrokken |
...
Status | statusMessage | Omschrijving |
6001 | requestReferenceId unknown | requestReferenceId onbekend |
6002 | requestReferenceId already used | requestReferenceId is al eerder gebruikt. |
6003 | responseReferenceId unknown | responseReferenceId onbekend |
6004 | responseReferenceId already used | responseReferenceId is al eerder gebruikt. |
6011 | purchaseOrderId unknown | Gespecificeerd inkoopordernummer is onbekend |
6012 | purchaseOrderLineId unknown | Gespecificeerd inkooporderregelnummer onbekend |
6013 | salesOrderId unknown | Gespecificeerd inkoopordernummer is onbekend |
6014 | salesOrderLineId unknown | Gespecificeerd inkooporderregelnummer is onbekend |
6021 | productId missing | Specificatie van Product ontbreekt |
6022 | productId unknown | Gespecificeerd Product onbekend bij Ontvanger |
6023 | Product not yet for sale | Gespecificeerd Product is nog niet in de verkoop |
6024 | Product not available | Gespecificeerd Product is niet beschikbaar. |
6025 | Product no longer for sale | Gespecificeerd Product is niet langer in de verkoop |
6026 | deliveryAddress unknown | Het gespecificeerde afleveradres is onbekend bij de leermiddelenaanbieder |
6027 | deliveryDate declined | De afleverdatum is niet akkoord bevonden door de leermiddelenaanbieder |
6041 | contractId unknown | Gespecificeerd contractId is onbekend bij de ontvangende Licentieregistratie |
6042 | Contract restrictions | Bericht niet toegestaan als gevolg van contractuele afspraken tussen de leverancier van het leermiddel en de leverancier die de verwerving faciliteert. |
6043 | Return period expired | Retourtermijn is verlopen |
...
Status | statusMessage | Omschrijving |
7011 | entitlementId unknown | Het entitlementId is onbekend. |
7031 | School missing | Onderwijsorganisatie is niet gespecificeerd |
7032 | School unknown | Gespecificeerde Onderwijsorganisatie is niet bekend |
7033 | User missing | Onderwijsdeelnemer of Onderwijsmedewerker is niet gespecificeerd |
7034 | User unknown | De identifier van de Gespecificeerde onderwijsdeelnemer of onderwijsmederker is onbekend.onderwijsmedewerker is niet bekend bij Ontvanger |
7041 | contractId unknown | Gespecificeerd contractId is onbekend bij de ontvangende Licentieregistratie |
7042 | Contract restrictions | Bericht niet toegestaan als gevolg van contractuele afspraken tussen de leverancier van het leermiddel en de leverancier die de verwerving faciliteert. |
80xx: Results API
In onderstaande tabel zijn de foutcodes opgenomen die opgenomen kunnen worden in de response op een bevraging en in de bevestigingsberichten uit de Results API.
Status | statusMessage | Omschrijving |
8001 | Student identifier unknown | De identifier van onderwijsdeelnemer is onbekend. |
8002 | Employee identifier unknown | De identifier van onderwijsmedewerker is onbekend. |
8003 | Score value is invalid for the score type | Een in het bericht opgenomen score is ongeldig gegeven de bijbehorende typering |
8004 | Result value is invalid for the result type | Een in het bericht opgenomen resultaat is ongeldig gegeven de bijbehorende typering |
...
Release notes
0.0.1: Foutcodes uit de API zijn samengevoegd en ontdubbeld op deze pagina. Vanuit de APIs is een verwijzing gedaan naar deze pagina.
0.0.2: Foutcodes van Delivery API en Entitlement API bijgewerkt op basis van herziening conceptueel model.
0.0.3: Foutcodes voor de Order API aangevuld met twee statussen
6026: deliveryAddress unknown
6027: deliveryDate declined
0.0.4: Foutcodes voor gegevensdiensten uit de administratiesystemen bijgewerkt.
0.9.0: Het Bestuurlijk Overleg heeft tijdens de bijeenkomst van 27 juni 2024 het Afsprakenstelsel Edu-V als versie 0.9.0 goedgekeurd voor implementatie.
0.9.1: Wijzigingen naar aanleiding van RFC0025: De vier voorbeeldfoutcodes in de specificatie van Results API zijn met nummers 8001 t/m 8004 toegevoegd in nieuwe categorie “80xx: Results API”.