GetCandidateAddresses

GetCandidateAddresses は、与えられた入力住所にマッチするとみなされる住所のリストを返します。GetCandidateAddresses は、入力住所が郵便データベースの複数の住所にマッチする場合のみ、候補の住所を返します。入力住所が、郵便データベースの 1 つの住所のみにマッチする場合は、住所データを返しません。

米国およびカナダ以外の住所については、ValidateAddress が返す複数のマッチ結果と、GetCandidateAddresses が同じ住所に対して返す結果の間に、矛盾が存在する場合があります。矛盾した結果が得られるのはおそらく、ValidateAddress のパフォーマンスチューニング設定で 100 以外の値を設定しているためです。GetCandidateAddresses と ValidateAddress で矛盾のない結果を得るには、パフォーマンスチューニングオプションを 100 に設定します。

注: デフォルトでは、GetCandidateAddresses は個々の家番号との一致は確認しません。各ストリートの家番号の範囲とのマッチングを行います。GetCandidateAddresses はストリート名、都市名、州/省名、および郵便番号を特定した後、入力された家番号が、マッチしたストリート名の家番号の範囲に含まれるかどうかを確認します。ユニット番号についても同様の処理が行われます。個々の家番号が有効であることを確認するには、ValidateAddress Delivery Point Validation (DPV) 処理オプションを使用する必要があります。DPV 処理は、米国住所に対してのみ使用可能です。

カナダのコーダーには、特定の郵便番号を入力として受け取り、その郵便番号のデータベースに格納されたストリート情報を返す逆検索ルーチンが含まれています。この機能を使用するには、PostalCode フィールドにカナダの郵便番号を入力します。カナダの郵便番号を入力した場合の結果については、以下の 2 つめの例を参照してください。

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

リソース URL

JSON エンドポイント:

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

XML エンドポイント:

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

JSON 応答の例

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

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

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

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

XML 応答の例

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

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

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

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