API - Description - Address - CP - GET

Support DQE
Support DQE
  • Updated

CP request :
https://{SERVER_ADDRESS}/CP/?CodePostal={POSTAL_CODE}&Alpha=True&Instance={VALUE}&Pays={COUNTRY_CODE}&Etendue=Y&Licence={LICENCE_CODE}&NbMax={NB_MAX}

Simply replace the items in braces with your information:

ParameterValue of the parameterValue descriptionMandatory/Optional
Server address{SERVER_ADDRESS}Address of the DQE server that will process the dataMandatory
Licence{LICENCE_CODE}Number assigned to you as your license codeMandatory
CodePostal{POSTAL_CODE}Postal code to be searchedMandatory
Pays{COUNTRY_CODE}ISO country code (3 letters)Mandatory
AlphaTrueAlways send « True » valueMandatory
Instance{VALUE}Allows you to pass a value during the callOptional
EtendueY

Allows you to search with at least 2 digits in Postal Code

For FRA and BEL only, the grouping of postal codes by municipality is fragmented.

Optional
NbMax{NB_MAX}Maximum value of suggestion in the CP callOptional
Filter{FILTER}

1 = Postal code & PoBox

2 = Postal code & Street

3 = Postal code

4 = One suggestion per Postal Code and City (MYS only)

Optional
Langue{LANGUAGE}

For Japan only,

JP = Kanji

KT = Katakana

EN = English

Optional

Related to

Was this article helpful?

0 out of 0 found this helpful