API Restful - Description - Address - funnelcompl - Response

Support DQE
Support DQE
  • Updated

Success funnelcompl answer

The JSON response is a dictionary (object) containing two main keys:

  • "Found": an integer indicating the number of addresses found (e.g., 0 or 1),
  • "AdditionalAddress": a list containing one or more address objects.

Each AdditionalAddress is itself a dictionary containing the following keys:

FieldMeaningAlways in JSON?Type / Format
AdditionalAddressAdditional address line (e.g. building, tower, block)YesSTRING(255)
PostalCodePostal / ZIP codeYesSTRING(10–20) (can be empty)

Informations object : 

FieldMeaningAlways in JSON?Type / Format
LatitudeLatitudeYesDECIMAL(18) (empty string possible)
LongitudeLongitudeYesDECIMAL(18) (empty string possible)

Example:

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

 

Error

Error typeResponse 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 license value{"status": 401, "message": "Your licence is not allowed to cover this functionnality", "details": "WRONG LICENSE", "error": "unauthorized_client"}

Related to

Was this article helpful?

0 out of 0 found this helpful