GetCandidateAddressesLoqate

GetCandidateAddressesLoqate gibt eine Liste der Adressen zurück, die bei einer angegebenen Eingabeadresse als Übereinstimmungen gelten. GetCandidateAddressesLoqate gibt nur Kandidatenadressen zurück, wenn die Eingabeadresse mit mehreren Adressen in der Postdatenbank übereinstimmt. Wenn die Eingabeadresse nur mit einer Adresse in der Postdatenbank übereinstimmt, werden keine Adressdaten zurückgegeben. Das Eingabefeld „Land“ ist erforderlich. Wenn dieses Feld leer ist, wird keine Ausgabe zurückgegeben.

Anmerkung: Standardmäßig gleicht GetCandidateAddressesLoqate keine einzelnen Hausnummern ab. Stattdessen werden für jede Straße Hausnummernbereiche verwendet. Nachdem GetCandidateAddressesLoqate den Straßennamen, den Ortsnamen, Bundesland/Kanton und Postleitzahl bestimmt hat, überprüft es, ob die eingegebene Hausnummer in einen der Hausnummernbereiche fällt, die für die übereinstimmende Straße angegeben sind. Dieselbe Logik wird auf Einheitsnummern angewendet.

GetCandidateAddressesLoqate ist Teil des Universal Addressing-Moduls.

Ressourcen-URL

JSON-Endpunkt:

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

XML-Endpunkt:

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

Beispiel mit JSON-Antwort

Im folgenden Beispiel wird eine JSON-Antwort angefordert:

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

Die von dieser Anforderung zurückgegebene JSON-Antwort würde wie folgt lauten:

Anmerkung: Aus diesem Beispiel wurden leere Antwortelemente entfernt. Nur die ersten zwei Kandidatenadressen werden angezeigt.

{"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": []
   }
]}

Beispiel mit XML-Antwort

Im folgenden Beispiel wird eine XML-Antwort angefordert:

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

Die von dieser Anforderung zurückgegebene XML-Antwort würde wie folgt lauten:

Anmerkung: Aus diesem Beispiel wurden leere Antwortelemente entfernt. Nur die ersten zwei Kandidatenadressen werden angezeigt.

<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>