„GetCandidateAddresses“
„GetCandidateAddresses“ gibt eine Liste der Adressen zurück, die bei einer angegebenen Eingabeadresse als Übereinstimmungen gelten. „GetCandidateAddresses“ gibt Kandidatenadressen nur dann 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.
Wenn bei Adressen außerhalb der USA und Kanada treten bei den von „ValidateAddress“ zurückgegebenen Mehrfachübereinstimmungen und den für dieselbe Adresse von „GetCandidateAddresses“ zurückgegebenen Ergebnissen möglicherweise inkonsistente Ergebnisse auf. Die Ursache für die inkonsistenten Ergebnisse ist wahrscheinlich, dass Sie die Einstellung für die Leistungsoptimierung in „ValidateAddress“ auf einen anderen Wert als 100 festgelegt haben. Legen Sie die Option für die Leistungsoptimierung auf 100 fest, um konsistente Ergebnisse bei „GetCandidateAddresses“ und „ValidateAddress“ zu erzielen.
Der kanadische Coder umfasst eine „Reverse Lookup“-Routine, die eine bestimmte Postleitzahl als Eingabe verwendet und die für diese Postleitzahl in der Datenbank gespeicherten Straßeninformationen zurückgibt. Geben Sie für die Verwendung dieser Funktion lediglich eine kanadische Postleitzahl in das Feld „PostalCode“ ein. Im zweiten Beispiel wird dargestellt, wie die Rückgabe über eine beispielhafte Postleitzahl erfolgt.
„GetCandidateAddresses“ ist Teil des Universal Addressing-Moduls.
Ressourcen-URL
JSON-Endpunkt:
http://server:port/rest/GetCandidateAddresses/results.json
XML-Endpunkt:
http://server:port/rest/GetCandidateAddresses/results.xml
Beispiel mit JSON-Antwort
Im folgenden Beispiel wird eine JSON-Antwort angefordert:
http://myserver:8080/rest/GetCandidateAddresses/results.json?Data.AddressLine1=P.O.+Box+1&Data.City=New+York&Data.StateProvince=NY
Die von dieser Anforderung zurückgegebene JSON-Antwort würde wie folgt lauten:
{"output_port": [
{
"ProcessedBy": "USA",
"RecordType": "PostOfficeBox",
"MatchLevel": "A",
"AddressLine1": "PO Box 1",
"HouseNumberLow": "1",
"HouseNumberHigh": "60",
"HouseNumberParity": "B",
"UnitNumberLow": "",
"UnitNumberHigh": "",
"UnitNumberParity": " ",
"FirmName": "",
"City": "New York",
"USUrbanName": "",
"StateProvince": "NY",
"PostalCode": "10002",
"Country": "USA",
"PostalCode.AddOn": "0001",
"user_fields": []
},
{
"ProcessedBy": "USA",
"RecordType": "PostOfficeBox",
"MatchLevel": "A",
"AddressLine1": "PO Box 1",
"HouseNumberLow": "1",
"HouseNumberHigh": "9",
"HouseNumberParity": "B",
"UnitNumberLow": "",
"UnitNumberHigh": "",
"UnitNumberParity": " ",
"FirmName": "",
"City": "New York",
"USUrbanName": "",
"StateProvince": "NY",
"PostalCode": "10008",
"Country": "USA",
"PostalCode.AddOn": "0001",
"user_fields": []
},
{
"ProcessedBy": "USA",
"RecordType": "PostOfficeBox",
"MatchLevel": "A",
"AddressLine1": "PO Box 1",
"HouseNumberLow": "1",
"HouseNumberHigh": "60",
"HouseNumberParity": "B",
"UnitNumberLow": "",
"UnitNumberHigh": "",
"UnitNumberParity": " ",
"FirmName": "",
"City": "New York",
"USUrbanName": "",
"StateProvince": "NY",
"PostalCode": "10009",
"Country": "USA",
"PostalCode.AddOn": "0001",
"user_fields": []
}
]}
Beispiel mit XML-Antwort
Im folgenden Beispiel wird eine XML-Antwort angefordert:
http://myserver:8080/rest/GetCandidateAddresses/results.xml?Data.AddressLine1=P.O.+Box+1&Data.City=New+York&Data.StateProvince=NY
Die von dieser Anforderung zurückgegebene XML-Antwort würde wie folgt lauten:
<ns2:xml.GetCandidateAddressesResponse xmlns:ns2="http://www.pb.com/spectrum/services/GetCandidateAddresses">
<ns2:output_port>
<ns2:Address>
<ns2:ProcessedBy>USA</ns2:ProcessedBy>
<ns2:RecordType>PostOfficeBox</ns2:RecordType>
<ns2:MatchLevel>A</ns2:MatchLevel>
<ns2:AddressLine1>PO Box 1</ns2:AddressLine1>
<ns2:HouseNumberLow>1</ns2:HouseNumberLow>
<ns2:HouseNumberHigh>60</ns2:HouseNumberHigh>
<ns2:HouseNumberParity>B</ns2:HouseNumberParity>
<ns2:UnitNumberLow/>
<ns2:UnitNumberHigh/>
<ns2:UnitNumberParity></ns2:UnitNumberParity>
<ns2:FirmName/>
<ns2:City>New York</ns2:City>
<ns2:USUrbanName/>
<ns2:StateProvince>NY</ns2:StateProvince>
<ns2:PostalCode>10002</ns2:PostalCode>
<ns2:PostalCode.AddOn>0001</ns2:PostalCode.AddOn>
<ns2:Country>USA</ns2:Country>
<ns2:user_fields/>
</ns2:Address>
<ns2:Address>
<ns2:ProcessedBy>USA</ns2:ProcessedBy>
<ns2:RecordType>PostOfficeBox</ns2:RecordType>
<ns2:MatchLevel>A</ns2:MatchLevel>
<ns2:AddressLine1>PO Box 1</ns2:AddressLine1>
<ns2:HouseNumberLow>1</ns2:HouseNumberLow>
<ns2:HouseNumberHigh>9</ns2:HouseNumberHigh>
<ns2:HouseNumberParity>B</ns2:HouseNumberParity>
<ns2:UnitNumberLow/>
<ns2:UnitNumberHigh/>
<ns2:UnitNumberParity></ns2:UnitNumberParity>
<ns2:FirmName/>
<ns2:City>New York</ns2:City>
<ns2:USUrbanName/>
<ns2:StateProvince>NY</ns2:StateProvince>
<ns2:PostalCode>10008</ns2:PostalCode>
<ns2:PostalCode.AddOn>0001</ns2:PostalCode.AddOn>
<ns2:Country>USA</ns2:Country>
<ns2:user_fields/>
</ns2:Address>
</ns2:output_port>
</ns2:xml.GetCandidateAddressesResponse>