GetCandidateAddressesLoqate

GetCandidateAddressesLoqate は、与えられた入力住所に一致するとみなされる住所のリストを返します。GetCandidateAddressesLoqate は、入力住所が郵便データベースの複数の住所にマッチする場合のみ、候補の住所を返します。入力住所が、郵便データベースの 1 つの住所のみにマッチする場合は、住所データを返しません。[Country] 入力フィールドは必須です。このフィールドが空白の場合、出力は返されません。

注: デフォルトでは、GetCandidateAddressesLoqate は個々の家番号との一致は確認しません。各ストリートの家番号の範囲とのマッチングを行います。GetCandidateAddressesLoqate はストリート名、都市名、州/省名、および郵便番号を特定した後、入力された家番号が、マッチしたストリート名の家番号の範囲に含まれるかどうかを確認します。ユニット番号についても同様の処理が行われます。

GetCandidateAddressesLoqate は、Universal Addressing モジュールに含まれています。

リソース URL

JSON エンドポイント:

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

XML エンドポイント:

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

JSON 応答の例

次の例では、JSON 応答を要求します。

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

この要求から次のような JSON が返されます。

注: この例では、空の応答要素を削除しています。最初の候補住所を 2 つだけ示します。

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

XML 応答の例

次の例では、XML 応答を要求します。

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

この要求から次のような XML が返されます。

注: この例では、空の応答要素を削除しています。最初の候補住所を 2 つだけ示します。

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