Plannen Service API
Inleiding
De PlannenService - een cruciaal onderdeel van het infraplannen.nl platform - is ontworpen met een sterke nadruk op gebruiksvriendelijkheid. Deze service stelt gebruikers in staat om hun aanvragen snel en efficiënt in te dienen en te beheren.
REST-gebaseerde Service
De REST-gebaseerde service brengt aanzienlijke voordelen met zich mee:
Meer flexibiliteit en schaalbaarheid
Betere compatibiliteit met moderne architecturen, middleware en netwerken
Deze verbeteringen hebben een directe positieve impact op de gebruikerservaring, verkorten de doorlooptijd van aanvragen en verhogen de algehele efficiëntie van netwerkbeheer. Door deze transitie kunnen gebruikers nu profiteren van een robuustere en toekomstbestendige infrastructuur, wat resulteert in een meer gestroomlijnd en betrouwbaar infraplannen proces .
Authenticatie met EntraID
De authenticatie voor de REST API services verloopt via EntraID. Informatie over hoe dit werkt is op deze pagina te vinden.
Inhoudsopgave
- 1 Inleiding
- 2 Authenticatie met EntraID
- 3 Inhoudsopgave
- 4 Handleiding
- 5 1. GET /organizations/{organizationid}/plans
- 6 2. PUT /organizations/{organizationid}/plans/{planid}
- 7 3. GET /organizations/{organizationid}/plans/{planid}
- 8 4. DELETE /organizations/{organizationid}/plans/{planid}
- 9 12. HTTP return status codes
- 10 Swagger API specificatie
Handleiding
1. GET /organizations/{organizationid}/plans
Met deze methode kunnen organisaties een lijst met metadata van hun plannen opvragen. De resultaten kunnen worden gefilterd op basis van syncdatum, vanaf en ingediend tot, en paginering kan worden toegepast, alsmede sortering.
Het endpoint met de GET-methode biedt de functionaliteit om een gefilterde lijst van plan items op te halen.
Bij het opvragen van een lijst van aanvragen met de GET methode, kunnen de volgende urlparameters worden gebruikt om het specifieke plan te selecteren voor verwijdering.
organizationid (string): het id van de organisatie.
Bij het opvragen van een lijst van aanvragen met de GETmethode, kunnen de volgende queryparameters worden gebruikt om de resultaten te filteren en te pagineren:
filter (string): Filter de aanvragen op basis van status conform OData.
skip (integer, int32): Het aantal resultaten om over te slaan (voor paginering).
top (integer, int32): Het aantal resultaten om terug te geven (voor paginering).
orderby: string de kolomnaam waarop gesorteerd word met
ASCofDESCtoevoeging.
codevoorbeeld (curl)
curl -X GET\
-H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"/api/organizations/{organizationid}/plans?skip=1&take=&filter=&orderBy="2. PUT /organizations/{organizationid}/plans/{planid}
Met deze methode kunnen organisaties een plan toevoegen of updaten in infraplannen.
Het /aanvraag endpoint met de PUT-methode biedt de functionaliteit om een plan item toe te voegen.
Bij het opvoeren van een plan met de PUT methode, kunnen de volgende urlparameters worden gebruikt:
organizationid (string): het id van de organisatie.
planid (string): Het id van het plan
curl -X PUT\
-H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//organizations/{organizationid}/plans/{planid}"
-d { {{PAYLOAD}} }3. GET /organizations/{organizationid}/plans/{planid}
Met deze methode kunnen organisaties een specifiek plan opvragen.
Het endpoint met de GET-methode biedt de functionaliteit om een specifiek plan op te halen.
Bij het opvragen van een plan met de GET methode, kunnen de volgende urlparameters worden gebruikt om het specifieke plan te selecteren voor verwijdering.
organizationid (string): het id van de organisatie.
planid (string): Het id van het plan
codevoorbeeld (curl)
curl -X GET\
-H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//organizations/{organizationid}/plans/{planid}"
4. DELETE /organizations/{organizationid}/plans/{planid}
Met deze methode kunnen organisaties een plan verwijderen.
Het endpoint met de DELETE-methode biedt de functionaliteit om een plan te verwijderen .
Bij het bewerken van een plan met de DELETE methode, kunnen de volgende urlparameters worden gebruikt om het specifieke plan te selecteren voor verwijdering.
organizationid (string): het id van de organisatie.
planid (string): Het id van het plan
codevoorbeeld (curl)
curl -X DELETE\
-H "Authorization: Bearer [[accessToken]]"\
-H "Accept: application/json"\
"//organizations/{organizationid}/plans/{planid}"
12. HTTP return status codes
Statuscode | Betekenis | Beschrijving |
|---|---|---|
200 | OK | Het verzoek is geslaagd. |
201 | Created | Het verzoek is geslaagd en er is een nieuwe resource aangemaakt. |
204 | No Content | Het verzoek is geslaagd, maar er is geen inhoud om terug te sturen. |
400 | Bad Request | De server kon het verzoek niet begrijpen vanwege een onjuiste syntax. |
401 | Unauthorized | Authenticatie is vereist en is mislukt of nog niet verstrekt. |
403 | Forbidden | De server begrijpt het verzoek, maar weigert het uit te voeren. |
404 | Not Found | De gevraagde resource kon niet worden gevonden op de server. |
500 | Internal Server Error | De server heeft een fout gemaakt en kon het verzoek niet voltooien. |
502 | Bad Gateway | De server ontving een ongeldige reactie van de upstream-server. |
503 | Service Unavailable | De server is momenteel niet beschikbaar (door overbelasting of onderhoud). |