POST api/international/cpville/suggestion

Permet de réaliser la suggestion de Cp / Ville

Request Information

Header Description

Key	Value	Information
Authorization	Bearer access_token	L'access_token se récupére via la métode d'authentification.

Body Parameters

sat.WebServices.Models.Asia.International.InterCpVilleRequest

Name	Description	Type	Additional information
Cnt	Nombre de résultat retourné souhaité	string	Required
Pays	Code pays (ISO2, ISO3, En clair) ("FR", "FRA", "France")	string	Required
Valeur	Ville recherchée	string	None.
Cp	Code postal recherché	string	None.
FiltreId	Identifiant de l'Etat ou de la Province	string	None.

Request Formats

application/json, text/json

Sample:

{
  "Cnt": "sample string 1",
  "Pays": "sample string 2",
  "Valeur": "sample string 3",
  "Cp": "sample string 4",
  "FiltreId": "sample string 5"
}

application/xml, text/xml

Sample:

<InterCpVilleRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Cnt>sample string 1</Cnt>
  <Pays>sample string 2</Pays>
  <Valeur>sample string 3</Valeur>
  <Cp>sample string 4</Cp>
  <FiltreId>sample string 5</FiltreId>
</InterCpVilleRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

sat.WebServices.Models.Asia.International.InterCpVilleResponse

Name	Description	Type	Additional information
message	Message lié au code retour	string	None.
code	Code retour	string	None.
CpVilles	Liste de propositions de Code postal - Ville	Collection of sat.WebServices.Models.Asia.International.CpVille_Result	None.

Response Formats

application/json, text/json

Sample:

{
  "message": "sample string 1",
  "code": "sample string 2",
  "CpVilles": [
    {
      "Id": "sample string 1",
      "Etat": "sample string 2",
      "Region": "sample string 3",
      "Province": "sample string 4",
      "CpVille": "sample string 5",
      "Cp": "sample string 6",
      "Ville": "sample string 7"
    },
    {
      "Id": "sample string 1",
      "Etat": "sample string 2",
      "Region": "sample string 3",
      "Province": "sample string 4",
      "CpVille": "sample string 5",
      "Cp": "sample string 6",
      "Ville": "sample string 7"
    }
  ]
}

application/xml, text/xml

Sample:

<InterCpVilleResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Message>sample string 1</Message>
  <Code>sample string 2</Code>
  <CpVilles>
    <CpVille_Result>
      <Id>sample string 1</Id>
      <Etat>sample string 2</Etat>
      <Region>sample string 3</Region>
      <Province>sample string 4</Province>
      <CpVille>sample string 5</CpVille>
      <Cp>sample string 6</Cp>
      <Ville>sample string 7</Ville>
    </CpVille_Result>
    <CpVille_Result>
      <Id>sample string 1</Id>
      <Etat>sample string 2</Etat>
      <Region>sample string 3</Region>
      <Province>sample string 4</Province>
      <CpVille>sample string 5</CpVille>
      <Cp>sample string 6</Cp>
      <Ville>sample string 7</Ville>
    </CpVille_Result>
  </CpVilles>
</InterCpVilleResponse>