API - Description - Geocoding / Reverse Geo - Response

Support DQE
Support DQE
  • Updated

This page describes the responses returned by the Geocoding and Reverse Geocoding APIs.

Related Geocoding documentation:

Geocoding response

Success response

The JSON response is a dictionary whose keys are numbered from 1 to n. Each element contains the following keys:

Key Description All countries? Format
Latitude Latitude of the address. Yes Decimal
Longitude Longitude of the address. Yes Decimal
LibelleQualiteGeo Label of the geocoding quality type. No String
CodeQualiteGeo Code of the geocoding quality type. No String

Geocoding quality codes

CodeQualiteGeo LibelleQualiteGeo Description
1 ENTREE Main access point to an open or closed enclosure, a group of buildings, or a piece of land.
2 BATIMENT Building or part of a building.
3 ESCALIERS Stairwell, normally inside a building.
4 LOGEMENT Housing or room inside a building.
5 PARCELLE CADASTRALE Cadastral parcel.
6 SEGMENT DE VOIE Position derived from the connecting street segment.
7 POINT D ACCESS TECHNIQUE Technical access point.
8 POINT DELIVRANCE POSTALE Postal delivery point, such as a mailbox.
9 ZONE D ADRESSAGE Point placed in the dependent locality.
10 CENTRE VILLE City center.
00 CENTRE DE LA VOIE Point in the center of the street.
90 A CONTROLER To check.
99 NON PRESENTE Not available.

Example:

{
  "1": {
    "Latitude": "48.836069",
    "LibelleQualiteGeo": "ENTREE",
    "Longitude": "2.235501",
    "CodeQualiteGeo": "1"
  }
}

Error response

Error type Response type
Missing, empty, or incorrect Licence parameter Returns latitude and longitude equal to 0.00.
Missing IDVoie parameter 500 Internal Server Error
Missing Num parameter 500 Internal Server Error
Missing Pays parameter 500 Internal Server Error
Parameter typo 500 Internal Server Error

Example of licence error:

{
  "1": {
    "Latitude": "0.00",
    "Longitude": "0.00"
  }
}

Reverse geocoding response

Success response

The JSON response is a dictionary whose keys are numbered from 1 to n. Each element contains the following keys:

Key Description France International
IDLocalite Unique code for each city. For France, this is the INSEE code. STRING(10) STRING(10)
Saisie Empty. - -
Pays ISO country code. STRING(3) STRING(3)
CodePostal Postal code of the city. INTEGER(5) STRING(10)
Localite City name. STRING(38) STRING(50)
Roudis Roudis code, available for France only. INTEGER(5) Not available
Instance Value passed in the request and returned in the response. INTEGER(1) INTEGER(1)
IDVoie Unique street identifier. INTEGER(8) STRING(10)
Voie Street name. STRING(38) STRING(50)
Numero / Num Street number. INTEGER(4) INTEGER(4)
NbNumero Number of street numbers. INTEGER(4) INTEGER(4)
ListeNumero Empty. - -

Example:

{
  "1": {
    "IDLocalite": "92044",
    "Saisie": "",
    "Nbnumero": "1",
    "Pays": "FRA",
    "IDVoie": "1749869",
    "Voie": "RUE VICTOR HUGO",
    "Numero": "104",
    "Instance": "",
    "ListeNumero": "",
    "Num": "104",
    "CodePostal": "92300",
    "NbNumero": "1",
    "Localite": "LEVALLOIS PERRET",
    "CodeVoie": "1749869"
  }
}

Related to

Was this article helpful?

0 out of 0 found this helpful