GetPostalCodes

GetPostalCodes vous permet de rechercher les codes postaux pour une ville particulière. Le service sélectionne une ville, un État et un pays en entrée et renvoie les codes postaux pour cette ville. La saisie doit être tout à fait correcte pour renvoyer des codes postaux.

Remarque : GetPostalCodes ne fonctionne qu'avec des adresses américaines.

GetPostalCodes fait partie du module Universal Addressing.

URL de la ressource

Endpoint JSON : 

http://server:port/rest/GetPostalCodes/results.json

Endpoint XML : 

http://server:port/rest/GetPostalCodes/results.xml

Exemple avec la réponse JSON

L'exemple suivant demande une réponse JSON :

http://myserver:8080/rest/GetPostalCodes/results.json?​Data.City=Holland&Data.StateProvince=MI

L'élément JSON renvoyé par cette demande serait :

{"output_port": [
      {
      "ProcessedBy": "USA",
      "PostalCode": "49422",
      "Status": "",
      "City.Type": " ",
      "Status.Code": "",
      "Status.Description": "",
      "user_fields": []
   },
      {
      "ProcessedBy": "USA",
      "PostalCode": "49423",
      "Status": "",
      "City.Type": " ",
      "Status.Code": "",
      "Status.Description": "",
      "user_fields": []
   },
      {
      "ProcessedBy": "USA",
      "PostalCode": "49424",
      "Status": "",
      "City.Type": " ",
      "Status.Code": "",
      "Status.Description": "",
      "user_fields": []
   }
]}

Exemple avec la réponse XML

L'exemple suivant demande une réponse XML :

http://myserver:8080/rest/GetPostalCodes/results.xml?Data.City=Holland&​Data.StateProvince=MI

L'élément XML renvoyé par cette demande serait :

<ns2:xml.GetPostalCodesResponse
xmlns:ns2="http://www.pb.com/spectrum/services/GetPostalCodes">
   <ns2:output_port>
      <ns2:Result>
         <ns2:ProcessedBy>USA</ns2:ProcessedBy>
         <ns2:PostalCode>49422</ns2:PostalCode>
         <ns2:City.Type></ns2:City.Type>
         <ns2:Status/>
         <ns2:Status.Code/>
         <ns2:Status.Description/>
         <ns2:user_fields/>
      </ns2:Result>
      <ns2:Result>
         <ns2:ProcessedBy>USA</ns2:ProcessedBy>
         <ns2:PostalCode>49423</ns2:PostalCode>
         <ns2:City.Type></ns2:City.Type>
         <ns2:Status/>
         <ns2:Status.Code/>
         <ns2:Status.Description/>
         <ns2:user_fields/>
      </ns2:Result>
      <ns2:Result>
         <ns2:ProcessedBy>USA</ns2:ProcessedBy>
         <ns2:PostalCode>49424</ns2:PostalCode>
         <ns2:City.Type></ns2:City.Type>
         <ns2:Status/>
         <ns2:Status.Code/>
         <ns2:Status.Description/>
         <ns2:user_fields/>
      </ns2:Result>
   </ns2:output_port>
</ns2:xml.GetPostalCodesResponse>