Compl response success
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),
- "AdditionalAddresses": a list containing one or more address objects.
Each address object is itself a dictionary containing the following keys:
| Key | Description | Value | 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 (e.g., building, residence). | "BUILDING 1" | String |
| AdditionalAddresses[0].PostalCode | Postal code of the additional address (empty here). | "" | String |
| Geolocalisation | Geolocation information of the address. | { "Latitude": "48.819006", "Longitude": "2.361861" } | Object |
| Geolocalisation.Latitude | Geographic coordinate (latitude). | "48.819006" | String or number |
| Geolocalisation.Longitude | Geographic coordinate (longitude). | "2.361861" | String or number |
Example:
{
"Found": 6,
"AdditionalAddresses": [
{
"AdditionalAddress": "BATIMENT 1",
"PostalCode": ""
}
],
"Geolocalisation": {
"Latitude": "48.819006",
"Longitude": "2.361861"
}
}
Compl response error
| Error type | Request | Response type |
| 400 | Missing a 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 functionnality", "details": "deded", "error": "unauthorized_client" } |
Related to