kadaster / klic-win

https://kadaster.nl/zakelijk/registraties/landelijke-voorzieningen/klic
21 stars 16 forks source link

Verduidelijk request en response parameters betreffende id/key t.a.v. codelijsten #32

Closed stephanmahieu closed 8 years ago

stephanmahieu commented 8 years ago

In de documentatie wordt niet goed duidelijk uitgelegd dat bij het zoeken met een parameter uit de codelijst een id moet worden gebruikt en dat het id het gedeelte is na de laatste slash van een key (URI). In de response wordt wel de volledige key (URI) wordt geretourneerd. Aan de hand van de voorbeelden is het wel af te leiden maar wellicht is het verstandig de documentatie t.a.v. dit punt iets meer te verduidelijken.

Voorbeeld: Zoeken naar gebiedsinformatie-aanvragen met request parameter aanvraagSoort bijvoorbeeld aanvraagSoort=orientatiemelding. In de json response wordt de volledig key geretourneerd: "aanvraagSoort": "https://api.kadaster.nl/klic/v1/cl/aanvraagSoorten/orientatiemelding"

martinborgman commented 8 years ago

Wordt verduidelijkt in de volgende versie van het document

martinborgman commented 8 years ago

Volgende versie is gepubliceerd