API - Description - Geocoding / Reverse Geo - Response

Support DQE
Support DQE
  • Updated

Geocoding

Success

The JSON response is a dictionary whose keys are the numbers from 1 to n and where each element is itself a dictionary containing 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 type of geocoding No String
CodeQualiteGeo Code of the type of geocoding No String

 

Details of the return codes for the « LibelleQualiteGeo » « CodeQualiteGeo » keys :

CodeQualiteGeo  LibelleQualiteGeo Description
1 ENTREE Main access point to an open or closed enclosure, to a group of buildings or to a piece of land (address plate)
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 segment of the connecting street. (Modification of some BAN data because located outside the city polygon, but on the same street)
7 POINT D ACCESS TECHNIQUE Technical access point (e.g., room with water, electricity, gas shut offs, etc.)
8 POINT DELIVRANCE POSTALE Postal delivery point (mailbox)
9 ZONE D ADRESSAGE Point placed in the dependent locality
10 CENTRE VILLE Center of the city
0 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

Error type Request Response type
Missing “Licence” parameter  https://{SERVER_ADDRESS}/LATLG/?IDVoie=1456244&Num=22&Taille=38&Pays=FRA
{
"1": {
   "Latitude": "0.00",
   "Longitude": "0.00"
}
}
Empty “Licence” parameter https://{SERVER_ADDRESS}/LATLG/?IDVoie=1456244&Num=22&Taille=38&Pays=FRA&Licence=
{
"1": {
   "Latitude": "0.00",
   "Longitude": "0.00"
}
}
Incorrect licence number https://{SERVER_ADDRESS}/LATLG/?IDVoie=1456244&Num=22&Taille=38&Pays=FRA&Licence={INCORRECT_LICENCE_CODE}
{
"1": {
   "Latitude": "0.00",
   "Longitude": "0.00"
 }
}
Missing “IDVoie” parameter https://{SERVER_ADDRESS}/LATLG/?Num=22&Taille=38&Pays=FRA&Licence={LICENCE_CODE} 500 Internal Server Error
Missing “IDNum” parameter https://{SERVER_ADDRESS}/LATLG/?IDVoie=1456244&Taille=38&Pays=FRA&Licence={LICENCE_CODE} 500 Internal Server Error
Missing “Pays” parameter https://{SERVER_ADDRESS}/LATLG/?IDVoie=1456244&Num=22&Taille=38&Licence={LICENCE_CODE} 500 Internal Server Error
Error on a parameter https://{SERVER_ADDRESS}/LATLG/?IDVie=1456244&Num=22&Taille=38&Pays=FRA&Licence={LICENCE_CODE} 500 Internal Server Error

 

Reverse Geocoding

Success

The JSON response is a dictionary whose keys are the numbers from 1 to n and where each element is itself a dictionary containing the following keys:

Key Value France International
IDLocalite Unique code for each city (INSEE code for France) 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 Name of the city STRING(38) STRING(50)
Roudis Roudis code for France only INTEGER(5) Non disponible
Instance

Number passed as a parameter during the call

and returned to us with the answer

INTEGER(1) INTEGER(1)
IDVoie Unique number to designate the channel INTEGER(8) STRING(10)
Voie Port Name STRING(38) STRING(50)

Numero Ou

Num

Number of numbers in the port INTEGER(4) INTEGER(4)

Nbnumero ou

NbNumero

Number of numbers in the port 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