POST api/rnvp/cpinverse

Permet de récupérer une liste de Lieu-Dits / Communes correspondant à un CP

Request Information

Header Description

KeyValueInformation
AuthorizationBearer access_tokenL'access_token se récupére via la métode d'authentification.

Body Parameters

sat.WebServices.Models.Cp.CpInverseRequest
NameDescriptionTypeAdditional information
Cp

Code postal

string

Required

Langue

Filtrer par langue (pour l'international). Ex : FR, NL, ect...

string

None.

Pays

Code pays (ISO2, ISO3, En clair) ("FR", "FRA", "France")

string

Required

CodeDossier

Code de paramétrage qui vous a été fourni.

string

Required

Request Formats

application/json, text/json

Sample:
{
  "Cp": "sample string 1",
  "Langue": "sample string 2",
  "Pays": "sample string 3",
  "CodeDossier": "sample string 4"
}

application/xml, text/xml

Sample:
<CpInverseRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Pays>sample string 3</Pays>
  <CodeDossier>sample string 4</CodeDossier>
  <Cp>sample string 1</Cp>
  <Langue>sample string 2</Langue>
</CpInverseRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of sat.WebServices.Models.Cp.CpInverseResponse
NameDescriptionTypeAdditional information
Lieudit

Lieu-Dit

string

None.

Commune

Commune

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Lieudit": "sample string 1",
    "Commune": "sample string 2"
  },
  {
    "Lieudit": "sample string 1",
    "Commune": "sample string 2"
  }
]

application/xml, text/xml

Sample:
<ArrayOfCpInverseResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <CpInverseResponse>
    <Lieudit>sample string 1</Lieudit>
    <Commune>sample string 2</Commune>
  </CpInverseResponse>
  <CpInverseResponse>
    <Lieudit>sample string 1</Lieudit>
    <Commune>sample string 2</Commune>
  </CpInverseResponse>
</ArrayOfCpInverseResponse>