Uitfasering MKG API versie 1

Uitfasering versie 1

Om in de toekomst verder te kunnen blijven ontwikkelen is een aanpassing in de aanroepafhandeling benodigd. In de MKG API versie 3 zijn deze wijzigingen doorgevoerd. Er zijn geen wijzigingen in de bestaande endpoints. Vanaf MKG versie 005.076 wordt de API versie 1 niet meer doorontwikkeld en vanaf MKG versie 005.082 is deze niet meer beschikbaar. Naast versie 1 zal op termijn ook de interne versie 2 (bridge) uitgefaseerd worden (alleen van toepassing voor MKG applicaties).

Overstappen naar versie 3

Voor het overstappen van versie 1 naar versie 3 zijn beperkte aanpassingen benodigd:

URL aanpassen

{{basisUrl}} = https://{{subdomain}}.{{domain}}.{{tld}}:{{port}}/{{root}}

MKG API versie 1: {{basisUrl}}/rest/v1/MKG/

MKG API versie 3: {{basisUrl}}/web/v3/MKG/

Voorbeeld {{restUrl}}: https://mkgapi.klantnaam.nl:443/mkg/web/v3/MKG/

GET aanroep zonder fieldlist geeft alleen index velden

Indien een GET aanroep geen fieldlist bevat, zal MKG alleen de index velden retourneren. Het is daarom belangrijk om de gewenste velden mee te geven in de aanroep:

Voorbeeld:

GET {{restUrl}}/Documents/rela/{{rela_num}}?FieldList=rela_num,rela_naam,rela_plaats 

GET aanroep met paginering afgedwongen

Bij een GET aanroep met meer dan 100 resultaten zullen alleen de eerste 100 resultaten getoond worden. Door gebruik te maken van NumRows en SkipRows kunnen de volgende 100 records opgehaald worden.

Indien geen NumRows wordt meegegeven zal MKG NumRows=100 toepassen.
De maximale waarde van NumRows is vanaf MKG versie 005.081 verhoogd naar 1000.

Voorbeeld:

Eerste 1000 records:

GET {{restUrl}}/Documents/rela?NumRows=1000&SkipRows=0

Volgende 1000 records:

GET {{restUrl}}/Documents/rela?NumRows=1000&SkipRows=1000

Volgende 1000 records:

GET {{restUrl}}/Documents/rela?NumRows=1000&SkipRows=2000

Na de resultaten zal een voorstel aanroep gedaan worden voor de volgende 1000 records of de vorige 1000 records indien er meer records beschikbaar zijn:

GET {{restUrl}}/Documents/rela?NumRows=1000&SkipRows=2000

[...]