VAPH publieke API's
VAPH publieke API's
Versie 1.1
Disclaimer
REST services voor de geïntegreerde registratie tool ( GIR )
Swagger documentatie
REST Services ISIS
Acceptatie deployment Productie deployment Beveiliging Beschikbare diensten
Een contract registreren
Voorbeeld
Een contract wijzigen Requests Werking Response Voorbeeld
Een contract verwijderen Requests
Een contract opzoeken Requests Response Voorbeeld Werking
Alle contracten opzoeken Requests
pagina 1 van 27
Een prestatie registreren Requests
Een prestatie verwijderen Requests
Een prestatie opzoeken Requests
Alle prestaties opzoeken Requests
Alle afrekeningscontracten opzoeken Requests
Een afrekeningscontract opzoeken Requests
Een afrekeningscontract toevoegen Requests
Een afrekeningscontract wijzigen Requests
Een afrekeningscontract verwijderen Requests
Een lijst van afrekening bruggepensioneerden opzoeken Requests
Afrekening bruggepensioneerde toevoegen Requests
Een lijst bruggepensioneerden wijzigen Requests
Een lijst bruggepensioneerden verwijderen Requests
Een lijst van variabele prestaties opzoeken Requests
Variabele prestaties toevoegen Requests
Een lijst variabele prestaties wijzigen Requests
Een lijst variabele prestaties verwijderen Requests
Doel van dit document
Dit document probeert een overzicht te geven van alle publieke API's die het VAPH ter beschikking stelt.
Disclaimer
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 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
<cont r act >
<wer kne mer >
- 8" s t a nda l one =" ye s " ? >
<r i j kr e gi s t e r nu mme r >xxxxxxxxxx</ r i j kr e gi s t e r nu mme r >
<na a m>xxx</ na a m>
<voor na a m>xxx</ voor na a m>
</ wer kne mer >
<be gi nda t u m>xxx</ be gi nda t u m>
<e i ndda t u m>xxx</ e i ndda t u m>
<f unc t i e >
<c ode >xxx</ c ode >
<o ms c hr i j vi ng>xxxxxxxxx</ o ms c hr i j vi ng>
</ f unc t i e >
<ancJ aar >xx</ ancJ aar >
<a nc Ma a nd>xx</ a nc Ma a nd>
</ cont r act >
● 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)
Er zal in de databank nagegaan worden of de werknemer in kwestie al gekend is. Indien niet, wordt deze aangemaakt.
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.
Een registratie voor werknemer Xxxx Xxx:
<?xml version="1.0" encoding="UTF
<contract>
<werknemer>
- 8" standalone="yes"?>
<rijkregisternummer>27120934734</rijkregisternummer>
<naam>Doe</naam>
<voornaam>Xxxx</voornaam>
</w erknemer>
<begindatum>2014 - 01- 01</begindatum>
<einddatum>2014 - 12- 31</einddatum>
<functie>
<code>630</code>
</functie>
<ancJaar>5</ancJaar>
<ancMaand>11</ancMaand>
</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 worden verstuurd via PUT naar /{subsidie-eenheid}/contract/{contract- id}?user=xxx&password=yyy
{subsidie-eenheid} is de naam van de subsidie-eenheid.
<?xml version="1.0" encoding="UTF
<cont r act >
<wer kne mer >
- 8" s t a nda l one =" ye s " ? >
<r i j kr e gi s t e r nu mme r >xxxxxxxxxx</ r i j kr e gi s t e r nu mme r >
<na a m>xxx</ na a m>
<voor na a m>xxx</ voor na a m>
</ wer kne mer >
<be gi nda t u m>xxx</ be gi nda t u m>
<e i ndda t u m>xxx</ e i ndda t u m>
<f unc t i e >
<c ode >xxx</ c ode >
<o ms c hr i j vi ng>xxxxxxxxxxxxxxxxxxxxx</ o ms c hr i j vi ng>
</ f unc t i e >
<ancJ aar >xx</ ancJ aar >
<a nc Ma a nd>xx</ a nc Ma a nd>
</ cont r act >
{contract-id} is het id van het betreffende contract Een request ziet er als volgt uit:
● 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
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.
In geval van succes, zal de response bestaan uit code '200 - OK'.
Een wijziging voor werknemer Xxxx Xxx (zeer analoog aan de registratie van een contract).
<?xml version="1.0
<cont r act >
<wer kne mer >
<r i j kr e gi s t e r nu mme r >27120934734</ r i j kr e gi s t e r nu mme r >
<naa m>Do e </ naa m>
<voor na a m>J ohn</ voor na a m>
</ wer kne mer >
<be gi nda t u m>2014 - 01 - 01T00: 00: 00. 000+02: 00</ be gi nda t u m>
<e i ndda t u m>2014 - 12 - 31T00: 00: 00. 000+02: 00</ e i ndda t u m>
<f unc t i e >
<c ode >630</ c ode >
</ f unc t i e >
<ancJ aar >5 </ ancJ aar >
<a nc Ma a nd>11</ a nc Ma a nd>
</ cont r act >
" e nc odi ng=" UTF- 8" s t a nda l one =" ye s " ? >
Een contract verwijderen
Deze web service kan gebruikt worden om een contract te verwijderen voor een bepaalde subsidie- eenheid.
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.
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.
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 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:
<?xml version="1.0" encoding="UTF
- 8" s t a nda l one =" ye s " ? >
<ns 2: c ont r a c t x ml ns : ns 2=" ht t p: / / www. va ph. be / z or gr e gi e " >
<i d>xxxxxxxxxxxxxxx</ i d>
<wer kne mer >
<r i j kr e gi s t e r nu mme r >xxxxxxxxxx</ r i j kr e gi s t e r nu mme r >
<na a m>xxx</ na a m>
<voor na a m>xxx</ voor na a m>
</ wer kne mer >
<be gi nda t u m>xxx</ be gi nda t u m>
<e i ndda t u m>xxx</ e i ndda t u m>
<f unc t i e >
<c ode >xxx</ c ode >
<o ms c hr i j vi ng>xxxxxxxxxxxxxxxxxxxxx</ o ms c hr i j vi ng>
</ f unc t i e >
<ancj aar >x</ ancj aar >
<anc maan d>x</ anc maan d>
</ ns 2: c ont r a c t >
Een contract van werknemer Xxxx Xxx.
<? x ml ve r s i on=" 1. 0" e nc odi ng=" UTF- 8" s t a nda l one =" ye s " ? >
<ns 2: c ont r a c t x ml ns : ns 2=" ht t p: / / www. va ph. be / z or gr e gi e " >
<i d>123456789</ i d>
<wer kne mer >
<r i j kr e gi s t e r nu mme r >27120934734</ r i j kr e gi s t e r nu mme r >
<naa m>Do e </ naa m>
<voor na a m>J ohn</ voor na a m>
</ wer kne mer >
<be gi nda t u m>2014 - 01 - 01T00: 00: 00. 000+02: 00</ be gi nda t u m>
<e i ndda t u m>2014 - 12 - 31T00: 00: 00. 000+02: 00</ e i ndda t u m>
<f unc t i e >
<c ode >630</ c ode >
<o ms c hr i j vi ng>LOGI STI EK PERS. KLASSE 3</ o ms c hr i j vi ng>
</ f unc t i e >
<ancj aar >12 </ ancj aar >
<anc maan d>4 </ anc maan d>
</ ns 2: c ont r a c t >
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 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:
<? x ml ve r s i on=" 1. 0" e nc odi ng=" UTF- 8" s t a nda l one =" ye s " ? >
<ns 2: Cont r a c t e n Re s pons e Bi nd x ml ns : ns 2=" ht t p: / / www. va ph. be / z or gr e gi e " >
<cont r act en>
<cont r act >
<i d>xxxxxxxxxxxxxxx</ i d>
<we r kne mer >
<r i j kr e gi s t e r nu mme r >xxxxxxxxxx</ r i j kr e gi s t e r nu mme r >
<na a m>xxx</ na a m>
<voor na a m>xxx</ voor na a m>
</ wer kne mer >
<be gi nda t u m>xxx</ be gi nda t u m>
<e i ndda t u m>xxx</ e i ndda t u m>
<f unc t i e >
<c ode >xxx</ c ode >
<o ms c hr i j vi ng>xxxxxxxxxxxxxxxxxxxxx</ o ms c hr i j vi ng>
</ f unc t i e >
<ancj aar >x</ ancj aar >
<anc maan d>x</ anc maan d>
</ cont r act >
</ cont r act en>
</ ns 2: Cont r a c t e n Re s pons e Bi nd>
De contracten van werknemers Xxxx Xxx en Xxxx Xxx.
<? x ml ve r s i on=" 1. 0" e nc odi ng=" UTF- 8" s t a nda l one =" ye s " ? >
<ns 2: Cont r a c t e n Re s pons e Bi nd x ml ns : ns 2=" ht t p: / / www. va ph. be / z or gr e gi e " >
<cont r act en>
<cont r act >
<i d>123456789</ i d>
<wer kne mer >
<r i j kr e gi s t e r nu mme r >27120934734</ r i j kr e gi s t e r nu mme r >
<naa m>Do e </ naa m>
<voor na a m>J ohn</ voor na a m>
</ wer kne mer >
<be gi nda t u m>2014 - 01 - 01T00: 00: 00. 000+02: 00</ be gi nda t u m>
<e i ndda t u m>2014 - 12 - 31T00: 00: 00. 000+02: 00</ e i ndda t u m>
<f unc t i e >
<c ode >630</ c ode >
<o ms c hr i j vi ng>LOGI STI EK PERS. KLASSE 3</ o ms c hr i j vi ng>
</ f unc t i e >
<ancj aar >5 </ ancj aar >
<anc maan d>7 </ anc maan d>
</ cont r act >
<cont r act >
<i d>123456789</ i d>
<wer kne mer >
<r i j kr e gi s t e r nu mme r >27120934734</ r i j kr e gi s t e r nu mme r >
<naa m>Do e </ naa m>
<voor na a m>J ohn</ voor na a m>
</ wer kne mer >
<be gi nda t u m>2014 - 01 - 01T00: 00: 00. 000+02: 00</ be gi nda t u m>
<e i ndda t u m>2014 - 12 - 31T00: 00: 00. 000+02: 00</ e i ndda t u m>
<f unc t i e >
<c ode >630</ c ode >
<o ms c hr i j vi ng>LOGI STI EK PERS. KLASSE 3</ o ms c hr i j vi ng>
</ f unc t i e >
<ancj aar >15 </ ancj aar >
<anc maan d>3 </ anc maan d>
</ cont r act >
</ cont r act en>
</ ns 2: Cont r a c t e n Re s pons e Bi nd>
Een prestatie registreren
Deze web service kan gebruikt worden om een prestatie te registreren voor een bepaald contract.
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="
<pr es t at i e>
UTF- 8" s t a nda l one =" ye s " ? >
<c ont r a c t I d>xxxxxxxxxxx</ c ont r a c t I d>
<j a a r >xxxx</ j a a r >
<ma a nd>xx</ ma a nd>
<ur e n>xx</ ur e n>
<uur s t e l s e l >xx</ uur s t e l s e l >
<pr es t at i eeenhei d>xx</ pr es t at i eeenhei d>
<a f we z i ghe i d>xx</ a f we z i ghe i d>
</ pr e s t a t i e >
● 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.
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 worden verstuurd via DELETE naar /{subsidie-eenheid}/contract/{contract- id}/prestatie/{prestatie-id}?user=xxx&password=yyy
De prestatie wordt verwijderd. Indien de prestatie niet kan worden gevonden, wordt de code '404 - Not found' teruggestuurd.
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 worden verstuurd via GET naar /{subsidie-eenheid}/contract/{contract- id}/prestatie/{prestatie-id}?user=xxx&password=yyy
<?xml version="1.0" encoding="UTF
- 8" s t a nda l one =" ye s " ? >
<ns 2: pr e s t a t i e x ml ns : ns 2=" ht t p: / / www. va ph. be / z or gr e gi e " >
<i d>xxxxxxxxxxxxx</ i d>
<c ont r a c t I d>xxxxxxxxxxxxx</ c ont r a c t I d>
<j a a r >xxxx</ j a a r >
<ma a nd>x</ ma a nd>
<ur e n>xxxx</ ur e n>
<uur s t e l s e l >xx</ uur s t e l s e l >
<pr es t at i eeenhei d>xx</ pr es t at i eeenhei d>
<a f we z i ghe i d>xx</ a f we z i ghe i d>
</ ns 2 : pr e s t a t i e >
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 worden verstuurd via GET naar /{subsidie-eenheid}/contract/{contract- id}/prestaties?user=xxx&password=yyy
<?xml version="1.0" encoding="UTF
- 8" s t a nda l one =" ye s " ? >
<ns 2: Pr e s t a t i e s Re s pons e Bi nd x ml ns : ns 2=" ht t p: / / www. va ph. be / z or gr e gi e " >
<pr es t at i es >
<pr es t at i e>
<i d>xxxxxxxxxxxx</ i d>
<c ont r a c t I d>xxxxxxxxxxxx</ c ont r a c t I d>
<j a a r >xxxx</ j a a r >
<ma a nd>xx</ ma a nd>
<ur e n>xx</ ur e n>
<uur s t e l s e l >xx</ uur s t e l s e l >
<pr es t at i eeenhei d>xx</ pr es t at i eeenhei d>
<a f we z i ghe i d>xx</ a f we z i ghe i d>
</ pr e s t a t i e >
</ pr e s t a t i e s >
</ ns 2: Pr e s t a t i e s Re s pons e Bi nd>
Alle afrekeningscontracten opzoeken
Deze web service kan gebruikt worden om alle afrekeningscontracten op te zoeken voor een bepaald erkenningsnummer.
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)
<? x ml ve r s i on=" 1. 0" e nc odi ng=" UTF- 8" ? >
<ns 2: Af r e ke ni ngs Cont r a c t Re s pons e x ml ns : ns 2=" ht t p: / / www. va ph. be / z or gr e gi e " >
<a f r e ke ni ng Cont r a c t >
<i d>XXXX</ i d>
<r i j ks r e gi s t e r nu mme r >XXXXXXXXXXX</ r i j ks r e gi s t e r nu mme r >
<na a m>XXXX</ na a m>
<voor na a m>XXXX</ voor na a m>
<f unc t i e >
<c ode >XXXX</ c ode >
<o ms c hr i j vi ng>XXXX</ o ms c hr i j vi ng>
</ f unc t i e >
<ancJ aar >XXXX</ ancJ aar >
<anc Maan d>XXXX</ anc Maan d>
<a nc Da t u m>XXXX</ a nc Da t u m>
<pr es t at i eeenhei d>XXXX</ pr es t at i eeenhei d>
<ge l i j kge s t e l de pe r i ode >XXXX</ ge l i j kge s t e l de pe r i ode >
<pr es t at i ej aar >XXXX</ pr es t at i ej aar >
</ a f r e ke ni ng Cont r a c t >
</ ns 2: Af r e ke ni ngs Cont r a c t Re s pons e >
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 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.
<? x ml ve r s i on=" 1. 0" e nc odi ng=" UTF- 8" s t a nda l one =" ye s " ? >
<Af r e ke ni ngs Cont r a c t x ml ns =" ht t p: / / www. va ph. be / z or gr e gi e " >
<i d>xxx</ i d>
<r i j ks r e gi s t e r nu mme r >XXXXXXXXXXX</ r i j ks r e gi s t e r nu mme r >
<na a m>XXXX</ na a m>
<voor na a m>XXXX</ voor na a m>
<f unc t i e >
<c ode >XX</ c ode >
<o ms c hr i j vi ng>XXXX</ o ms c hr i j vi ng>
</ f unc t i e >
<ancJ aar >XX</ ancJ aar >
<anc Maan d>XX</ anc Maan d>
<a nc Da t u m>XXXXXX</ a nc Da t u m>
<pr es t at i eeenhei d>XX</ pr es t at i eeenhei d>
<ge l i j kge s t e l de pe r i ode >XX</ ge l i j kge s t e l de pe r i ode >
<pr es t at i ej aar >XXXX</ pr es t at i ej aar >
</ Af r e ke ni ngs Cont r a c t >
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 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"?>
<AfrekeningsContract xmlns="xxxx://xxx.xxxx.xx/xxxxxxxxx">
<rijksreg isternummer>XXXXXXXXXXX</rijksregisternummer>
<naam>XXXX</naam>
<voornaam>XXXX</voornaam>
<functie>
<code>XX</code>
<omschrijving>XXXX</omschrijving>
</functie>
<ancJaar>XX</ancJaar>
<ancMaand>XX</ancMaand>
<ancDatum>XXXXXX</ancDatum>
<prestatieeenheid>XX</prestatieeenheid>
<gelijkgesteldeperiode>XX</gelijkgesteldeperiode>
<prestatiejaar>XXXX</prestatiejaar>
</AfrekeningsContract>
<?xml version=" 1.0" encoding="UTF - 8" standalone="yes"?>
<AfrekeningsContract xmlns="xxxx://xxx.xxxx.xx/xxxxxxxxx">
<rijksregisternummer>XXXXXXXXXXX</rijksregisternummer>
<naam>XXXX</naam>
<voornaam>XXXX</voornaam>
<functie>
<code>XX</code>
<omschrijving>XXXX</omschrijving>
</functie>
<ancJaar>XX</ancJaar>
<ancMaand>XX</ancMaand>
<ancDatum>XXXXXX</ancDatum>
<prestatieeenheid>XX</prestatieeenheid>
<gelijkgesteldep eriode>XX</gelijkgesteldeperiode>
<prestatiejaar>XXXX</prestatiejaar>
</AfrekeningsContract>
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 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"?>
<AfrekeningsContract xmln s="xxxx://xxx.xxxx.xx/xxxxxxxxx">
<rijksregisternummer>XXXXXXXXXXX</rijksregisternummer>
<naam>XXXX</naam>
<voornaam>XXXX</voornaam>
<functie>
<code>XX</code>
<omschrijving>XXXX</omschrijving>
</functie>
<ancJaar>XX</ancJaar>
<ancMaand>XX</ancMaand>
<ancDatum>XXXXXX</ancDatum>
<prestatieeenheid>XX</prestatieeenheid>
<gelijkgesteldeperiode>XX</gelijkgesteldeperiode>
<prestatiejaar>XXXX</pre statiejaar>
</AfrekeningsContract>
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 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.
Het afrekeningscontract wordt verwijderd. Indien het afrekeningscontract niet kan worden gevonden, wordt de code '404 - Not found' teruggestuurd.
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 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.
<?xml version="1.0" encoding="UTF
- 8" standalone="yes" ?>
<ns2:AfrekeningsGepensioneerdenRequest>
<afrekeningsGepensioneerde>
<werkingsjaar>2015</werkingsjaar>
<rijksregisterNummer>00000000097</rijk sregisterNummer>
<naam>Kazak</naam>
<voornaam>Xxxx</voornaam>
<functie>130</functie>
<bedrag>250.0</bedrag>
<rsz>50.0</rsz>
</afrekeningsGepensioneerde>
<afrekeningsGepensioneerde>
<werkingsjaar>2015</werkingsjaar>
<rijksregisterNummer>85051000164</rijksregisterNummer>
<naam>Deleuze</naam>
<voornaam>Xxxxx</voornaam>
<functie>130</functie>
<be dr a g>1000. 0</ be dr a g>
<r s z >250. 0</ r s z >
</ a f r e ke ni ngs Ge pe ns i one e r de >
</ ns 2: Af r e ke ni ngs Ge pe ns i one e r de n Re que s t >
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 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
<? x ml ve r s i on=" 1. 0" e nc odi ng=" UTF- 8" s t a nda l one =" ye s " ? >
<Af r ekeni ngs Ge pe ns i one e r de n Re que s t >
<a f r e ke ni ngs Ge pe ns i one e r de >
<we r ki ngs j a a r >2015</ we r ki ngs j a a r >
<r i j ks r e gi s t e r Nu mme r >00000000097</ r i j ks r e gi s t e r Nu mme r >
<naa m>Kazak </ naa m>
<voor na a m>J e f f </ voor na a m>
<f unc t i e >130</ f unc t i e >
<be dr a g>250. 00</ be dr a g>
<r s z >50. 00</ r s z >
</ a f r e ke ni ngs Ge pe ns i one e r de >
<a f r e ke ni ngs Ge pe ns i one e r de >
<we r ki ngs j a a r >2015</ we r ki ngs j a a r >
<r i j ks r e gi s t e r Nu mme r >85051000164</ r i j ks r e gi s t e r Nu mme r >
<naa m>Del euze </ naa m>
<voor na a m>Gui do</ voor na a m>
<f unc t i e >130</ f unc t i e >
<be dr a g>1000. 00</ be dr a g>
<r s z >250. 00</ r s z >
</ a f r e ke ni ngs Ge pe ns i one e r de >
</ Af r e ke ni ngs Ge pe ns i one e r de n Re que s t >
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 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.
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 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.
De lijst met bruggepensioneerden wordt verwijderd. Indien de lijst niet kan worden gevonden, wordt de code '404 - Not found' teruggestuurd.
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 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.
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<ns2:AfrekeningsVariabelePrestatiesResponse>
<afrekeningsVariabelePrestaties>
<werkingsjaar>2015</werkingsjaar>
<functieGroep>GROEP 1</functieGroep>
<urenPrestatieZondag>21.2</urenPrestatieZondag>
<loonPrestatieZondag>120.0</loonPrestatieZondag>
<urenPrestatieZaterdag>10.3</urenPrestatieZaterdag>
<loonPrestatieZaterdag>1258.0</loonPrestatieZaterdag>
<urenPrestatieAvond>4.1</urenPr estatieAvond>
<loonPrestatieAvond>789.0</loonPrestatieAvond>
<urenPrestatieNacht>0.0</urenPrestatieNacht>
<loonPrestatieNacht>0.0</loonPrestatieNacht>
<urenPrestatieFeestdag>12.25</urenPrestatieFeestdag>
<loonPrestatieFeestdag >1250.52</loonPrestatieFeestdag>
<urenGewaarborgdLoon>10.25</urenGewaarborgdLoon>
<loonGewaarborgdLoon>250.0</loonGewaarborgdLoon>
<dubbelVakantieGeld>0.0</dubbelVakantieGeld>
<enkelvoudigVakantieGeld>0.0</enkelvoudigVakantieGeld>
</afrekeningsVariabelePrestaties>
<afrekeningsVariabelePrestaties>
<werkingsjaar>2015</werkingsjaar>
<functieGroep>GROEP 2</functieGroep>
<urenPrestatieZondag>21.2</urenPrestatieZondag>
<loonPrestatieZondag>120.0< /loonPrestatieZondag>
<urenPrestatieZaterdag>10.3</urenPrestatieZaterdag>
<loonPrestatieZaterdag>1258.0</loonPrestatieZaterdag>
<urenPrestatieAvond>4.1</urenPrestatieAvond>
<loonPrestatieAvond>789.0</loonPrestatieAvond>
<urenP restatieNacht>0.0</urenPrestatieNacht>
<loonPrestatieNacht>0.0</loonPrestatieNacht>
<urenPrestatieFeestdag>12.25</urenPrestatieFeestdag>
<l oonPr e s t a t i e Fe e s t da g>1250. 52</ l oonPr e s t a t i e Fe e s t da g>
<ur e n Ge wa a r bor gdLoon>2. 25</ ur e n Ge wa a r bor gdLoon>
<l oon Ge wa a r bor gdLoon>250. 0</ l oon Ge wa a r bor gdLoon>
<dubbe l Va ka nt i e Ge l d>0. 0</ dubbe l Va ka nt i e Ge l d>
<e nke l voudi g Va ka nt i e Ge l d>0. 0</ e nke l voudi g Va ka nt i e Ge l d>
</ af r ekeni ngs Var x xxxx e Pr es t at i es >
<af r ekeni ngs Var x xxxx e Pr es t at i es >
<we r ki ngs j a a r >2015</ we r ki ngs j a a r >
<f unc t i e Gr oe p>GROEP 3</ f unc t i e Gr oe p>
<ur e nPr e s t a t i e Xxxxx g>21. 2</ ur e nPr e s t a t i e Xxxxx g>
<l oonPr e s t a t i e Xxxxx g>120. 0</ l oonPr e s t a t i e Xxxxx g>
<ur en Pr es t at i e Zat er dag>10 . 3 </ ur en Pr es t at i e Zat er dag>
<l oonPr e s t a t i e Za t e r da g>1258. 0</ l oonPr e s t a t i e Za t e r da g>
<ur e nPr e s t a t i e Avond>4. 1</ ur e nPr e s t a t i e Avond>
<l oonPr e s t a t i e Avond>789. 0</ l oonPr e s t a t i e Avond>
<ur en Pr es t at i e Nach t >0 . 0 </ ur en Pr es t at i e Nach t >
<l oon Pr e s t a t i e Na c ht >0 . 0 </ l oon Pr e s t a t i e Na c ht >
<ur en Pr es t at i e Fees t dag>12 . 25 </ ur en Pr es t at i e Fees t dag>
<l oonPr e s t a t i e Fe e s t da g>1250. 52</ l oonPr e s t a t i e Fe e s t da g>
<ur e n Ge wa a r bor gdLoon>5. 43</ ur e n Ge wa a r bor gdLoon>
<l oon Ge wa a r bor gdLoon>250. 0</ l oon Ge wa a r bor gdLoon>
<dubbe l Va ka nt i e Ge l d>0. 0</ dubbe l Va ka nt i e Ge l d>
<e nke l voudi g Va ka nt i e Ge l d>0. 0</ e nke l voudi g Va ka nt i e Ge l d>
</ af r ekeni ngs Var x xxxx e Pr es t at i es >
</ ns 2 : Af r ekeni ngs Var x xxxx e Pr es t at i es Res pons e>
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 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 :
<Af r ekeni ngs Var x xxxx e Pr es t at i es Reques t >
<Af r ekeni ngs Var x xxxx e Pr es t at i es >
<we r ki ngs j a a r >2015</ we r ki ngs j a a r >
<f unc t i e Gr oe p>GROEP 1</ f unc t i e Gr oe p>
<ur e nPr e s t a t i e Xxxxx g>21. 20</ ur e nPr e s t a t i e Zonda g>
<l oonPr e s t a t i e Xxxxx g>120</ l oonPr e s t a t i e Zonda g>
<ur en Pr es t at i e Zat er dag>10 . 30 </ ur en Pr es t at i e Zat er dag>
<l oon Pr e s t a t i e Za t e r da g>1258</ l oonPr e s t a t i e Za t e r da g>
<ur e nPr e s t a t i e Avond>4. 10</ ur e nPr e s t a t i e Avond>
<l oonPr e s t a t i e Avond>789</ l oonPr e s t a t i e Avond>
<ur en Pr es t at i e Nach t >0 . 0 </ ur en Pr es t at i e Nach t >
<l oonPr e s t a t i e Na c ht >0. 0</ l oonPr es t at i e Nach t >
<ur en Pr es t at i e Fees t dag>12 . 25 </ ur en Pr es t at i e Fees t dag>
<l oonPr e s t a t i e Fe e s t da g>1250. 52</ l oonPr e s t a t i e Fe e s t da g>
<ur e n Ge wa a r bor gdLoon>10. 25</ ur e n Ge wa a r bor gdLoon>
<l oon Ge wa a r bor gdLoon>250</ l oon Ge wa a r bor gdLoon>
<dubbe l Va ka nt i e Ge l d>0</ dubbe l Va ka nt i e Ge l d>
<e nke l voudi g Va ka nt i e Ge l d>0</ e nke l voudi g Va ka nt i e Ge l d>
</ Af r ekeni ngs Var x xxxx e Pr es t at i es >
<Af r ekeni ngs Var x xxxx e Pr es t at i es >
<we r ki ngs j a a r >2015</ we r ki ngs j a a r >
<f unc t i e Gr oe p>GROEP 2</ f unc t i e Gr oe p>
<ur e nPr e s t a t i e Xxxxx g>21. 20</ ur e nPr e s t a t i e Zonda g>
<l oonPr e s t a t i e Xxxxx g>120</ l oonPr e s t a t i e Zonda g>
<ur en Pr es t at i e Zat er dag>10 . 30 </ ur en Pr es t at i e Zat er dag>
<l oonPr e s t a t i e Za t e r da g>1258</ l oonPr e s t a t i e Za t e r da g>
<ur e nPr e s t a t i e Avond>4. 10</ ur e nPr e s t a t i e Avond>
<l oonPr e s t a t i e Avond>789</ l oonPr e s t a t i e Avond>
<ur en Pr es t at i e Nach t >0 . 0 </ ur en Pr es t at i e Nach t >
<l oon Pr e s t a t i e Na c ht >0 . 0 </ l oon Pr e s t a t i e Na c ht >
<ur en Pr es t at i e Fees t dag>12 . 25 </ ur en Pr es t at i e Fees t dag>
<l oonPr e s t a t i e Fe e s t da g>1250. 52</ l oonPr e s t a t i e Fe e s t da g>
<ur e n Ge wa a r bor gdLoon>2. 25</ ur e n Ge wa a r bor gdLoon>
<l oon Ge wa a r bor gdLoon>250</ l oon Ge wa a r bor gdLoon>
<dubbe l Va ka nt i e Ge l d>0</ dubbe l Va ka nt i e Ge l d>
<e nke l voudi g Va ka nt i e Ge l d>0</ e nke l voudi g Va ka nt i e Ge l d>
</ Af r ekeni ngs Var x xxxx e Pr es t at i es >
<Af r ekeni ngs Var x xxxx e Pr es t at i es >
<we r ki ngs j a a r >2015</ we r ki ngs j a a r >
<f unc t i e Gr oe p>GROEP 3</ f unc t i e Gr oe p>
<ur e nPr e s t a t i e Xxxxx g>21. 20</ ur e nPr e s t a t i e Zonda g>
<l oonPr e s t a t i e Xxxxx g>120</ l oonPr e s t a t i e Zonda g>
<ur e nPr e s t a t i e Za t e r da g>10. 30</ ur en Pr es t at i e Zat er dag>
<l oonPr e s t a t i e Za t e r da g>1258</ l oonPr e s t a t i e Za t e r da g>
<ur e nPr e s t a t i e Avond>4. 10</ ur e nPr e s t a t i e Avond>
<l oonPr e s t a t i e Avond>789</ l oonPr e s t a t i e Avond>
<ur en Pr es t at i e Nach t >0 . 0 </ ur en Pr es t at i e Nach t >
<l oon Pr e s t a t i e Na c ht >0 . 0 </ l oon Pr e s t a t i e Na c ht >
<ur en Pr es t at i e Fees t dag>12 . 25 </ ur en Pr es t at i e Fees t dag>
<l oonPr e s t a t i e Fe e s t da g>1250. 52</ l oonPr e s t a t i e Fe e s t da g>
<ur e n Ge wa a r bor gdLoon>5. 43</ ur e n Ge wa a r bor gdLoon>
<l oon Ge wa a r bor gdLoon>250</ l oon Ge wa a r bor gdLoon>
<dubbe l Va ka nt i e Ge l d>0</ dubbe l Va ka nt i e Ge l d>
<e nke l voudi g Va ka nt i e Ge l d>0</ e nke l voudi g Va ka nt i e Ge l d>
</ Af r ekeni ngs Var x xxxx e Pr es t at i es >
</ Af r e ke ni ngs Va r i a be l e Pr es t at i es Reques t >
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 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
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 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.
De lijst met prestaties wordt verwijderd. Indien de lijst niet kan worden gevonden, wordt de code '404 - Not found' teruggestuurd.
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