Use the /funnelcompl/ endpoint as the third step in the Restful funnel address search flow. Retrieve building or apartment complement details for an address selected from a /funneladdress/ response. Pass the StreetId and StreetNumber values returned by /funneladdress/ as input.
GET request
Endpoint
https://{SERVER_ADDRESS}/{VERSION}/funnelcompl/?StreetId={STREET_ID}&Country={COUNTRY_CODE}&StreetNumber={NUMBER}&Licence={LICENCE_CODE}&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 |
| VERSION | {VERSION} | Version of the API (e.g. v1). | Mandatory |
| Licence | {LICENCE_CODE} | Licence code assigned to your account or token generated by oauth2. | Mandatory |
| StreetId | {STREET_ID} | Street ID returned by /funneladdress/. | Mandatory |
| Country | {COUNTRY_CODE} | ISO 3-letter country code. | Mandatory |
| StreetNumber | {NUMBER} | Street number returned by /funneladdress/. | Mandatory |
| Langue | {LANGUAGE} | For Japan only: JP Kanji, JK Katakana, EN English. | Optional |
POST request
Endpoint
https://{SERVER_ADDRESS}/{VERSION}/funnelcompl/Add the parameters below in the request body using x-www-form-urlencoded.
| Parameter | Value | Description | Mandatory/Optional |
|---|---|---|---|
| Licence | {LICENCE_CODE} | Licence code assigned to your account or token generated by oauth2. | Mandatory |
| StreetId | {STREET_ID} | Street ID returned by /funneladdress/. | Mandatory |
| Country | {COUNTRY_CODE} | ISO 3-letter country code. | Mandatory |
| StreetNumber | {NUMBER} | Street number returned by /funneladdress/. | Mandatory |
| Langue | {LANGUAGE} | For Japan only: JP Kanji, JK Katakana, EN English. | Optional |
Response
Success response
{
"Found": 3,
"AdditionalAddresses": [
{"AdditionalAddress": "BAT A", "PostalCode": "75008"},
{"AdditionalAddress": "BAT B", "PostalCode": "75008"},
{"AdditionalAddress": "APPT 12", "PostalCode": "75008"}
],
"Geolocalisation": {
"Latitude": "48.871556",
"Longitude": "2.307789"
}
}| Key | Description |
|---|---|
| Found | Number of complements returned. |
| AdditionalAddresses | Array of complement objects. |
| AdditionalAddresses.AdditionalAddress | Building or apartment complement label. |
| AdditionalAddresses.PostalCode | Postal code associated with the complement. |
| Geolocalisation | Geolocation object. |
| Geolocalisation.Latitude | Latitude of the address. |
| Geolocalisation.Longitude | Longitude of the address. |
Error response
Errors are returned as JSON in the following format:
{
"status": 400,
"message": "...",
"details": "...",
"error": "..."
}| Status | Cause |
|---|---|
400 | Missing mandatory parameter, or invalid parameter value. |
401 | Missing, empty, or incorrect Licence parameter. |