GetCandidateAddressesLoqate

GetCandidateAddressesLoqate renvoie une liste d'adresses considérées comme des correspondances d'une adresse d'entrée donnée. GetCandidateAddressesLoqate renvoie les adresses candidates uniquement si l'adresse d'entrée correspond à plusieurs adresses de la base de données postale. Si l'adresse d'entrée correspond à une seule adresse de la base de données postale, aucune donnée d'adresse n'est renvoyée. Le champ d'entrée Pays est requis ; si ce champ est vide, aucune sortie ne sera renvoyée.

Remarque : Par défaut, l'option GetCandidateAddressesLoqate n'effectue pas de correspondance au niveau des numéros de maison individuelle. Elle utilise plutôt des plages de numéro de maison pour chaque rue. Une fois que l'option GetCandidateAddressesLoqate a déterminé le nom de la rue, le nom de la ville, le nom de l'État/province et le code postal, elle vérifie que le numéro de maison en entrée se situe dans l'une des plages de numéros de maison données pour le nom de rue correspondant. Le même type de logique s'applique aux numéros d'unité.

GetCandidateAddressesLoqate fait partie du module Universal Addressing.

URL de la ressource

Endpoint JSON :

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

Endpoint XML :

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

Exemple avec la réponse JSON

L'exemple suivant demande une réponse JSON :

http://myserver:8080/rest/GetCandidateAddressesLoqate/results.json?Data.AddressLine1=PO+Box+1&Data.City=New+York&Data.StateProvince=NY

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

Remarque : Des éléments de réponse vides ont été enlevés de cet exemple. Seules les deux premières adresses candidates sont affichées.

{"output_port": [
      {
      "ProcessedBy": "LOQATE",
      "AddressLine1": "PO Box 101",
      "City": "New York Mls",
      "StateProvince": "NY",
      "PostalCode": "13417-0101",
      "Country": "USA",
      "PostalCode.AddOn": "0101",
      "user_fields": []
   },
      {
      "ProcessedBy": "LOQATE",
      "AddressLine1": "PO Box 102",
      "City": "New York Mls",
      "StateProvince": "NY",
      "PostalCode": "13417-0102",
      "Country": "USA",
      "PostalCode.AddOn": "0102",
      "user_fields": []
   }
]}

Exemple avec la réponse XML

L'exemple suivant demande une réponse XML :

http://myserver:8080/rest/GetCandidateAddressesLoqate/results.xml?Data.AddressLine1=PO+Box+1&Data.City=New+York&Data.StateProvince=NY

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

Remarque : Des éléments de réponse vides ont été enlevés de cet exemple. Seules les deux premières adresses candidates sont affichées.

<ns2:xml.GetCandidateAddressesLoqateResponse
xmlns:ns2="http://www.pb.com/spectrum/services/GetCandidateAddressesLoqate">
   <ns2:output_port>
      <ns2:Address>
         <ns2:ProcessedBy>LOQATE</ns2:ProcessedBy>
         <ns2:AddressLine1>PO Box 101</ns2:AddressLine1>
         <ns2:City>New York Mls</ns2:City>
         <ns2:StateProvince>NY</ns2:StateProvince>
         <ns2:PostalCode>13417-0101</ns2:PostalCode>
         <ns2:PostalCode.AddOn>0101</ns2:PostalCode.AddOn>
         <ns2:Country>USA</ns2:Country>
      </ns2:Address>
      <ns2:Address>
         <ns2:ProcessedBy>LOQATE</ns2:ProcessedBy>
         <ns2:AddressLine1>PO Box 102</ns2:AddressLine1>
         <ns2:City>New York Mls</ns2:City>
         <ns2:StateProvince>NY</ns2:StateProvince>
         <ns2:PostalCode>13417-0102</ns2:PostalCode>
         <ns2:PostalCode.AddOn>0102</ns2:PostalCode.AddOn>
         <ns2:Country>USA</ns2:Country>
      </ns2:Address>
   </ns2:output_port>
</ns2:xml.GetCandidateAddressesLoqateResponse>