Phasing out MKG API version 1

Phasing out version 1

In order to continue developing in the future, an adjustment to the call handling is required. These changes have been implemented in the MKG API version 3. There are no changes to the existing endpoints. From MKG version 005.076 the API version 1 is no longer developed and from MKG version 005.080 it is no longer available. In addition to version 1, the internal version 2 (bridge) will also be phased out in the long term (only applicable for MKG applications).

Switch to version 3

Limited adjustments are required to switch from version 1 to version 3:

Adjusting URL

{{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 call without fieldlist returns only index fields

If a GET call does not contain a fieldlist, MKG will return only the index fields. It is therefore important to provide the desired fields in the call:

Example:

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

GET call with pagination enforced

For a GET call with more than 100 results, only the first 100 results will be shown. By using NumRows and SkipRows, the next 100 records can be retrieved.

Example:

First 100 records:

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

Next 100 records:

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

Next 100 records:

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

After the results, a proposal call will be made for the next 100 records or the previous 100 records if more records are available:

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

[...]