API - Description - Address - SINGLEV2 - Response

Support DQE
Support DQE
  • Updated

SINGLEV2 response 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 :

Examples of requests:

  • Address in France:
    https://{SERVER_ADDRESS}/SINGLEV2/?Adresse=place%20de%20l%27%C3%A9glise
    %20saint%20gervais%20rouen
    &Taille=38&Pays=FRA
    &Licence={LICENCE_CODE}

  • Address in the United Kingdom:
    https://{SERVER_ADDRESS}/SINGLEV2/?Pays=GBR&Adresse=B1%201SB&Taille=38&NbMax=30&Version=1&Licence= {LICENCE_CODE}

  • Address in Belgium:
    https://{SERVER_ADDRESS}/SINGLEV2/Adresse=Rue%20de%20Pi%C3%A9train%20124&Taille=38&Pays=BEL&Licence={LICENCE_CODE}

  • Address in the United States:
    https://{{SERVER_ADDRESS}/SINGLEV2/?Pays=USA&Adresse=110%20AVENUE&Taille=
    38&NbMax=30&Version=1&Licence={LICENCE_CODE}
Key Value France International
Instance Number passed as a parameter during the call and returned in the response STRING(3) STRING(3)
Province

Region where the city is located. Type will depend on the country where the search is performed.

Ex for USA: State’s 2 letter code will be sent here

Not available STRING(50)
IDLocalite Unique code for each city (Insee code for France) STRING(20) STRING(20)
CodePostal City Postal Code STRING(10) STRING(10)
Localite Name of the city STRING(38) STRING(50)
SousLocalite Used for countries other than France Empty STRING(50)
Pays Code ISO du pays STRING(3) STRING(3)
LieuDit Dependent locality if applicable STRING(38) Empty
Latitude Latitude of the address Not available Empty
Longitude Longitude of the address Not available Empty

IDVoie

or CodeVoie

Unique number to identify the street STRING(20) STRING(20)
Label

Label to be presented for auto-completion. The number is put between brackets if it is invalid for this street. A pipe character (|) separates the street from the postal code/city pair to simplify the formatting of the label.

If the street number is enclosed in brackets [], it indicates that the street number does not exist.

STRING(255) STRING(255)
Region3 County Not available STRING(50)
Region2 County Not available STRING(50)
Region1 Official regions Not available STRING(50)
Region4 Other region information Not available STRING(50)
Numero Number in the street with the number complement (bis ter etc...) STRING (38) STRING (38)
Num Number in the street with the number complement (bis ter etc...) STRING(4) STRING(4)

NbNumero

ou

Nbnumero

Number of numbers in the street INTEGER(4) INTEGER(4)
valid_num

1: The number exists in the street

0: The number does not exist in the street

INTEGER(1) Not available
NumSeul Number in the street without the number complement STRING(4) STRING(4)
ListeNumero List of available numbers in the street (key available when the number entered is not valid or when no number has been entered) STRING(1024) STRING(1024)
TypeVoie Street type (street, avenue, etc.) STRING(20) Not available
Voie Street name STRING(38) STRING(150)
Suburb Suburb Not available STRING(50)
Complement Additional address information Empty STRING(50)
Complement2 Additional address information 2 Not available STRING(50)
Saisie Text input (passed in parameter) used to search the street STRING(255) STRING(255)
Entreprise Company name STRING(38) UK Only
Thoroughfare
Dependant street Not available UK Only

Example:

{
  "1": {
    "Instance": "",
    "CodePostal": "E2 8AA",
    "Localite": "LONDON",
    "CodeVoie": "19_E28AA",
    "NbNumero": 469,
    "Nbnumero": 469,
    "Complement": "",
    "Voie": "Kingsland Road",
    "Numero": "32",
    "label": "32 Kingsland Road|Hackney|E2 8AA LONDON",
    "ListeNumero": "32",
    "LieuDit": "Hackney",
    "TypeVoie": "",
    "SousLocalite": "",
    "valid_num": 0,
    "IDLocalite": 391,
    "Pays": "GBR",
    "IDVoie": "19_E28AA",
    "Saisie": "32 LONDON BRIDGE",
    "Num": "32",
    "Entreprise": "",
    "NumSeul": "32",
    "Province": "",
    "Region1": ""
  }
}

 

SINGLEV2 response error

Error type Request Response type
Missing “Licence” parameter  https://{SERVER_ADDRESS}/SINGLEV2/?Adresse=se220bf&Taille=38&Pays=GBR Empty response
Empty “Licence” parameter https://{SERVER_ADDRESS}/SINGLEV2/?Adresse=se220bf&Taille=38&Pays=GBR&Licence= Empty response
Incorrect licence number https://{SERVER_ADDRESS}/SINGLEV2/?Adresse=se220bf&Taille=38&Pays=GBR&Licence={INCORRECT_LICENCE_CODE} Empty response
Missing “Adresse” parameter https://{SERVER_ADDRESS}/SINGLEV2/?Taille=38&Pays=GBR&Licence={LICENCE_CODE} 400 Bad Request error
Missing “Pays” parameter https://{SERVER_ADDRESS}/SINGLEV2/?Adresse=se220bf &Taille=38&Licence={LICENCE_CODE} 400 Bad Request error
Empty “Adresse” parameter https://{SERVER_ADDRESS}/SINGLEV2/?Adresse=&Taille=38&Pays=GBR&Licence={LICENCE_CODE} 400 Bad Request error
Empty “Pays” parameter https://{SERVER_ADDRESS}/SINGLEV2/?Adresse=se220bf &Taille=38&Pays=&Licence={LICENCE_CODE} 400 Bad Request error
Error on a parameter https://{SERVER_ADDRESS}/SINGLEV2/?Aresse=se220bf&Taille=38&Pays=GBR&Licence={LICENCE_CODE} 400 Bad Request error

 

 

Related to

Was this article helpful?

0 out of 0 found this helpful