API - Description - Address - CP - POST

Support DQE
Support DQE
  • Updated

Header : https://{SERVER_ADDRESS}/CP/

The value {SERVER_ADDRESS} is the address of the DQE server that will process the data.
Simply add the parameters below in the Body to "x-www-form-urlencoded":

Parameter Expected value type Value description Mandatory/Optional
Licence {LICENCE_CODE} Number assigned to you as your license code Mandatory
CodePostal {POSTAL_CODE} Postal code to be searched Mandatory
Pays {COUNTRY_CODE} ISO country code (3 letters) Mandatory
Alpha True Always send « True » value Mandatory
Instance {VALUE} Allows you to pass a value during the call Optional
Etendue Y Allows you to search with at least 2 digits in Postal Code Optional
NbMax {INTEGER} Maximum value of suggestion in the CP call Optional
Filter {INTEGER}

1 = Postal code & Cedex

2 = Postal code & Street

3 = Postal code

Optional

 

NB: 'NbMax' parameter will need to be set alongside the 'Filter' parameter in order to return a valid response, whilst 'Filter' parameter can be employed without the 'NbMax' parameter being set.

Related to

Was this article helpful?

0 out of 0 found this helpful