API - Description - Address - COMPL - Response

Support DQE
Support DQE
  • Updated

This page describes the JSON response returned by the /COMPL/ endpoint used in Funnel mode.

Related Address documentation:

COMPL response success

The JSON response is a dictionary whose keys are numbered from 1 to n. Each element is itself a dictionary containing the Batiment key whose value contains additional address information.

Key Value France International
Batiment Additional address information if applicable. STRING(38) STRING(150)
CodePostal Postal code linked to the additional address information if applicable. STRING(10) STRING(10)

Example:

{
  "1": {
    "Batiment": "Town Hall, Tameside Metropolitan Borough Council",
    "CodePostal": "M34 2AP"
  },
  "2": {
    "Batiment": "Victoria Park Community Association",
    "CodePostal": "M34 2AP"
  }
}

COMPL response error

Error type Request Response type
Missing Licence parameter https://{SERVER_ADDRESS}/COMPL/?IDVoie=1751437&IDNum=23&Taille=38&Pays=FRA Empty response
Empty Licence parameter https://{SERVER_ADDRESS}/COMPL/?IDVoie=1751437&IDNum=23&Taille=38&Pays=FRA&Licence= Empty response
Missing IDVoie parameter https://{SERVER_ADDRESS}/COMPL/?IDNum=23&Taille=38&Pays=FRA&Licence={LICENCE_CODE} 400 Bad Request Error
Missing IDNum parameter https://{SERVER_ADDRESS}/COMPL/?IDVoie=1751437&Taille=38&Pays=FRA&Licence={LICENCE_CODE} 400 Bad Request Error
Missing Pays parameter https://{SERVER_ADDRESS}/COMPL/?IDVoie=1751437&IDNum=23&Taille=38&Licence={LICENCE_CODE} 400 Bad Request Error
Error on a parameter https://{SERVER_ADDRESS}/COMPL/?IVoie=1751437&IDNum=23&Pays=FRA&Taille=38&Licence={LICENCE_CODE} 400 Bad Request Error

Related to

Was this article helpful?

0 out of 0 found this helpful