API Restful - Description - Address - COMPL - Response

Support DQE
Support DQE
  • Updated

This page describes the JSON response returned by the Restful /compl/ endpoint.

Related Address documentation:

Restful COMPL success response

The JSON response is a dictionary containing two main keys:

  • Found: number of addresses found.
  • AdditionalAddresses: list of additional address objects.

Each address object contains the following fields:

Key Description Example Type
Found Number of addresses found. 6 Integer
AdditionalAddresses List of associated additional addresses. [{"AdditionalAddress":"BUILDING 1","PostalCode":""}] Array of objects
AdditionalAddresses[0].AdditionalAddress Additional address information. "BUILDING 1" String
AdditionalAddresses[0].PostalCode Postal code of the additional address. "" String
Geolocalisation Geolocation information of the address. {"Latitude":"48.819006","Longitude":"2.361861"} Object
Geolocalisation.Latitude Latitude coordinate. "48.819006" String or number
Geolocalisation.Longitude Longitude coordinate. "2.361861" String or number

Example:

{
  "Found": 6,
  "AdditionalAddresses": [
    {
      "AdditionalAddress": "BATIMENT 1",
      "PostalCode": ""
    }
  ],
  "Geolocalisation": {
    "Latitude": "48.819006",
    "Longitude": "2.361861"
  }
}

Restful COMPL error response

Error type Request Response type
400 Missing mandatory parameter {"status":400,"message":"Missing parameters","details":"Number","error":"bad request"}
401 Unauthorized client {"status":401,"message":"Your licence is not allowed to cover this functionality","details":"deded","error":"unauthorized_client"}

Related to

Was this article helpful?

0 out of 0 found this helpful