Aangezien de authenticatie via ACM steeds gebeurt op het niveau van een hoofdorganisatie, waren een aantal aanpassingen nodig in de KLIP-API om acties te kunnen ondernemen in naam van een suborganisatie.
De vernieuwde API wordt hier beschreven: https://klip.api.beta-vlaanderen.be/api/swagger/index.html (bèta-omgeving) en https://klip.api.vlaanderen.be/api/swagger/index.html (productie).
-
Voor volgende calls moet nu ook een organisatieID worden meegegeven:
- POST
-
/ws/klip/v3/maprequest (organisationID is een verplicht mee te geven veld)
-
- GET
- /ws/klip/v3/imkl/maprequest/{MapRequestId}/mri/{OrganisationId} (ID is hier nodig om te weten op welke factuur het IMKL-pakket geplaatst moet worden)
- /ws/klip/v3/una/getbyorganisation/{OrganisationId}
- POST
-
De statussen werden ingekort van url naar korte codes
-
voorbeeld: "https://klip.vlaanderen.be/api/cl/klip/v2/MapRequestStatus/created" werd "created"
-
-
Het defaultformaat voor de API-berichten is JSON, al blijft het mogelijk om XML-berichten te versturen. Stuur hiervoor in de "Content-Type" header application/xml mee.
-
Nieuwe functionaliteit: het opvragen van de organisatiestructuur en OrganisatieId’s.
Enkel voor leidingbeheerders: vanaf nu is het ook mogelijk om de antwoordstatus van een planaanvraag op te halen. Een planaanvraag kan pas beantwoord worden wanneer ze de status ‘confirmed’ heeft.
Aangewezen antwoordproces:
- Vraag te bevestigen planaanvragen op
- Bevestig planaanvragen
- Vraag te beantwoorden planaanvragen op
- Vraag details te beantwoorden planaanvragen op
- Beantwoord de planaanvragen
Alternatief antwoordproces:
- Vraag te bevestigen planaanvragen op
- Bevestig de planaanvraag
- Vraag details planaanvraag op
- Kijk na of de status van de planaanvraag aangepast is naar ‘confirmed’
- Beantwoord planaanvraag
Opgelet: KLIP verwerkt de API calls asynchroon.
Wacht om het antwoord op een planaanvraag door te sturen tot planaanvraag effectief bevestigd is.