OSR:API/V2/API V2 naar V3 wijzigingen: verschil tussen versies
Naar navigatie springen
Naar zoeken springen
(Nieuwe pagina aangemaakt met '.') |
Geen bewerkingssamenvatting |
||
Regel 1: | Regel 1: | ||
. | {|class="wikitable" | ||
! style="text-align:left;"| URI | |||
! style="text-align:left;"| Wijzigingen API V3 | |||
|- | |||
| GET /boards/{id} | |||
| | |||
* Parameter "{id} wordt "bgeCode" | |||
* Responseveld "number" wordt "bge_code" | |||
|- | |||
| POST /endpoints | |||
| Bij gebruik van het token van een mandaat, welke op bestuursniveau is aangemaakt geeft de API terug: | |||
HTTP 400: The given service version does not allow endpoint registrations | |||
|- | |||
| GET /endpoints | |||
| Bij gebruik van de versie naamruimte van een dienst, welke alleen mandaten op bestuursniveau toestaat geeft de API een HTTP 200 met lege lijst terug. | |||
|- | |||
| | |||
GET /endpoints/{id}<br> | |||
PUT /endpoints/{id}<br> | |||
DELETE /endpoints/{id} | |||
| URI-parameter "{id}" wordt omgezet naar "{uuid}" | |||
|- | |||
|GET /endpoints/available-routing-id | |||
| | |||
* Deze vervangt het API endpoint "GET available_routing_id".<br> | |||
* Bij gebruik van de versie naamruimte van een dienst, welke alleen mandaten op bestuursniveau toestaat geeft de API een HTTP 200 met lege lijst terug.<br> | |||
|- | |||
|GET /mandates/services/{serviceCode}/schools/{schoolOin}/suppliers/{supplierOin} | |||
| | |||
* Deze vervangt het API endpoint "GET /mandates" | |||
* Dit API endpoint geeft alleen mandaten op schoolniveau terug in de response; | |||
* De parameter "service_version_namespace" is verwijderd; | |||
* De parameters "serviceCode", "schoolOin" en "supplierOin" zijn verplicht en verplaatst naar de URI. | |||
|- | |||
|GET /mandates/services/{serviceCode}/boards/{bgeCode}/suppliers/{supplierOin} | |||
| | |||
* Dit is een <span style="text-decoration:underline">nieuw</span> API endpoint, welke alleen mandaten op bestuursniveau in de response teruggeeft; | |||
* De parameter "boardBgeCode" wordt gebruikt om het schoolbestuur te identificeren; | |||
* Responseveld _links.board { "href": "string" } bevat een link naar het bij het mandaat behorende schoolbestuur. | |||
|- | |||
| GET /mandates/{uuid} | |||
| | |||
* URI-parameter "{id}" wordt omgezet naar "{uuid}"; | |||
* Zowel mandaten op school- als bestuursniveau worden teruggeven; | |||
* Responseveld _links.board { "href": "string" } bevat een link naar het bij het mandaat behorende schoolbestuur; | |||
* Responseveld "_links.board" is altijd gevuld, zowel bij een mandaat op school- als bestuursniveau; | |||
* Responseveld "_links.school" geeft uiteraard alleen een waarde bij een mandaat op schoolniveau, anders is deze null. | |||
|- | |||
|GET /schools<br> | |||
GET /schools/{id} | |||
| "oa_id" komt niet meer voor als parameter en in responses. | |||
|- | |||
| GET /school-mandates | |||
| "school_oa_id" komt niet meer voor in responses. | |||
|- | |||
|GET /services/{uuid} | |||
| URI-parameter "{id}" wordt omgezet naar "{uuid}" | |||
|- | |||
| GET /service-versions/{uuid} | |||
| URI-parameter "{id}" wordt omgezet naar "{uuid}" | |||
|- | |||
| POST /service-versions/copy-endpoints-from-service-version | |||
| Als de parameters "serviceVersionNamespaceToCopyTo" óf "serviceVersionNamespaceToCopyFrom" betrekking hebben op een dienst welke alleen mandaten op bestuursniveau toestaat geeft de API terug: | |||
* HTTP 400: The given service version(s) do not allow endpoint registrations | |||
|} |
Versie van 19 mrt 2025 12:13
URI | Wijzigingen API V3 |
---|---|
GET /boards/{id} |
|
POST /endpoints | Bij gebruik van het token van een mandaat, welke op bestuursniveau is aangemaakt geeft de API terug:
HTTP 400: The given service version does not allow endpoint registrations |
GET /endpoints | Bij gebruik van de versie naamruimte van een dienst, welke alleen mandaten op bestuursniveau toestaat geeft de API een HTTP 200 met lege lijst terug. |
GET /endpoints/{id} |
URI-parameter "{id}" wordt omgezet naar "{uuid}" |
GET /endpoints/available-routing-id |
|
GET /mandates/services/{serviceCode}/schools/{schoolOin}/suppliers/{supplierOin} |
|
GET /mandates/services/{serviceCode}/boards/{bgeCode}/suppliers/{supplierOin} |
|
GET /mandates/{uuid} |
|
GET /schools GET /schools/{id} |
"oa_id" komt niet meer voor als parameter en in responses. |
GET /school-mandates | "school_oa_id" komt niet meer voor in responses. |
GET /services/{uuid} | URI-parameter "{id}" wordt omgezet naar "{uuid}" |
GET /service-versions/{uuid} | URI-parameter "{id}" wordt omgezet naar "{uuid}" |
POST /service-versions/copy-endpoints-from-service-version | Als de parameters "serviceVersionNamespaceToCopyTo" óf "serviceVersionNamespaceToCopyFrom" betrekking hebben op een dienst welke alleen mandaten op bestuursniveau toestaat geeft de API terug:
|