VAPH publieke API's Versie 1.1

De informatie in dit document wordt ter beschikking gesteld as-is. Het VAPH is niet verantwoordelijk voor eventuele schade die geleden werd door gebruik van deze informatie.

Onze diensten doen hun best om alle informatie hier zo volledig en correct mogelijk te plaatsen, mocht u toch nog zaken vinden die niet correct zijn, gelieve ons hiervan op de hoogte stellen via xxxxxxxx@xxxx.xx of via telefoonnummer 02 249 34 56.

REST services voor de geïntegreerde registratie tool ( GIR )

De testomgeving is enkel intern beschikbaar en wordt enkel extern opengesteld indien grotere wijzigingen moeten worden geïmplementeerd, voor de kleine wijzigingen kan je acceptatie gebruiken.

Basis URL

De basis url is xxxxx://xxx.xxxx.xx/xxxxxxxxxxxxxxx/x0/

De acceptatie basis url is: xxxxx://xxx-xxx.xxxx.xx/xxxxxxxxxxxxxxx/x0/

De test basis url is: xxxxx://xxx-xxx.xxxx.xx/xxxxxxxxxxxxxxx/x0/

Swagger documentatie

Sinds kort gebruiken we nu ook swagger voor documentatie: (dezelfde login gebruiken dat gebruikt wordt voor de rest calls)

Productie: xxxxx://xxx.xxxx.xx/xxxxxxx/xxxxxxx-xx/xxxxx.xxxx#/

Acceptatie:xxxxx://xxx-xxx.xxxx.xx/xxxxxxx/xxxxxxx-xx/xxxxx.xxxx#/

Test:xxxxx://xxx-xxx.xxxx.xx/xxxxxxx/xxxxxxx-xx/xxxxx.xxxx#/

REST Services ISIS

Inleiding

In het kader van de zorgvernieuwing zal het VAPH ook een nieuwe manier lanceren om contracten te registreren. Dit zal gebeuren via RESTful services.

Om meer te leren over REST: xxxx://xxx.xxxxx.xxx/xxxxxxxx/xxxx-xxxxxxxxxxxx . Voor de nieuwe REST-services gaan we ook meer het RESTful-principe hanteren. De REST services van het VAPH zijn steeds oproepbaar via een HTTP-request (GET, PUT, POST, ...), en geven steeds een XML-document terug als resultaat. Het formaat van het antwoord is gespecifieerd in de WADL (hierover later meer).

In tegenstelling tot de oude services, werken de services voor contracten op basis van de subsidie-eenheid, en niet de voorziening!

Acceptatie deployment

xxxxx://xxx-xxx.xxxx.xx/xxxx-xxxx/ (voorschotten - zonder xsd validatie, deprecated vanaf 05/03/2019)

xxxxx://xxx-xxx.xxxx.xx/xxxx/ (afrekeningen) (voorschotten - met xsd validatie vanaf 05/03/2019)

Productie deployment

xxxxx://xxxx.xxxx.xx/xxxxXxxx (voorschotten - zonder xsd validatie, deprecated vanaf 08/03/2019) xxxxx://xxx.xxxx.xx/xxxx/ (afrekeningen)(voorschotten - met xsd validatie vanaf 08/03/2019)

Beveiliging

Er moet op de REST services geauthenticeerd worden via BASIC authentication.

Beschikbare diensten

Opgelet, de onderstaande links bevatten voorbeelden van requests en responses. Deze zijn indicatief en niet noodzakelijk syntactisch correct! Voor de juiste syntax moet je de XSD zoals hierboven beschreven raadplegen.

De meeste fouten in requests naar het VAPH komen voort uit het niet valideren van deze requests met bovenstaande XSD. Gelieve in jullie software te voorzien dat requests altijd gevalideerd zijn alvorens ze worden verzonden naar het VAPH.

Een contract registreren

Deze web service kan gebruikt worden om een contract te registreren voor een bepaalde subsidie-eenheid.

Requests

Requests worden verstuurd via PUT naar /{subsidie-eenheid}/contract?user=xxx&password=yyy

{subsidie-eenheid} is de naam van de subsidie-eenheid.

Een request ziet er als volgt uit:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<rijkregisternummer>xxxxxxxxxx</rijkregisternummer>

</werknemer>

<omschrijving>xxxxxxxxx</omschrijving>

</functie>

</contract>

werknemer - rijksregisternummer: verplicht veld
werknemer - naam: verplicht veld.
werknemer - voornaam: verplicht veld.
begindatum: verplicht veld.
einddatum: optioneel veld.
functie - code: verplicht veld
functie - omschrijving: optioneel veld.
ancJaar: verplicht veld. De anciënniteit in jaren op het moment dat het contract start (getal tussen 0 en 40)
ancMaand: verplicht veld. De anciënniteit in maanden op het moment dat het contract start (getal tussen 0 en 11)

Werking

Er zal in de databank nagegaan worden of de werknemer in kwestie al gekend is. Indien niet, wordt deze aangemaakt.

Response

In geval van succes, zal de response bestaan uit code '201 - Created' en de url naar het nieuw aangemaakt contract. Hierin staat uiteraard ook het id.

Voorbeeld

Een registratie voor werknemer Xxxx Xxx:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

</werknemer>

</functie>

</contract>

Een contract wijzigen

Deze web service kan gebruikt worden om een bestaand contract te wijzigen voor een bepaalde subsidie-eenheid.

OPGELET, het wijzigen van het rijksregisternummer via deze request zal geblokkeerd worden omdat het enkel verwarring schept. Als een contract is geregistreerd aan met een verkeerd rijksregisternummer moet je het contract verwijderen en opnieuw aanmaken met het juiste rijksregisternummer.

Requests

Requests worden verstuurd via PUT naar /{subsidie-eenheid}/contract/{contract-id}?user=xxx&password=yyy

{subsidie-eenheid} is de naam van de subsidie-eenheid.

{contract-id} is het id van het betreffende contract

Een request ziet er als volgt uit:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<rijkregisternummer>xxxxxxxxxx</rijkregisternummer>

</werknemer>

<omschrijving>xxxxxxxxxxxxxxxxxxxxx</omschrijving>

</functie>

</contract>

werknemer - rijksregisternummer: verplicht veld
werknemer - naam: verplicht veld.
werknemer - voornaam: verplicht veld.
begindatum: verplicht veld.
einddatum: optioneel veld.
functie - code: verplicht veld
functie - omschrijving: optioneel.
ancJaar: verplicht veld. Anciënniteit, jaargedeelte
ancMaand: verplicht veld. Anciënniteit, maandgedeelte

Werking

Men kan alles wijzigen, behalve het rijksregisternummer van de werknemer. Indien men de naam of voornaam van een werknemer wijzigt, zal dit uiteraard een impact hebben op alle contracten die gekoppeld zijn aan deze werknemer. Indien het contract niet kan worden gevonden, wordt de code '404 - Not found' teruggestuurd.

Response

In geval van succes, zal de response bestaan uit code '200 - OK'.

Voorbeeld

Een wijziging voor werknemer Xxxx Xxx (zeer analoog aan de registratie van een contract).

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

</werknemer>

</functie>

</contract>

Een contract verwijderen

Deze web service kan gebruikt worden om een contract te verwijderen voor een bepaalde subsidie-eenheid.

Requests

Requests worden verstuurd via DELETE naar /{subsidie-eenheid}/contract/{contract-id}?user=xxx&password=yyy

{subsidie-eenheid} is de naam van de subsidie-eenheid.

{contract-id} is het id van het betreffende contract.

Werking

Het contract wordt verwijderd. De werknemer blijft gekend in het systeem. Indien het contract niet kan worden gevonden, wordt de code '404 - Not found' teruggestuurd.

Response

In geval van succes, zal de response bestaan uit code '200 - OK'.

Een contract opzoeken

Deze web service kan gebruikt worden om een bepaald contract op te zoeken aan de hand van zijn id.

Requests

Requests worden verstuurd via GET naar /{subsidie-eenheid}/contract/{contract-id}?user=xxx&password=yyy {subsidie-eenheid} is het nummer van de subsidie-eenheid.

{contract-id} is het id van het contract.

Een request ziet er als volgt uit:

Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<ns2:contract xmlns:ns2="xxxx://xxx.xxxx.xx/xxxxxxxxx">

<id>xxxxxxxxxxxxxxx</id>

<rijkregisternummer>xxxxxxxxxx</rijkregisternummer>

</werknemer>

<omschrijving>xxxxxxxxxxxxxxxxxxxxx</omschrijving>

</functie>

</ns2:contract>

Voorbeeld

Een contract van werknemer Xxxx Xxx.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<ns2:contract xmlns:ns2="xxxx://xxx.xxxx.xx/xxxxxxxxx">

</werknemer>

<omschrijving>LOGISTIEK PERS. KLASSE 3</omschrijving>

</functie>

</ns2:contract>

Werking

Indien het contract niet kan worden gevonden, wordt de code '404 - Not found' teruggestuurd.

Alle contracten opzoeken

Deze web service kan gebruikt worden om een alle contracten op te zoeken voor een bepaalde subsidie-eenheid

Requests

Requests worden verstuurd via GET naar /{subsidie-eenheid}/contract?user=xxx&password=yyy

{subsidie-eenheid} is het nummer van de subsidie-eenheid.

Een request ziet er als volgt uit:

Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<ns2:ContractenResponseBind xmlns:ns2="xxxx://xxx.xxxx.xx/xxxxxxxxx">

<id>xxxxxxxxxxxxxxx</id>

<rijkregisternummer>xxxxxxxxxx</rijkregisternummer>

</werknemer>

<omschrijving>xxxxxxxxxxxxxxxxxxxxx</omschrijving>

</functie>

</contract>

</contracten>

</ns2:ContractenResponseBind>

Voorbeeld

De contracten van werknemers Xxxx Xxx en Xxxx Xxx.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<ns2:ContractenResponseBind xmlns:ns2="xxxx://xxx.xxxx.xx/xxxxxxxxx">

</werknemer>

<omschrijving>LOGISTIEK PERS. KLASSE 3</omschrijving>

</functie>

</contract>

</werknemer>

<omschrijving>LOGISTIEK PERS. KLASSE 3</omschrijving>

</functie>

</contract>

</contracten>

</ns2:ContractenResponseBind>

Een prestatie registreren

Deze web service kan gebruikt worden om een prestatie te registreren voor een bepaald contract.

Requests

Requests worden verstuurd via PUT naar /{subsidie-eenheid}/contract/{contract-id}/prestatie?user=xxx&password=yyy

Een request ziet er als volgt uit:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<contractId>xxxxxxxxxxx</contractId>

</prestatie>

contractId: unieke id van het contract, optioneel veld
jaar: verplicht veld.
maand: verplicht veld.
uren: verplicht veld
uurstelsel: verplicht veld.
prestatieeenheid: getal tussen 0 en 1, verplicht veld.
(gelijkgestelde) afwezigheid: getal tussen 0 en 1, verplicht veld.

Response

In geval van succes, zal de response bestaan uit code '201 - Created' en de url naar de nieuwe aangemaakt prestatie.

Een prestatie verwijderen

Deze web service kan gebruikt worden om een prestatie van een contract te verwijderen.

Requests

Requests worden verstuurd via DELETE naar /{subsidie-eenheid}/contract/{contract-id}/prestatie/{prestatie-id}?user=xxx&password=yyy

Werking

De prestatie wordt verwijderd. Indien de prestatie niet kan worden gevonden, wordt de code '404 - Not found' teruggestuurd.

Response

In geval van succes, zal de response bestaan uit code '200 - OK'.

Een prestatie opzoeken

Deze web service kan gebruikt worden om een bepaalde prestatie op te zoeken aan de hand van zijn id.

Requests

Requests worden verstuurd via GET naar /{subsidie-eenheid}/contract/{contract-id}/prestatie/{prestatie-id}?user=xxx&password=yyy

Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<ns2:prestatie xmlns:ns2="xxxx://xxx.xxxx.xx/xxxxxxxxx">

<id>xxxxxxxxxxxxx</id>

<contractId>xxxxxxxxxxxxx</contractId>

</ns2:prestatie>

Werking

Indien de prestatie niet kan worden gevonden, wordt de code '404 - Not found' teruggestuurd.

Alle prestaties opzoeken

Deze web service kan gebruikt worden om een alle prestaties op te zoeken voor een bepaalde contract.

Requests

Requests worden verstuurd via GET naar /{subsidie-eenheid}/contract/{contract-id}/prestaties?user=xxx&password=yyy

Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<ns2:PrestatiesResponseBind xmlns:ns2="xxxx://xxx.xxxx.xx/xxxxxxxxx">

<id>xxxxxxxxxxxx</id>

<contractId>xxxxxxxxxxxx</contractId>

</prestatie>

</prestaties>

</ns2:PrestatiesResponseBind>

Alle afrekeningscontracten opzoeken

Deze web service kan gebruikt worden om alle afrekeningscontracten op te zoeken voor een bepaald erkenningsnummer.

Requests

Requests worden verstuurd via GET naar /{subsidie-eenheid}/afrekeningen/contracten

{subsidie-eenheid} is het erkenningsnummer van de subsidie-eenheid (bv. SE.50), of het nummer van de SE (bv. 50)

Response

<?xml version="1.0" encoding="UTF-8"?>

<ns2:AfrekeningsContractResponse xmlns:ns2="xxxx://xxx.xxxx.xx/xxxxxxxxx">

<rijksregisternummer>XXXXXXXXXXX</rijksregisternummer>

</functie>

</afrekeningContract>

</ns2:AfrekeningsContractResponse>

Werking

Indien het erkenningsnummer niet bij een SE hoort, wordt de code '404 - Not found' teruggestuurd.

Een afrekeningscontract opzoeken

Deze web service kan gebruikt worden om een bepaald afrekeningscontract op te zoeken aan de hand van zijn id.

Requests

Requests worden verstuurd via GET naar /{subsidie-eenheid}/afrekeningen/contracten/{id}

{subsidie-eenheid} is het erkenningsnummer van de subsidie-eenheid (bv. SE.50), of het nummer van de SE (bv. 50)
{id} is het id van het afrekeningscontract.

Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<rijksregisternummer>XXXXXXXXXXX</rijksregisternummer>

</functie>

<ancDatum>XXXXXX</ancDatum>

</AfrekeningsContract >

Werking

Indien het erkenningsnummer niet bij een SE hoort, wordt de code '404 - Not found' teruggestuurd. Indien het id niet bij een afrekeningscontract hoort, wordt de code '404 - Not found' teruggestuurd.

Een afrekeningscontract toevoegen

Deze web service kan gebruikt worden om een afrekeningscontract toe te voegen voor een subsidie-eenheid.

Requests

Requests worden verstuurd via PUT naar /{subsidie-eenheid}/afrekeningen/contracten

{subsidie-eenheid} is het erkenningsnummer van de subsidie-eenheid (bv. SE.50), of het nummer van de SE (bv. 50)

Een request ziet er als volgt uit:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<rijksregisternummer>XXXXXXXXXXX</rijksregisternummer>

</functie>

<ancDatum>XXXXXX</ancDatum>

</AfrekeningsContract>

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<rijksregisternummer>XXXXXXXXXXX</rijksregisternummer>

</functie>

<ancDatum>XXXXXX</ancDatum>

</AfrekeningsContract>

Response

In geval van succes, zal de response bestaan uit code '201 - Created' en de url naar het nieuw aangemaakte afrekeningscontract.

Een afrekeningscontract wijzigen

Deze web service kan gebruikt worden om een bepaald afrekeningscontract te wijzigen aan de hand van zijn id.

Requests

Requests worden verstuurd via PUT naar /{subsidie-eenheid}/afrekeningen/contracten/{id}

{subsidie-eenheid} is het erkenningsnummer van de subsidie-eenheid (bv. SE.50), of het nummer van de SE (bv. 50)
{id} is het id van het afrekeningscontract.

Een request ziet er als volgt uit:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<rijksregisternummer>XXXXXXXXXXX</rijksregisternummer>

</functie>

<ancDatum>XXXXXX</ancDatum>

</AfrekeningsContract>

Response

In geval van succes, zal de response bestaan uit code '200 - OK'.

Een afrekeningscontract verwijderen

Deze web service kan gebruikt worden om een een afrekeningscontract van een subsidie-eenheid te verwijderen.

Requests

Requests worden verstuurd via DELETE naar /{subsidie-eenheid}/afrekeningen/contracten/{id}

{subsidie-eenheid} is het erkenningsnummer van de subsidie-eenheid (bv. SE.50), of het nummer van de SE (bv. 50)
{id} is het id van het afrekeningscontract.

Werking

Het afrekeningscontract wordt verwijderd. Indien het afrekeningscontract niet kan worden gevonden, wordt de code '404 - Not found' teruggestuurd.

Response

In geval van succes, zal de response bestaan uit code '200 - OK'.

Een lijst van afrekening bruggepensioneerden opzoeken

Deze web service kan gebruikt worden om een bepaald lijst met afrekeningen bruggepensioneerden op te zoeken aan de hand van de subsidie-eenheid en werkingsjaar.

Requests

Requests worden verstuurd via GET naar /{subsidie-eenheid}/afrekeningen/{werkingsjaar}/gepensioneerden

{subsidie-eenheid} is het erkenningsnummer van de subsidie-eenheid (bv. SE.50), of het nummer van de SE (bv. 50)
{werkingsjaar} is het jaartal waarop de afrekening bruggepensioneerden betrekking hebben.

Response

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>

<ns2:AfrekeningsGepensioneerdenRequest>

<naam>Kazak</naam>

</afrekeningsGepensioneerde>

<naam>Deleuze</naam>

<voornaam>Xxxxx</voornaam>

</afrekeningsGepensioneerde>

</ns2:AfrekeningsGepensioneerdenRequest>

Werking

Indien geen lijst gevonden wordt de code '404 - Not found' teruggestuurd.

Afrekening bruggepensioneerde toevoegen

Deze web service kan gebruikt worden om een lijst van afrekeningen bruggepensioneerde toe te voegen voor een bepaalde subsidie-eenheid en werkingsjaar.

Opmerking : reeds geregistreerde gepensioneerden worden overschreven.

Requests

Requests worden verstuurd via PUT naar /{subsidie-eenheid}/afrekeningen/{werkingsjaar}/gepensioneerden

{subsidie-eenheid} is het erkenningsnummer van de subsidie-eenheid (bv. SE.50), of het nummer van de SE (bv. 50)
{werkingsjaar} is het jaartal waarop de bruggepensioneerden betrekking hebben

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>

<naam>Kazak</naam>

</afrekeningsGepensioneerde>

<naam>Deleuze</naam>

<voornaam>Xxxxx</voornaam>

</afrekeningsGepensioneerde>

</AfrekeningsGepensioneerdenRequest>

Response

Indien OK Status: 200

Een lijst bruggepensioneerden wijzigen

Deze web service kan gebruikt worden om een bestaande lijst over te schrijven met nieuwe gegevens.

Requests

Requests worden verstuurd via PUT naar /{subsidie-eenheid}/afrekeningen/{werkingsjaar}/gepensioneerden/wijzigen

{subsidie-eenheid} is het erkenningsnummer van de subsidie-eenheid (bv. SE.50), of het nummer van de SE (bv. 50)
{werkingsjaar} is het jaartal waarop de prestaties betrekking hebben.

De 'raw payload' v/h request is identiek aan die van het toevoegen.

Response

In geval van succes, zal de response bestaan uit code '200 - OK'.

Een lijst bruggepensioneerden verwijderen

Deze web service kan gebruikt worden om een een lijst bruggepensioneerden van een subsidie-eenheid en werkingsjaar te verwijderen.

Requests

Requests worden verstuurd via DELETE naar /{subsidie-eenheid}/afrekeningen/{werkingsjaar}/gepensioneerden/wijzigen

{subsidie-eenheid} is het erkenningsnummer van de subsidie-eenheid (bv. SE.50), of het nummer van de SE (bv. 50)
{werkingsjaar} is het jaartal waarop de prestaties betrekking hebben.

Werking

De lijst met bruggepensioneerden wordt verwijderd. Indien de lijst niet kan worden gevonden, wordt de code '404 - Not found' teruggestuurd.

Response

In geval van succes, zal de response bestaan uit code '200 - OK'.

Een lijst van variabele prestaties opzoeken

Deze web service kan gebruikt worden om een bepaald lijst met variabele prestaties op te zoeken aan de hand van de subsidie-eenheid en werkingsjaar.

Requests

Requests worden verstuurd via GET naar /{subsidie-eenheid}/afrekeningen/{werkingsjaar}/variabeleprestaties

{subsidie-eenheid} is het erkenningsnummer van de subsidie-eenheid (bv. SE.50), of het nummer van de SE (bv. 50)
{werkingsjaar} is het jaartal waarop de prestaties betrekking hebben.

Response

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>

<ns2:AfrekeningsVariabelePrestatiesResponse>

<functieGroep>GROEP 1</functieGroep>

</afrekeningsVariabelePrestaties>

<functieGroep>GROEP 2</functieGroep>

</afrekeningsVariabelePrestaties>

<functieGroep>GROEP 3</functieGroep>

</afrekeningsVariabelePrestaties>

</ns2:AfrekeningsVariabelePrestatiesResponse>

Werking

Indien geen lijst gevonden wordt de code '404 - Not found' teruggestuurd.

Variabele prestaties toevoegen

Deze web service kan gebruikt worden om een lijst van variabele prestaties toe te voegen voor een bepaald erkenningsnummer en werkingsjaar

Requests

Requests worden verstuurd via PUT naar /{subsidie-eenheid}/afrekeningen/{werkingsjaar}/variabeleprestaties

{subsidie-eenheid} is het erkenningsnummer van de subsidie-eenheid (bv. SE.50), of het nummer van de SE (bv. 50)
{werkingsjaar} is het jaartal waarop de variabele prestaties betrekking hebben

Een request moet altijd drie prestaties entries bevatten : GROEP 1, GROEP 2 en GROEP3. Het ziet er als volgt uit :

<functieGroep>GROEP 1</functieGroep>

</AfrekeningsVariabelePrestaties>

<functieGroep>GROEP 2</functieGroep>

</AfrekeningsVariabelePrestaties>

<functieGroep>GROEP 3</functieGroep>

</AfrekeningsVariabelePrestaties>

</AfrekeningsVariabelePrestatiesRequest>

Response

Indien OK Status: 200

Een lijst variabele prestaties wijzigen

Deze web service kan gebruikt worden om een bestaande lijst over te schrijven met nieuwe gegevens.

Requests

Requests worden verstuurd via PUT naar /{subsidie-eenheid}/afrekeningen/{werkingsjaar}/variabeleprestaties/wijzigen

{subsidie-eenheid} is het erkenningsnummer van de subsidie-eenheid (bv. SE.50), of het nummer van de SE (bv. 50)
{werkingsjaar} is het jaartal waarop de prestaties betrekking hebben.

De 'raw payload' v/h request is identiek aan die van het toevoegen

Response

In geval van succes, zal de response bestaan uit code '200 - OK'.

Een lijst variabele prestaties verwijderen

Deze web service kan gebruikt worden om een een lijst variabele prestaties van een subsidie-eenheid en werkingsjaar te verwijderen.

Requests

Requests worden verstuurd via DELETE naar /{subsidie-eenheid}/afrekeningen/{werkingsjaar}/variabeleprestaties/wijzigen

{subsidie-eenheid} is het erkenningsnummer van de subsidie-eenheid (bv. SE.50), of het nummer van de SE (bv. 50)
{werkingsjaar} is het jaartal waarop de prestaties betrekking hebben.

Werking

De lijst met prestaties wordt verwijderd. Indien de lijst niet kan worden gevonden, wordt de code '404 - Not found' teruggestuurd.

Response

In geval van succes, zal de response bestaan uit code '200 - OK'.

Foutcodes

Zoals een gewone http dienst geeft de REST service van zorgregie ook een status code terug om het resultaat van de request weer te geven. Je kan bij de REST services van zorgregie de volgende codes verwachten:

200	OK	De request is correct afgewerkt.
201	Created	De meegegeven entiteit werd succesvol aangemaakt.
400	Bad Request	Er is een probleem met de opgegeven parameters.
404	Not Found	De opgevraagde locatie/entiteit bestaat niet.
403	Forbidden	De authenticatie is gefaald, of je hebt geen authorisatie voor de opgevraagde data.
500	Internal Server Error	Er is een interne fout voorgekomen. Er wordt een foutboodschap meegegeven in de payload van de response om te verduidelijken.

Je kan alle bestaande response codes hier bekijken: xxxx://xxx.x0.xxx/Xxxxxxxxx/xxx0000/xxx0000-xxx00.xxxx

pagina 1 van 26

Document Metadata

Table of Contents

VAPH publieke API's Versie 1.1

Document Metadata