CP GET request
The /CP/ endpoint is used in FUNNEL mode to search for postal codes and localities.
Endpoint
https://{SERVER_ADDRESS}/CP/?CodePostal={POSTAL_CODE}&Alpha=True&Instance={VALUE}&Pays={COUNTRY_CODE}&Etendue=Y&Licence={LICENCE_CODE}&NbMax={NB_MAX}&Filter={FILTER}&Langue={LANGUAGE}
Replace the values in braces with your own information.
| Parameter | Value | Description | Mandatory/Optional |
|---|---|---|---|
| SERVER_ADDRESS | {SERVER_ADDRESS} | Address of the DQE server that will process the data. | Mandatory |
| Licence | {LICENCE_CODE} | Licence code assigned to your account. | Mandatory |
| CodePostal | {POSTAL_CODE} | Postal code to be searched. | Mandatory |
| Pays | {COUNTRY_CODE} | ISO 3-letter country code. | Mandatory |
| Alpha | True | Always send the value True. | Mandatory |
| Instance | {VALUE} | Allows you to pass a value during the call. This value is returned in the response. | Optional |
| Etendue | Y | Allows search with at least 2 digits in the postal code. For France and Belgium only, the grouping of postal codes by municipality is fragmented. | Optional |
| NbMax | {NB_MAX} | Maximum number of suggestions returned by the CP call. | Optional |
| Filter | {FILTER} | 1: postal code and PO Box; 2: postal code and street; 3: postal code; 4: one suggestion per postal code and city, for Malaysia only. | Optional |
| Langue | {LANGUAGE} | For Japan only: JP Kanji, JK Katakana, EN English. | Optional |
Related to