API - Description - Geocoding - LATLG

Support DQE
Support DQE
  • Updated

The LATLG endpoint converts a street identifier and street number into geographic coordinates (latitude and longitude).

Related Geocoding documentation:

GET request

Endpoint

https://{SERVER_ADDRESS}/LATLG/?IDVoie={STREET_ID}&Num={NUM}&Pays={COUNTRY_CODE}&Taille={LENGTH}&Instance={VALUE}&Licence={LICENCE_CODE}

Replace the values in braces with your own information:

Parameter Description Mandatory/Optional
SERVER_ADDRESS DQE server address used to process the request. Mandatory
Licence Your DQE licence code. Mandatory
IDVoie Unique street identifier returned by the ADR command. Mandatory
Num Street number. Mandatory
Pays ISO 3-letter country code. Mandatory
Taille Maximum address length. Default value: 38. Optional
Instance Custom value returned as-is in the response. Optional

POST request

Endpoint

https://{SERVER_ADDRESS}/LATLG/

Add the following parameters in the request body using x-www-form-urlencoded.

Parameter Description Mandatory/Optional
Licence Your DQE licence code. Mandatory
IDVoie Unique street identifier returned by the ADR command. Mandatory
Num Street number. Mandatory
Pays ISO 3-letter country code. Mandatory
Taille Maximum address length. Default value: 38. Optional
Instance Custom value returned as-is in the response. Optional

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
CodeQualiteGeo Code of the geocoding quality type. No String
LibelleQualiteGeo Label 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",
    "Longitude": "2.235501",
    "CodeQualiteGeo": "1",
    "LibelleQualiteGeo": "ENTREE"
  }
}

Error response

Error type Response
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"
  }
}

Related to

Was this article helpful?

0 out of 0 found this helpful