Server administration
Postcode Extension
The postcode extension translates a (Dutch) postcode + house number in a full address contacting an external service. The extension exposes a custom api that can be called by a widget in the ui.
The extension must be activated and configured to add the service base url and api key
| property name | value |
|---|---|
| server.baseUri | https://postcode-api.apiwise.nl/v2/addresses/?postcode=${postcode}&number=${number} |
| server.apiKey | api key found on https://www.postcodeapi.nu |
Api
POST/rest/consultation/extension/postcodeExtension#find
| Query parameters | none |
| Header | Content-Type: application/json
auth-token consultationId |
| Header/Parameter | none |
| Body |
{
"postcode":"value", "number":value } |
| Returns |
{
"id":"postcodeExtension#find", "result":{ "city":"value", "street":"value", "number":value }, "hideQuestions":false, "failIfUnsupported":false } |
| Required role | none |