API Restful - Description - Address - funnelpostcode - GET

Support DQE
Support DQE
  • Updated

funnelpostcode request :
https://{SERVER_ADDRESS}/{VERSION}/funnelpostcode/?PostalCode={POSTAL_CODE}&Country={COUNTRY_CODE}&Extended={EXTENDED}&Licence={LICENCE_CODE}&Limit={INTEGER}&Filter={INTEGER}&Length={LENGTH}

Simply replace the items in braces with your information:

ParameterExpected value typeValue descriptionMandatory/Optional
Server address{SERVER_ADDRESS}Address of the DQE server that will process the dataMandatory
Version{VERSION}

Version of the API

Example : v1

Mandatory
Licence{LICENCE_CODE}Number assigned to you as your license codeMandatory
PostalCode{POSTAL_CODE}Postal code to be searchedMandatory
Country{COUNTRY_CODE}ISO country code (3 letters)Mandatory
Extended{EXTENDED}

Y or N


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
Limit{INTEGER}Maximum value of suggestion in the CP callOptional
Filter{INTEGER}

1 = Postal code & PoBox

2 = Postal code & Street

3 = Postal code

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

Optional
Length{LENGTH}Maximum caracters allowed (minimum : 32)Optional
Langue{LANGUAGE}

For Japan only,

JP = Kanji

JK = Katakana

EN = English

Optional

Related to

Was this article helpful?

0 out of 0 found this helpful