API Restful - Description - Address - funnelcompl - Response

Support DQE
Support DQE
  • Updated

This page describes the JSON response returned by the /funnelcompl/ endpoint used in Restful Funnel mode.

Related Address documentation:

Restful funnelcompl success response

The JSON response is a dictionary containing two main keys:

  • Found: integer indicating the number of additional addresses found.
  • AdditionalAddresses: list containing one or more additional address objects.

Each additional address object contains the following fields:

Field Meaning Always in JSON? Type / Format
AdditionalAddress Additional address line, for example building, tower or block. Yes STRING(255)
PostalCode Postal / ZIP code. Yes STRING(10-20), may be empty

Geolocalisation object:

Field Meaning Always in JSON? Type / Format
Latitude Latitude coordinate. Yes DECIMAL(18), empty string possible
Longitude Longitude coordinate. Yes DECIMAL(18), empty string possible

Example:

{
  "Found": 1,
  "AdditionalAddresses": [
    {
      "AdditionalAddress": "TOUR RAVENNE",
      "PostalCode": ""
    }
  ],
  "Geolocalisation": {
    "Latitude": "",
    "Longitude": ""
  }
}

Restful funnelcompl response error

Error type Response type
Missing mandatory parameter { "status": 400, "message": "Missing parameters", "details": "PostalCode", "error": "bad request" }
Country value is not ISO3 { "status": 400, "message": "Country doesn't exist", "details": "JPNde", "error": "bad request" }
Wrong licence value { "status": 401, "message": "Your licence is not allowed to cover this functionality", "details": "WRONG LICENSE", "error": "unauthorized_client" }

Related to

Was this article helpful?

0 out of 0 found this helpful