PDF をダウンロード - Pitney Bowes Support

Spectrum Technology Platform
バージョン 9.0 SP3
REST Web サービスガイド
目次
第 1 章 : はじめに..................................................................................................5
REST インターフェイス.........................................................................................6
JSON POST リクエスト..............................................................................8
Web サービスとしてのサービスのエクスポーズ.................................................11
サンプル Web アプリケーション..........................................................................12
第 2 章 : Web サービス.......................................................................................15
Address Now モジュール....................................................................................16
BuildGlobalAddress....................................................................................16
GetGlobalCandidateAddresses..................................................................28
ValidateGlobalAddress...............................................................................35
Enterprise Routing モジュール...........................................................................56
GetTravelBoundary.....................................................................................56
GetTravelCostMatrix...................................................................................71
GetTravelDirections....................................................................................71
Enterprise Tax モジュール...................................................................................72
AssignGeoTAXInfo.....................................................................................72
CalculateDistance.....................................................................................110
ReverseGeoTAXInfoLookup.....................................................................113
マッチコードとロケーションコード......................................................135
GeoConfidence モジュール...............................................................................145
GeoConfidence Surface...........................................................................145
Global Sentry モジュール..................................................................................146
GlobalSentry.............................................................................................146
Location Intelligence モジュール......................................................................154
ドキュメントの場所.................................................................................154
Universal Addressing モジュール....................................................................154
AutoCompleteLoqate................................................................................154
GetCandidateAddresses..........................................................................161
GetCandidateAddressesLoqate...............................................................170
GetCityStateProvince...............................................................................175
GetCityStateProvinceLoqate....................................................................179
GetPostalCodes.......................................................................................182
ValidateAddress........................................................................................186
ValidateAddressGlobal.............................................................................248
ValidateAddressLoqate.............................................................................267
Universal Name モジュール..............................................................................288
OpenNameParser.....................................................................................288
Appendix..........................................................................................................297
付録 A : The ACR Code.........................................................................299
ACR コード..............................................................................................300
付録 B : Buffering...................................................................................303
バッファリング........................................................................................304
付録 C : Country Codes.........................................................................305
各国の ISO コードとモジュールサポート...............................................306
付録 D : ValidateAddress Confidence アルゴリズム...........................327
Validate Address 確信アルゴリズムの概要..............................................328
米国とカナダの住所に対する確信アルゴリズム住所の検証...................328
国際住所用の確信アルゴリズム...............................................................329
4
Spectrum Technology Platform 9.0 SP3
はじめに
このセクションの構成
• REST インターフェイス . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6
• Web サービスとしてのサービスのエクスポーズ . . . . . . . . .11
• サンプル Web アプリケーション . . . . . . . . . . . . . . . . . . . . .12
1
REST インターフェイス
REST インターフェイス
Spectrum™ Technology Platform は、Web サービスに対する REST インターフェイスを提供します。
Enterprise Designer で作成されたユーザ定義の Web サービスは、GET メソッドと POST メソッドを
サポートします。モジュールの一部としてインストールされているデフォルトのサービスは、GET し
かサポートしません。 POST を使用してこれらのサービスのいずれかにアクセスしたい場合は、
Enterprise Designer でユーザ定義サービスを作成する必要があります。
ご利用の Spectrum™ Technology Platform サーバーで使用できる REST Web サービスを確認するに
は、以下の URL にアクセスします。
http://server:port/rest
REST Web サービスに対する以下の制限に注意してください。
• Web サービスは、GET メソッドと POST メソッドをサポートします。特定の Web サービスで使
用可能なメソッドは、Enterprise Designer において、サービスの Web サービスオプションで設定
します。
• URL の長さの制限により、パラメーターは 2,048 文字以下に制限することをお勧めします。
サービスのエンドポイント
REST サービスのデフォルトのエンドポイントは次のとおりです。
http://server:port/rest/service_name/results.xml
http://server:port/rest/service_name/results.json
ユーザ定義 Web サービスのエンドポイントは、別の URL を使用するように Enterprise Designer で変
更できます。
注 : Spectrum™ Technology Platform では、デフォルトで 8080 番ポートを HTTP 通信に使用します。
管理者が別のポートを設定している場合もあります。
WADL の URL
Spectrum™ Technology Platform Web サービスの WADL は次のとおりです。
http://server:port/rest/service_name?_wadl
例:
http://myserver:8080/rest/ValidateAddress?_wadl
ユーザフィールド
Web サービスでは使用されない余分なフィールドを、サービスを介して渡すことができます。こうし
たフィールドは、変更されずに応答の user_fields セクションで返されます。 GET 要求の場合、
ユーザフィールドは他のフィールドと同じように、URL におけるパラメータとして引き渡されます。
POST 要求の場合、ユーザフィールドは、XML または JSON リクエストにおける user_fields 要
素の一部として引き渡されます。
注 : ユーザフィールド名に、XML や JSON 要素名で無効な文字を含めることはできません。例え
ば、スペースは有効ではありません。
6
Spectrum Technology Platform 9.0 SP3
第 1 章 : はじめに
GET を用いて XML レスポンスを求める、REST リクエストの例
以下に、GET メソッドを使用して XML レスポンスを要求する、ValidateAddress サービスに対する
REST リクエストの記述例を示します。
http://localhost:8080/rest/ValidateAddress/results.xml?Option.OutputCasing=U&
Data.AddressLine1=1825+Kramer+Lane&Data.PostalCode=78759
この要求の例では、XML 応答が要求されたので、以下の応答が返されます。
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<xml.ValidateAddressResponse
xmlns="http://www.pb.com/spectrum/services/ValidateAddress">
<output_port>
<Address>
<Confidence>82</Confidence>
<RecordType>Normal</RecordType>
<CountryLevel>A</CountryLevel>
<ProcessedBy>USA</ProcessedBy>
<MatchScore>0</MatchScore>
<AddressLine1>1825 KRAMER LN</AddressLine1>
<City>AUSTIN</City>
<StateProvince>TX</StateProvince>
<PostalCode>78758-4260</PostalCode>
<PostalCode.Base>78758</PostalCode.Base>
<PostalCode.AddOn>4260</PostalCode.AddOn>
<Country>UNITED STATES OF AMERICA</Country>
<user_fields/>
</Address>
</output_port>
</xml.ValidateAddressResponse>
GET を用いて JSON レスポンスを求める、REST リクエストの例
以下に、GET メソッドを使用して JSON レスポンスを要求する、ValidateAddress サービスに対する
REST リクエストの記述例を示します。
http://localhost:8080/rest/ValidateAddress/results.json?Option.OutputCasing=U&
Data.AddressLine1=1825+Kramer+Lane&Data.PostalCode=78759
この要求の例では、JSON 応答が要求されたので、以下の応答が返されます。
{
"ns1.json.ValidateAddressResponse" :
{
"ns1.output_port" :
{
"ns1.Confidence" : 82,
"ns1.RecordType" : "Normal",
"ns1.CountryLevel" : "A",
"ns1.ProcessedBy" : "USA",
"ns1.MatchScore" : 0,
"ns1.AddressLine1" : "1825 KRAMER LN",
"ns1.City" : "AUSTIN",
"ns1.StateProvince" : "TX",
"ns1.PostalCode" : "78758-4260",
"ns1.PostalCode.Base" : 78758,
"ns1.PostalCode.AddOn" : 4260,
"ns1.Country" : "UNITED STATES OF AMERICA"
}
}
}
関連リンク
Web サービスとしてのサービスのエクスポーズ（11ページ）
REST Web サービスガイド
7
REST インターフェイス
JSON POST リクエスト
ユーザ定義の Web サービスを、REST Web サービスとしてエクスポーズし、JSON 入力を受け取る
POST メソッドを持つように設定できます。 JSON POST リクエストには以下の形式を使用します。
フラットデータ
POST を用いてフラットデータを Web サービスに送信するための形式は次のとおりです。
{
"InputStageName":
{
"InputDataType": [
{
"FieldName1": "FieldValue1",
"FieldName2": "FieldValue2"
}
]
}
}
ここで、
InputStageName
Enterprise Designer のキャンバス上に表示される入力ステージの名前。デフォルト
のステージ名は Inputです。
InputDataType
レコードレベルのエンティティに与えられる名前。この値は、データフローの Input
ステージにおいて、 [入力フィールド] タブの [データタイプ名] フィールドで指定さ
れます。デフォルトのレコードレベルエンティティ名は Rowです。
FieldName1 と FieldName2
サービスの Input ステージで定義されている入力フィールドの名前。
FieldValue1 と FieldValue2
対応するフィールドに入れて Web サービスに送信する入力データ。
リストデータ
リストデータは、親フィールドの下でグループ化されているフィールドの階層グループ構造で構成さ
れます。
注 : リストデータを入力として使用するには、GET リソースを持たない REST Web サービスとして
サービスがエクスポーズされている必要があります。サービスに GET リソースがある場合は、
サービスのエクスポーズ時に Enterprise Designer においてエラーが発生します。GET が階層
フィールドをサポートしないためです。
POST を用いてリストデータを Web サービスに送信するための形式は次のとおりです。
{
"InputStageName":
{
"InputDataType": [
{
"ListField1":[
{"SubfieldName1": "SubfieldValue1"},
{"SubfieldName2": "SubfieldValue2"}
]
}
8
Spectrum Technology Platform 9.0 SP3
第 1 章 : はじめに
]
}
}
ここで、
InputStageName
Enterprise Designer のキャンバス上に表示される入力ステージの名前。デフォルト
のステージ名は Inputです。
InputDataType
レコードレベルのエンティティに与えられる名前。この値は、データフローの Input
ステージにおいて、 [入力フィールド] タブの [データタイプ名] フィールドで指定さ
れます。デフォルトのレコードレベルエンティティ名は Rowです。
ListField1
サービスの Input ステージで定義されている階層フィールドの名前。
SubfieldName1 と SubfieldName2
リストフィールドを構成する子フィールドの名前。
SubfieldValue1 と SubfieldValue2
Web サービスに送信する入力データ。
ユーザフィールド
Web サービスでは使用されない余分なフィールドを、サービスを介して渡すことができます。こうし
たフィールドは、変更されずに応答の user_fields セクションで返されます。リクエストで供給す
るユーザフィールドは、サービスデータフローの Input ステージで定義する必要はありません。
{
"InputStageName":
{
"InputDataType": [
{
"user_fields": [
{
"name": "FieldName1",
"value": "FieldValue1"
},
{
"name": "FieldName2",
"value": "FieldValue2"
}]
}
]
}
}
ここで、
InputStageName
Enterprise Designer のキャンバス上に表示される入力ステージの名前。デフォルト
のステージ名は Inputです。
InputDataType
レコードレベルのエンティティに与えられる名前。この値は、データフローの Input
ステージにおいて、 [入力フィールド] タブの [データタイプ名] フィールドで指定さ
れます。デフォルトのレコードレベルエンティティ名は Rowです。
FieldName1 と FieldName2
パススルーフィールドの名前。
REST Web サービスガイド
9
REST インターフェイス
FieldValue1 と FieldValue2
パススルーフィールドに入れるデータ。
オプション
リクエストでオプションを指定することによって、サービスデータフローで指定されたデフォルトの
オプションをオーバーライドできます。ユーザ定義の Web サービスに対してオプションを指定でき
るのは、データフローがオプションを受け付けるように設定されている場合のみです。リクエストに
おいてオプションを受け付けるようにサービスを設定するには、Enterprise Designer でそのサービス
を開き、 [編集] > [データフローオプション]を選択します。
リクエストで処理オプションを指定するための形式は次のとおりです。
"options" : {
"OptionName1" : "Value1"
},
ここで、
OptionName1
オプション名。サービスに対する有効なオプションの一覧については、そのサービ
スの WADL を参照するか、Enterprise Designer でそのサービスを開いて [編集] >
[データフローオプション]を選択します。
OptionValue1
オプションに対する有効な値。有効値の一覧については、Enterprise Designer でそ
のサービスを開いて [編集] > [データフローオプション]を選択します。
POST を用いた JSON リクエストの例
以下に、Web サービスに対する POST を用いた JSON リクエストにおいて、オプ
ション、フラットフィールド、リストフィールド、ユーザ定義フィールドを使用す
る例を示します。
{
"options" : {
"OutputCasing" : "U"
},
"Input":
{
"Address": [
{
"AddressLine1": "1825 Kramer Ln",
"City": "Austin",
"StateProvince": "TX",
"Accounts": [
{
"AccountNumber": "120993",
"ExpirationDate": "10-3-2017"
},
{
"AccountNumber": "898732",
"ExpirationDate": "8-13-2016"
}
],
"user_fields": [
{
"name": "Note1",
"value": "Prefers decaffeinated coffee"
},
{
10
Spectrum Technology Platform 9.0 SP3
第 1 章 : はじめに
"name": "Note2",
"value": "Requests east facing window"
}]
}
]
}
}
この例の内容は次のとおりです。
• OutputCasing は、Web サービスがエクスポーズするオプションで、出力を大
文字と小文字のどちらで返すかを制御します。この例では、大文字を表す U が設
定されています。
• Input は、データフローの Input ステージのラベルです。Enterprise Designer の
キャンバス上に表示されているものと同じです。
• Address は、レコードレベルエンティティの名前です。データフローの Input ス
テージにおいて、 [入力フィールド] タブの [データタイプ名] フィールドで指定さ
れたものです。
• AddressLine1、 City、およびStateProvince は、フラットフィールドです。
• Accounts は、階層 ("リスト") フィールドです。AccountNumber と
ExpirationDateというサブフィールド名が含まれています。この例では、2 つ
のアカウントが含まれています。
• user_fields は、ユーザ定義フィールドを含みます。これらはパススルーされ、
Web サービスによって変更されることなく出力に返されます。
Web サービスとしてのサービスのエクスポーズ
Spectrum™ Technology Platform サービスは、REST または SOAP Web サービスとして使用できま
す。サービスをサーバー上で Web サービスとして使用できるようにするには
1. Enterprise Designer を開きます。
2. Web サービスとしてエクスポーズするサービスを開きます。
3. [編集] > [Web サービスオプション] の順に選択します。
4. サービスを SOAP Web サービスとして使用できるようにするには、 [SOAP Web サービスとして
公開]チェックボックスをオンにします。
5. サービスを REST Web サービスとして使用できるようにするには、 [REST Web サービスとして
公開] チェックボックスをオンにして、次の手順を実行します。
a) デフォルトのエンドポイントをオーバーライドする場合は、使用するエンドポイントを [パス]
フィールドに指定します。
パスの指定はオプションです。 REST Web サービスのデフォルトのエンドポイントは次のとお
りです。
http://server:port/rest/service_name/results.qualifier
別のエンドポイントを使用する場合は、指定したパスがサービス名の後に追加されます。例え
ば、" Americas/Shipping " と [パス] フィールドに指定すると、JSON エンドポイントは次
のようになります。
http://myserver:8080/rest/MyService/Americas/Shipping/results.json
[変数の挿入] ドロップダウンメニューをクリックして、使用するフィールドまたはオプション
を選択することにより、データフローからのフィールドとオプションをパス内の変数名として
REST Web サービスガイド
11
サンプル Web アプリケーション
使用できます。変数はパス内において、 ${Option.Name} (データフローオプションの場合)、
または ${Data.Name} (データフローフィールドの場合) という表記で記述されます。
b) REST Web サービスはデフォルトで、GET メソッドをサポートし、XML および JSON 形式で
データを返します。 [追加] をクリックしてリソースを Web サービスに追加することによって、
その他の HTTP メソッドや出力形式を定義できます。
リソースを追加する際に、HTTP メソッド (GET または POST) を選択できます。サポートさ
れるデータ形式は以下のとおりです。これらの形式のすべてが使用できるとは限りません。一
部の形式は、お使いの Spectrum™ Technology Platform サーバー上に特定のモジュールがイン
ストールされている場合のみ使用可能であるためです。
XML
デフォルトの XML 形式。 XML をリクエストとレスポンスの形式として使用し、
処理するデータに対する特殊な XML 形式が存在しない場合は、この形式を使用し
ます。
JSON
デフォルトの JSON 形式。 JSON をリクエストとレスポンスの形式として使用
し、処理するデータに対する特殊な JSON 形式が存在しない場合は、この形式を
使用します。
c) [OK] をクリックします。
新しいリソースが Web サービスに追加されます。
6. Web サービスオプションの設定を終えたら、 [OK] をクリックします。
7. ツールバーにあるグレーの電球をクリックして、サービスをエクスポーズします。
データフローがエクスポーズされると、次のように、Enterprise Designer ツールバーの電球ボタ
ンがデータフローのエクスポーズを示します。
サービスが Web サービスとしてエクスポーズされているか確認するには、以下のいずれかの URL に
移動します。
• REST の場合:http://server:port/rest
• SOAP の場合:http://server:port/soap
ここで、server は Spectrum™ Technology Platform サーバーの名前または IP アドレス、port は HTTP
通信に使用するポート番号です。
関連リンク
REST インターフェイス（6ページ）
サンプル Web アプリケーション
以下に示す .NET のサンプルクラスは、Visual Studio 2010 の C# で記述されています。 Web サービ
スデータタイプ ValidateAddressClient、requestRow、context、options、および responseRow の
Proxy クラス実装は、Visual Studio .NET の「サービス参照の追加」コマンドを使用して生成されたも
のです。この例では、ValidateAddress Web サービスを使用しています。注意すべき重要な点は、こ
の例では適切な資格情報の入力が必要であり、そうしないと呼び出しに失敗することです。
using System;
using System.Collections.Generic;
using System.Diagnostics;
12
Spectrum Technology Platform 9.0 SP3
第 1 章 : はじめに
using
using
using
using
System.Linq;
System.Net;
System.Text;
ConsoleApplication1.ValidateAddress_Reference;
namespace Test
{
class Program
{
static void Main(string[] args)
{
var validateClient = new ValidateAddress {Credentials = new
NetworkCredential("admin", "admin")};
var address1 = new input_portAddress
{
AddressLine1 = "1825B Kramer Lane",
AddressLine2 = "Suite 100",
PostalCode = "78758",
City = "Austin",
StateProvince = "Texas"
};
var address2 = new input_portAddress
{
AddressLine1 = "100 Congress",
PostalCode = "78701",
City = "Austin",
StateProvince = "Texas"
};
var addresses = new input_portAddress[2];
addresses[0] = address1;
addresses[1] = address2;
var options = new options {OutputCasing = OutputCasing.M};
output_portAddress[] results =
validateClient.CallValidateAddress(options, addresses);
for (int i = 0; i < results.Length; i++)
{
System.Console.WriteLine("Record " + (i+1) + ":");
System.Console.WriteLine("AddressLine1=" +
results[i].AddressLine1);
System.Console.WriteLine("City=" + results[i].City);
System.Console.WriteLine("StateProvince=" +
results[i].StateProvince);
System.Console.WriteLine("PostalCode=" +
results[i].PostalCode + "\n");
}
System.Console.Write("Press any key to continue...");
System.Console.ReadKey();
}
}
}
REST Web サービスガイド
13
Web サービス
このセクションの構成
• Address Now モジュール . . . . . . . . . . . . . . . . . . . . . . . . . .16
• Enterprise Routing モジュール . . . . . . . . . . . . . . . . . . . . . .56
• Enterprise Tax モジュール . . . . . . . . . . . . . . . . . . . . . . . . .72
• GeoConfidence モジュール . . . . . . . . . . . . . . . . . . . . . . .145
• Global Sentry モジュール . . . . . . . . . . . . . . . . . . . . . . . . .146
• Location Intelligence モジュール . . . . . . . . . . . . . . . . . . .154
• Universal Addressing モジュール . . . . . . . . . . . . . . . . . .154
• Universal Name モジュール . . . . . . . . . . . . . . . . . . . . . . .288
2
Address Now モジュール
Address Now モジュール
BuildGlobalAddress
BuildGlobalAddress では、単一または数個の住所要素のみから有効な住所を作成することができます。
BuildGlobalAddress は、Address Now モジュールに含まれています。
リソース URL
JSON エンドポイント:
http://server:port/rest/BuildGlobalAddress/results.json
XML エンドポイント:
http://server:port/rest/BuildGlobalAddress/results.xml
JSON 応答の例
次の例では、JSON 応答を要求します。
http://myserver:8080/rest/BuildGlobalAddress/results.json?
Data.Action=init&Data.Country=USA
この要求から次のような JSON が返されます。
{"output_port": [{
"Action": "init",
"Country": "USA",
"SessionId": "n5hiliawx0",
"SearchFieldIndex": "-1",
"Field.0.Name": "Zip",
"Field.0.Index": "0",
"Field.0.Value": "",
"Field.0.CommitFlag": "N",
"Field.1.Name": "City",
"Field.1.Index": "1",
"Field.1.Value": "",
"Field.1.CommitFlag": "N",
"Field.2.Name": "State",
"Field.2.Index": "2",
"Field.2.Value": "",
"Field.2.CommitFlag": "N",
"Field.3.Name": "County",
"Field.3.Index": "3",
"Field.3.Value": "",
"Field.3.CommitFlag": "N",
"Field.4.Name": "Street",
"Field.4.Index": "4",
"Field.4.Value": "",
"Field.4.CommitFlag": "N",
"Field.5.Name": "Company",
"Field.5.Index": "5",
"Field.5.Value": "",
"Field.5.CommitFlag": "N",
"Field.6.Name": "Building",
"Field.6.Index": "6",
"Field.6.Value": "",
"Field.6.CommitFlag": "N",
"Field.7.Name": "Premise-No",
16
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
"Field.7.Index": "7",
"Field.7.Value": "",
"Field.7.CommitFlag": "N",
"Field.8.Name": "Sub-Building",
"Field.8.Index": "8",
"Field.8.Value": "",
"Field.8.CommitFlag": "N",
"Field.9.Name": "PO-Box",
"Field.9.Index": "9",
"Field.9.Value": "",
"Field.9.CommitFlag": "N",
"Field.10.Name": "+4",
"Field.10.Index": "10",
"Field.10.Value": "",
"Field.10.CommitFlag": "N",
"Alternatives.InContext": "",
"Alternatives.InContext.Count": "0",
"Alternatives.OutContext": "",
"Alternatives.OutContext.Count": "0",
"user_fields": []
}]}
XML 応答の例
次の例では、XML 応答を要求します。この要求では、初期化 (init) アクションを実行して、
BuildGlobalAddress からセッション ID を取得します。
http://myserver:8080/rest/BuildGlobalAddress/results.xml?
Data.Action=init&Data.Country=USA
この要求から次のような XML が返されます。
<ns2:xml.BuildGlobalAddressResponse
xmlns:ns2="http://www.pb.com/spectrum/services/BuildGlobalAddress">
<ns2:output_port>
<ns2:Result>
<ns2:Action>init</ns2:Action>
<ns2:Country>USA</ns2:Country>
<ns2:SessionId>qbximydxf0</ns2:SessionId>
<ns2:Field.0.Name>Zip</ns2:Field.0.Name>
<ns2:Field.0.Index>0</ns2:Field.0.Index>
<ns2:Field.0.Value/>
<ns2:Field.0.CommitFlag>N</ns2:Field.0.CommitFlag>
<ns2:Field.1.Name>City</ns2:Field.1.Name>
<ns2:Field.1.Index>1</ns2:Field.1.Index>
<ns2:Field.1.Value/>
<ns2:Field.1.CommitFlag>N</ns2:Field.1.CommitFlag>
<ns2:Field.2.Name>State</ns2:Field.2.Name>
<ns2:Field.2.Index>2</ns2:Field.2.Index>
<ns2:Field.2.Value/>
<ns2:Field.2.CommitFlag>N</ns2:Field.2.CommitFlag>
<ns2:Field.3.Name>County</ns2:Field.3.Name>
<ns2:Field.3.Index>3</ns2:Field.3.Index>
<ns2:Field.3.Value/>
<ns2:Field.3.CommitFlag>N</ns2:Field.3.CommitFlag>
<ns2:Field.4.Name>Street</ns2:Field.4.Name>
<ns2:Field.4.Index>4</ns2:Field.4.Index>
<ns2:Field.4.Value/>
<ns2:Field.4.CommitFlag>N</ns2:Field.4.CommitFlag>
<ns2:Field.5.Name>Company</ns2:Field.5.Name>
<ns2:Field.5.Index>5</ns2:Field.5.Index>
<ns2:Field.5.Value/>
<ns2:Field.5.CommitFlag>N</ns2:Field.5.CommitFlag>
<ns2:Field.6.Name>Building</ns2:Field.6.Name>
<ns2:Field.6.Index>6</ns2:Field.6.Index>
<ns2:Field.6.Value/>
<ns2:Field.6.CommitFlag>N</ns2:Field.6.CommitFlag>
<ns2:Field.7.Name>Premise-No</ns2:Field.7.Name>
REST Web サービスガイド
17
Address Now モジュール
<ns2:Field.7.Index>7</ns2:Field.7.Index>
<ns2:Field.7.Value/>
<ns2:Field.7.CommitFlag>N</ns2:Field.7.CommitFlag>
<ns2:Field.8.Name>Sub-Building</ns2:Field.8.Name>
<ns2:Field.8.Index>8</ns2:Field.8.Index>
<ns2:Field.8.Value/>
<ns2:Field.8.CommitFlag>N</ns2:Field.8.CommitFlag>
<ns2:Field.9.Name>PO-Box</ns2:Field.9.Name>
<ns2:Field.9.Index>9</ns2:Field.9.Index>
<ns2:Field.9.Value/>
<ns2:Field.9.CommitFlag>N</ns2:Field.9.CommitFlag>
<ns2:Field.10.Name>+4</ns2:Field.10.Name>
<ns2:Field.10.Index>10</ns2:Field.10.Index>
<ns2:Field.10.Value/>
<ns2:Field.10.CommitFlag>N</ns2:Field.10.CommitFlag>
<ns2:SearchFieldIndex>-1</ns2:SearchFieldIndex>
<ns2:Alternatives.InContext/>
<ns2:Alternatives.InContext.Count>
0
</ns2:Alternatives.InContext.Count>
<ns2:Alternatives.OutContext/>
<ns2:Alternatives.OutContext.Count>
0
</ns2:Alternatives.OutContext.Count>
<ns2:user_fields/>
</ns2:Result>
</ns2:output_port>
</ns2:xml.BuildGlobalAddressResponse>
BuildGlobalAddress の使用
住所の作成は対話的なプロセスであり、住所作成プロセスの各ステップで住所要素を選択することが
必要になります。つまり、住所を作成するために、BuildGlobalAddress を 1 度ではなく複数回呼び出
す必要があります。まず最初に、BuildGlobalAddress に対する初期化呼び出しを実行します。この呼
び出しにより、セッション ID が返されます。以降の呼び出しでは、このセッション ID を使用しま
す。各呼び出しにおいて、BuildGlobalAddress は、住所要素に対する選択肢となる値のリストを提示
します。値を選択して、次の住所要素への処理を進めます。この処理を住所全体が作成されるまで続
けます。一部の例外を除き、各住所要素に対して個別に呼び出しを行う必要があります。
全体的なプロセスは、次のようになります。
• まず、初期化呼び出しによって、セッションを開始し、システムによって割り当てられたセッショ
ン ID を取得します。
• 与えられた住所要素に対する、候補となる値を見つけるための検索呼び出しを行います。
• 必要な値を選択したら、与えられた住所要素に対して確定した値を通知するための確定呼び出しを
行います。
• すべての住所要素が確定するまで、検索/確定呼び出しを続行します。
• 最後に、セッションを終了するための終了呼び出しを行います。
プロセスの動作方法を理解するには、Management Console の [プレビュー] タブを使用して、以下の
処理を順に実行します。
1. Management Console を開きます。
2. [サービス] ノードの下で、[Build Global Address] を選択します。
3. [オプション] タブで、必要なオプションを指定します。オプションの詳細については、オプショ
ンのパラメータ（23ページ）を参照してください。
4. [プレビュー] タブをクリックします。
5. [Action] フィールドに、"init" と入力します。
6. [Country] フィールドに、作成する住所の国を入力します。
18
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
7. [プレビューを実行] をクリックします。
8. [プレビュー出力] の下で [SessionId] フィールドを探し、値を右クリックして、ポップアップメ
ニューから [コピー] を選択します。
9. [プレビュー入力] の下で [SessionId] フィールドを右クリックして、[貼り付け] を選択します。
10. 入力フィールドに以下の値を入力します。
• Action — "search" と入力します。
• Country — このフィールドはそのままにします。
REST Web サービスガイド
19
Address Now モジュール
• FieldIndex — 検索する最初のフィールドのインデックス値を入力します。例えば、シカゴの住
所を検索する場合は "1" と入力します。米国住所では、フィールドインデックス 1 が、都市
フィールドに対応するためです。
• SearchValue — 検索する値を入力します。例えば、シカゴの住所を作成する場合は、"chicago"
と入力します。
• SessionId — 同じ値のままとします。
注 : 他の入力フィールドの値は無視されます。
11. [プレビューを実行] を再度クリックします。
12. 検索結果は、[Alternatives.InContext] と [AlternativesOutContext] の最大 2 つの出力フィールド
に表示されます。インコンテキスト結果とアウトオブコンテキスト結果の違いについては、コン
テキストとは（28ページ）を参照してください。
13. 必要な値が見つかった場合は、以下の値を入力フィールドに入力します。
• Action — "commit" と入力します。
• AlternativeIndex — 選択する選択肢のインデックス番号を入力します。インデックス値の最小
値は 1 ではなく、0 です。例えば、シカゴを検索する場合、BuildGlobalAddress によって返さ
れる選択肢には、以下のようにインデックスが付与されます。 "CHICAGO" という値を確定する
場合は、[AlternativeIndex] フィールドに "0" と入力します。
•
•
•
•
•
•
•
0—CHICAGO
1—CHICAGO HTS
2—CHICAGO PARK
3—CHICAGO RIDGE
4—EAST CHICAGO
5—NORTH CHICAGO
6—WEST CHICAGO
• AlternativeContext — "in" または "out" と入力し、[AlternativeIndex] で指定したインデッ
クス値が [Alternatives.InContext] フィールドと [Alternatives.OutContext] フィールドのどち
らの選択肢リストのものであるかを示します。
• SessionId — この値は同じままにします。
注 : 他の入力フィールドの値は無視されます。
14. [プレビューを実行] を再度クリックします。指定した値が、適切な住所要素の [Field.n.Value]
フィールドに表示されます。
15. 住所が作成されるまで、検索と確定のステップを必要な時だけ繰り返します。
16. 入力フィールドに以下の値を入力することにより、セッションを終了します。
• Action — "close" と入力します。
• SessionId — この値は同じままにします。
注 : 他の入力フィールドの値は無視されます。
20
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
要求
入力データのパラメータ
表 1 : BuildGlobalAddress の入力
パラメータ
書式
説明
Data.Action
文字列
実行するアクションを指定します。次のいずれかです。
init
初期化。このアクションは、セッションを開始
し、他のすべてのアクションで必要となるセッショ
ン ID を返します。 init アクションでは、[Country]
入力フィールドが必須です。
search 特定の住所要素に対する値を検索し、選択肢とな
る値のリストを返します。 search アクションで
は、次の入力フィールドが必須です。
• FieldIndex
• SearchValue
• SessionId
commit search アクションで返された値のうちの 1 つを
フィールドに代入します。 commit アクションで
は、次の入力フィールドが必須です。
• AlternativeIndex
• AlternativeContext
• SessionId
clear
[FieldIndex] フィールドに指定されたフィールドの
確定を取り消します。 clear アクションでは、次の
入力フィールドが必須です。
• FieldIndex
• SessionID
close セッションを終了します。 close アクションでは、
[SessionId] 入力フィールドが必須です。
Data.AlternativeContext
文字列
commit アクションにおいて、[Alternatives.InContext]
フィールドと [Alternatives.OutContext] フィールドのどち
らからの値を選択したかを表します。このフィールドは、
他のアクションでは無視されます。次のいずれかです。
in
[Alternatives.InContext] フィールドからの値を確定
しています。つまり、[AlternativeIndex] 入力フィー
ルドで指定した値は、[Alternatives.InContext] 出力
フィールドの値に対応します。
out [Alternatives.OutContext] フィールドからの値を確
定しています。つまり、[AlternativeIndex] 入力
フィールドで指定した値は、
REST Web サービスガイド
21
Address Now モジュール
パラメータ
書式
説明
[Alternatives.OutContext] 出力フィールドの値に対
応します。
Data.AlternativeIndex
文字列
[79]
commit アクションにおいて、作成中の住所で使用する値を
指定します。例えば、都市を検索し、BuildGlobalAddress
が 3 つの都市を返した場合に、インデックス値を指定する
ことによって、どの都市を選択したかを表します。
BuildGlobalAddress が提示する選択肢のインデックス値は
0 から開始します。つまり、最初の選択肢のインデックス値
は 0、2 つめの選択肢のインデックス値は 1 で、以後同様に
続きます。
この入力フィールドは、commit 以外のアクションでは無視
されます。
Data.Country
文字列
[79]
init アクションにおいて、作成する住所が所在する国を指定
します。入力した国フォーマット (英語名、2 文字の ISO
3116-1 Alpha-2 コード、または 3 文字の ISO 3116-1 Alpha-3
コード) を使用して、国を指定します。 ISO コードの一覧
は、各国の ISO コードとモジュールサポート（306ページ）
を参照してください。
この入力フィールドは、init 以外のアクションでは無視され
ます。
Data.FieldIndex
文字列
[79]
search アクションに対しては、検索する住所要素を指定し
ます。 clear アクションに対しては、確定を取り消す住所要
素を指定します。次のいずれかです。
all
すべての住所要素に対して、"clear" アクション
を実行します。このオプションは、"clear" アク
ションのみに適用されます。
<イン
特定の住所要素に対して、アクションを実行しま
デックす。住所要素のインデックスを調べるには、
ス番号> [Field.n.Name] フィールドを参照して、必要な
フィールドを探します。値 n は、フィールドの
インデックスを表します。例えば、米国住所の
ZIP Code のインデックスを調べる場合を考えま
す。 init 呼び出しの後、[Field.0.Name] が "Zip"
となるため、ZIP Code のフィールドインデック
スが "0" であることがわかります。
この入力フィールドは、search と clear 以外のアクション
では無視されます。
Data.SearchValue
22
文字列
[79]
search アクションにおいて、検索する値を指定します。こ
の値は、[FieldIndex] で指定したフィールドに対して適切な
値である必要があります。例えば、[FieldIndex] で ZIP Code
フィールドを指定した場合は、このフィールドに ZIP Code
または ZIP Code の一部を入力します。同様に、[FieldIndex]
で City フィールドを選択した場合は、このフィールドに都
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
パラメータ
書式
説明
市名または都市名の一部を指定します。このフィールドを
空白のままにすると、search はインコンテキストのすべて
の値を返します。インコンテキストおよびアウトオブコン
テキストの値については、コンテキストとは（28ページ）
を参照してください。
この入力フィールドは、search 以外のアクションでは無視
されます。
Data.SessionId
文字列
[79]
この呼び出しで使用するセッション ID を指定します。セッ
ション ID を取得するには、init アクションを使用します。
動作のない状態が 5 分間続くと、セッションの有効期限が
切れ、新しい init 呼び出しを実行して、新しいセッションを
開始する必要が生じます。
このフィールドは、init 以外のすべてのアクションで必須で
す。
オプションのパラメータ
表 2 : BuildGlobalAddress のオプション
パラメータ
説明
Option.HomeCountry
デフォルト国を指定します。データ内の住所の多くが所在する国を指
定する必要があります。例えば、住所の多くがカナダに所在する場合
は、カナダを指定します。 BuildGlobalAddress は、[StateProvince]、
[PostalCode]、および [Country] の各住所フィールドから国を特定でき
なかった場合、指定された国を使用して、住所の検証を試みます。
Option.OutputCountryFormat 出力で国の名前として使うフォーマットを指定します。次のいずれか
です。
E
出力の国名には英語表記を使います (デフォルト)。
I
国を 2 文字の ISO コードで出力します。
U
国を 3 文字の UPU コードで出力します。
Option.OutputPostalCodeSeparator ZIP Code またはカナダの郵便番号において、区切り文字 (スペースま
たはハイフン) を使用するかどうかを指定します。
例えば、区切り文字ありの ZIP + 4® Code は 20706-1844、区切り文
字なしは 207061844 になります。区切り文字ありのカナダの郵便番
号は P5E"1S7、区切り文字なしは P5E1S7 になります。
Y
区切り文字を使用します (デフォルト)。
N
区切り文字を使用しません。
注 : カナダの郵便番号ではスペースが、米国の ZIP + 4® コードでは
ハイフンが使用されます。
Option.ShowExtraAddressLine 都市、州/省、および郵便番号を [AddressLine] 出力フィールドのいず
れかに格納するかどうかを指定します。このオプションの設定とは関
REST Web サービスガイド
23
Address Now モジュール
パラメータ
説明
係なく、出力フィールド [都市]、[州/省]、および [郵便番号] には常に
都市、州/省、および郵便番号が格納されます。
Option.MaximumResults
Y
Y — 都市、州/省、および郵便番号を [AddressLine] 出力フィー
ルドに格納します (デフォルト)。
N
N — 都市、州/省、および郵便番号を [AddressLine] 出力フィー
ルドに格納しません。
このオプションのデフォルト値として、1 ～ 10000 の間の任意の値が
設定できます。デフォルト値は、50 レコードです。 Enterprise Designer
で設定された値が、Management Console における設定値よりも優先
されることに注意してください。
応答
住所データ
表 3 : BuildGlobalAddress の出力
24
応答要素
書式
説明
Action
文字列
この呼び出しで Action 入力フィールドに指定され
た値を表示します。この入力フィールドの詳細に
ついては、入力データのパラメータ（21ページ）
を参照してください。
AddressLine1
文字列
フォーマット済みの最初の住所行。
AddressLine2
文字列
フォーマット済みの 2 行目の住所行。
AddressLine3
文字列
フォーマット済みの 3 行目の住所行。
AddressLine4
文字列
フォーマット済みの 4 行目の住所行。
AddressLine5
文字列
フォーマット済みの 5 行目の住所行。
AddressLine6
文字列
フォーマット済みの 6 行目の住所行。
AddressLine7
文字列
フォーマット済みの 7 行目の住所行。
AddressLine8
文字列
フォーマット済みの 8 行目の住所行。
AlternativeContext
文字列
この呼び出しで AlternativeContext 入力フィール
ドに指定された値を表示します。詳細について
は、入力データのパラメータ（21ページ）を参照
してください。
AlternativeIndex
文字列
この呼び出しで AlternativeIndex 入力フィールド
に指定された値を表示します。この入力フィール
ドの詳細については、入力データのパラメータ
（21ページ）を参照してください。
Alternatives.InContext
文字列
検索したフィールドの候補値のうち、確定済みの
フィールドのコンテキストに合致するものが、カ
ンマで区切られたリスト。コンテキストの詳細に
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
応答要素
書式
説明
ついては、コンテキストとは（28ページ）を参照
してください。
Alternatives.InContext.Count
文字列
検索によって返された「インコンテキスト」結果
の数。コンテキストの詳細については、コンテキ
ストとは（28ページ）を参照してください。
Alternatives.OutContext
文字列
検索したフィールドの候補値のうち、確定済みの
フィールドのコンテキストに合致しないものが、
カンマで区切られたリスト。コンテキストの詳細
については、コンテキストとは（28ページ）を参
照してください。
Alternatives.OutContext.Count
文字列
検索によって返された「アウトオブコンテキス
ト」結果の数。コンテキストの詳細については、
コンテキストとは（28ページ）を参照してくださ
い。
ApartmentLabel
文字列
アパート指定子 (STE や APT など)。例:
123 E Main St. APT 3
ApartmentNumber
文字列
アパート番号。例:
123 E Main St. APT 3
Building
文字列
建物の名前。
City
文字列
都市名。
Country
文字列
この呼び出しの、[Country] 入力フィールドで指定
された値。この入力フィールドの詳細について
は、入力データのパラメータ（21ページ）を参照
してください。
Country
文字列
2 文字または 3 文字の ISO コード、または、国の
英語名。 ISO コードの一覧は、各国の ISO コー
ドとモジュールサポート（306ページ）を参照し
てください。
Department
文字列
複数の部門に整理された任意のものの個々の部分
の名前。例えば、企業の中の財務部門など。
Field.n.CommitFlag
文字列
フィールド n の値を選択済みかどうか (つまり、
値を "確定" したかどうか) を表します。次のいず
れかです。
Y
このフィールドの値は確定済みです。
N
このフィールドの値は確定していません。
Field.n.Index
文字列
フィールド n (n は 0 ～ 10) を指すために使用する
インデックス値。例えば、米国住所における ZIP
フィールドのインデックス値は "0" です。
Field.n.Name
文字列 [79]
フィールド n (n は 0 ～ 10) に含まれる住所要素の
名前。例えば、米国住所では、Field.0.Name は
ZIP です。
REST Web サービスガイド
25
Address Now モジュール
応答要素
書式
説明
Field.n.Value
文字列 [79]
フィールド n (n は 0 ～ 10) に対して確定済みの
値。
init 呼び出しでは、このフィールドは空白です。
FieldIndex
文字列
この呼び出しの、[FieldIndex] 入力フィールドで指
定された値。この入力フィールドの詳細について
は、入力データのパラメータ（21ページ）を参照
してください。
FirmName
文字列
会社名。例:
Pitney Bowes Software
4200 PARLIAMENT PL STE 600
LANHAM MD 20706-1844
USA
HouseNumber
文字列
家番号。例:
123 E Main St. Apt 3
POBox
文字列
郵便局の私書箱番号。住所が地方配送路住所であ
る場合は、地方配送路の私書箱番号がここに表示
されます。
PostalCode
文字列
郵便番号。米国では、 ZIP Code™ になります。
PostalCode.AddOn
文字列
ZIP + 4® コードの 4 桁アドオン部分。例えば、
60655-1844 という ZIP Code™ において、4 桁の
アドオン部分は 1844 になります (米国住所のみ)。
PostalCode.Base
文字列 [79]
5 桁の ZIP Code™。例えば、20706 (米国の住所
のみ)。
Principality
文字列 [79]
国内の地域。例えば、イングランド、スコットラ
ンド、ウェールズは公国です。このフィールド
は、通常は空白です。
SearchFieldIndex
文字列
前回の検索操作で検索されたフィールドのイン
デックス値。
SearchValue
文字列
この呼び出しで SearchValue 入力フィールドに指
定された値を表示します。この入力フィールドの
詳細については、入力データのパラメータ
（21ページ）を参照してください。
SessionId
文字列
この呼び出しで SessionId 入力フィールドに指定
された値を表示します。この入力フィールドの詳
細については、入力データのパラメータ（21ペー
ジ）を参照してください。
StateProvince
文字列
州または省の省略形。
StreetName
文字列
ストリート名。例:
123 E Main St. Apt 3
StreetSuffix
文字列
ストリート接尾語。例:
123 E Main St. Apt 3
26
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
応答要素
書式
説明
SubCity
文字列
地区または郊外。地区または郊外を住所に含める
のが一般的な国で使用します。例を次に示しま
す。
27 Crystal Way
Bradley Stoke
Bristol BS32 8GA
この住所では "Bradley Stoke" が該当します。
SubStreet
文字列
住所の識別に使われる 2 番目のストリート名。 2
つのストリート名を住所に含めるのが一般的な国
で使用します。例を次に示します。
12 The Mews
High Street
この例では、"High Street" が 2 番目のストリート
名です。このストリート名は、配達先を正確に特
定するために使用できます。前の例の "The Mews"
は短いストリートなので、住所を正確に示すため
に別のストリート名が必要とされることか
ら、"High Street" が追記されています。このよう
な場合、"High Street" がメインまたは既知のスト
リート名です。
USCountyName
文字列
米国の住所では、住所がある郡の名前です。
リターンコード
表 4 : BuildGlobalAddress のリターンコード
応答要素
書式
説明
Status
文字列
マッチの成功または失敗を報告します。
Status.Code
文字列
null
成功
F
失敗
失敗の原因 (ある場合)。
• SessionError
• SeverError
• CountryNotFound
Status.Description
REST Web サービスガイド
文字列
問題の説明 (ある場合)。
Please
initialize new
session
Status.Code=SessionError の場
合にこの値が表示されます。
Null or empty
action
Status.Code=SessionError の場
合にこの値が表示されます。
Unknown
action
Status.Code=SessionError の場
合にこの値が表示されます。
27
Address Now モジュール
応答要素
書式
説明
Invalid
session
Status.Code=SessionError の場
合にこの値が表示されます。
Invalid value
for
Status.Code=SessionError の場
合にこの値が表示されます。
Cannot Search Status.Code=SessionError の場
Committed
合にこの値が表示されます。
Field
Module not
licensed
Status.Code=ServerError の場
合にこの値が表示されます。
Could Not
Identify
Country
Status.Code=CountryNotFound
の場合にこの値が表示されま
す。
コンテキストとは
住所要素の検索を実行する際、BuildGlobalAddress は、確定済みの住所要素を参照し、返す値を、確
定済みの住所要素のコンテキスト内にあるかどうかによって分割します。例えば、米国には次の都市
が存在します。
イリノイ州の都市
•
•
•
•
•
CHICAGO
CHICAGO HTS
CHICAGO RIDGE
NORTH CHICAGO
WEST CHICAGO
インディアナ州の都市
• EAST CHICAGO
ネバダ州の都市
• CHICAGO PARK
州として "IN" (インディアナ州) の値が確定済みの状態で、都市 "chicago" を検索した場合、
BuildGlobalAddress は「インコンテキスト」結果として EAST CHICAGO を返します。それがインディ
アナ州に存在するためです。"chicago" に対するその他のマッチ結果はすべて、アウトオブコンテキス
ト結果として返されます。同様に、州として "IL" (イリノイ州) の値が確定済みである場合は、
BuildGlobalAddress は、アウトオブコンテキスト結果として EAST CHICAGO と CHICAGO PARK を
返し、「インコンテキスト」結果として CHICAGO、CHICAGO HTS、CHICAGO RIDGE、NORTH
CHICAGO、および WEST CHICAGO を返します。
GetGlobalCandidateAddresses
GetGlobalCandidateAddresses は、与えられた入力住所にマッチすると思われる住所のリストを返し
ます。入力住所が、Address Now データベースの複数の住所にマッチする場合は、可能性のある複数
のマッチ結果が返されます。入力住所が、Address Now データベースの 1 つの住所のみにマッチする
場合は、住所データは返されません。
GetGlobalCandidateAddresses は、Address Now モジュールに含まれています。
28
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
リソース URL
JSON エンドポイント:
http://サーバー:ポート/rest/GetGlobalCandidateAddresses/results.json
XML エンドポイント:
http://サーバー:ポート/rest/GetGlobalCandidateAddresses/results.xml
JSON 応答の例
次の例では、JSON 応答を要求します。
http://myserver:8080/rest/GetGlobalCandidateAddresses/results.json?
Data.AddressLine1=1070+Maple&Data.City=Batavia&Data.StateProvince=NY
この要求から次のような JSON が返されます。
注 : この例では、空の応答要素を削除しています。最初の候補住所を 2 つだけ示します。
{"output_port": [
{
"Confidence": "80",
"AddressLine1": "1 Maple St",
"AddressLine2": "Batavia NY 14020-3116",
"HouseNumber": "1",
"StreetName": "Maple",
"StreetSuffix": "St",
"City": "Batavia",
"USCountyName": "Genesee",
"StateProvince": "NY",
"PostalCode": "14020-3116",
"Country": "United States",
"ACRCode": "L5-P5S5A0T4R4Z6C4-080",
"PostalCode.Base": "14020",
"PostalCode.AddOn": "3116",
"user_fields": []
},
{
"Confidence": "80",
"AddressLine1": "3 Maple St",
"AddressLine2": "Batavia NY 14020-3116",
"HouseNumber": "3",
"StreetName": "Maple",
"StreetSuffix": "St",
"City": "Batavia",
"USCountyName": "Genesee",
"StateProvince": "NY",
"PostalCode": "14020-3116",
"Country": "United States",
"ACRCode": "L5-P5S5A0T4R4Z6C4-080",
"PostalCode.Base": "14020",
"PostalCode.AddOn": "3116",
"user_fields": []
}
]}
XML 応答の例
次の例では、XML 応答を要求します。
http://myserver:8080/rest/GetGlobalCandidateAddresses/results.xml?
Data.AddressLine1=1070+Maple&Data.City=Batavia&Data.StateProvince=NY
REST Web サービスガイド
29
Address Now モジュール
この要求から次のような XML が返されます。
注 : この例では、空の応答要素を削除しています。最初の候補住所を 2 つだけ示します。
<ns2:xml.GetGlobalCandidateAddressesResponse
xmlns:ns2="http://www.pb.com/spectrum/services/GetGlobalCandidateAddresses">
<ns2:output_port>
<ns2:Address>
<ns2:Confidence>80</ns2:Confidence>
<ns2:AddressLine1>1 Maple St</ns2:AddressLine1>
<ns2:AddressLine2>Batavia NY 14020-3116</ns2:AddressLine2>
<ns2:HouseNumber>1</ns2:HouseNumber>
<ns2:StreetName>Maple</ns2:StreetName>
<ns2:StreetSuffix>St</ns2:StreetSuffix>
<ns2:City>Batavia</ns2:City>
<ns2:USCountyName>Genesee</ns2:USCountyName>
<ns2:StateProvince>NY</ns2:StateProvince>
<ns2:PostalCode>14020-3116</ns2:PostalCode>
<ns2:PostalCode.Base>14020</ns2:PostalCode.Base>
<ns2:PostalCode.AddOn>3116</ns2:PostalCode.AddOn>
<ns2:Country>United States</ns2:Country>
<ns2:ACRCode>L5-P5S5A0T4R4Z6C4-080</ns2:ACRCode>
</ns2:Address>
<ns2:Address>
<ns2:Confidence>80</ns2:Confidence>
<ns2:AddressLine1>3 Maple St</ns2:AddressLine1>
<ns2:AddressLine2>Batavia NY 14020-3116</ns2:AddressLine2>
<ns2:HouseNumber>3</ns2:HouseNumber>
<ns2:StreetName>Maple</ns2:StreetName>
<ns2:StreetSuffix>St</ns2:StreetSuffix>
<ns2:City>Batavia</ns2:City>
<ns2:USCountyName>Genesee</ns2:USCountyName>
<ns2:StateProvince>NY</ns2:StateProvince>
<ns2:PostalCode>14020-3116</ns2:PostalCode>
<ns2:PostalCode.Base>14020</ns2:PostalCode.Base>
<ns2:PostalCode.AddOn>3116</ns2:PostalCode.AddOn>
<ns2:Country>United States</ns2:Country>
<ns2:ACRCode>L5-P5S5A0T4R4Z6C4-080</ns2:ACRCode>
</ns2:Address>
</ns2:output_port>
</ns2:xml.GetGlobalCandidateAddressesResponse>
要求
入力データのパラメータ
GetGlobalCandidateAddresses は正規化済み住所を受け取ります。どの国の住所であるかにかかわら
ず、すべての住所がこのフォーマットを使用します。[AddressLine1] および [Country] は、必須の入力
フィールドです。他のフィールドはすべてオプションです。
表 5 : GetGlobalCandidateAddresses の入力
パラメータ
30
書式
説明
Data.AddressLine1 文字列
最初の住所行。これは必須のフィールドです。
Data.AddressLine2 文字列
2 行目の住所行。
Data.AddressLine3 文字列
3 行目の住所行。
Data.AddressLine4 文字列
4 行目の住所行。
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
パラメータ
書式
説明
Data.AddressLine5 文字列
5 行目の住所行。
Data.AddressLine6 文字列
6 行目の住所行。
Data.AddressLine7 文字列
7 行目の住所行。
Data.AddressLine8 文字列
8 行目の住所行。
Data.City
都市名
文字列
Data.StateProvince 文字列
州または省。
Data.PostalCode
文字列
[10]
住所の郵便番号は、次のフォーマットのいずれかで表されます。
Data.County
String
国。入力の国フォーマットとして選択したフォーマット (英語名また
は ISO コード) を使って国を指定します。ISO コードの一覧は、各国
の ISO コードとモジュールサポート（306ページ）を参照してくださ
い。
Data.FirmName
文字列
[79]
会社名または企業名
99999
99999-9999
A9A9A9
A9A 9A9
9999 999
オプションのパラメータ
表 6 : GetGlobalCandidateAddresses のオプション
パラメータ
説明
Option.HomeCountry
デフォルト国を指定します。ほとんどの郵送物の宛先となる国を指定
します。例えば、ほとんどの郵送先がカナダであれば、カナダを指定
します。 GetGlobalCandidateAddresses は、[StateProvince]、
[PostalCode]、および [Country] の各住所フィールドから国を特定でき
なかった場合、指定された国を使用して、住所の検証を試みます。
Option.OutputCountryFormat 出力で国の名前として使うフォーマットを指定します。次のいずれか
です。
Option.OutputCasing
E
出力の国名には英語表記を使います (デフォルト)。
I
出力の国名には 2 文字の ISO コードを使います。
U
出力の国名には 2 文字の UPU コードを使います。
出力データの大文字と小文字の区別を指定します。次のいずれかで
す。
M
REST Web サービスガイド
出力には、大文字と小文字が混在します (デフォルト)。次に
例を示します。123 Main St Mytown FL 12345
31
Address Now モジュール
パラメータ
説明
U
出力に大文字を使用します。次に例を示します。123 MAIN
ST MYTOWN FL 12345
Option.OutputPostalCodeSeparator ZIP™ Code またはカナダの郵便番号において、区切り文字 (スペース
またはハイフン) を使用するかどうかを指定します。
例えば、区切り文字ありの ZIP + 4® Code は 20706-1844、区切り文
字なしは 207061844 になります。区切り文字ありのカナダの郵便番
号は P5E"1S7、区切り文字なしは P5E1S7 になります。
Y
区切り文字を使います (デフォルト)。
N
区切り文字を使いません。
注 : カナダの郵便番号ではスペースが、米国の ZIP + 4® Code では
ハイフンが使用されます。
Option.ShowExtraAddressLine 都市、州/省、および郵便番号を [AddressLine] 出力フィールドのいず
れかに格納するかどうかを指定します。このオプションの設定とは関
係なく、出力フィールド [都市]、[州/省]、および [郵便番号] には常に
都市、州/省、および郵便番号が格納されます。
Y
Y — 都市、州/省、および郵便番号を [AddressLine] 出力フィー
ルドに格納します (デフォルト)。
N
N — 都市、州/省、および郵便番号を [AddressLine] 出力フィー
ルドに格納しません。
Option.MaximumResults
出力する候補住所の最大数。デフォルトは 50 です。最大値は 100 で
す。
Option.ReturnUserData
妥当性を確認できなかった入力住所を出力データに含めるかどうかを
指定します。
Y
妥当性を確認できなかった入力データを含めます。
N
妥当性を確認できなかった入力データを含めません (デフォ
ルト)。
応答
住所データ
表 7 : GetGlobalCandidateAddresses の住所データ出力
32
応答要素
書式
説明
AddressLine1
文字列
フォーマット済みの最初の住所行。
AddressLine2
文字列
フォーマット済みの 2 行目の住所行。
AddressLine3
文字列
フォーマット済みの 3 行目の住所行。
AddressLine4
文字列
フォーマット済みの 4 行目の住所行。
AddressLine5
文字列
フォーマット済みの 5 行目の住所行。
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
応答要素
書式
説明
AddressLine6
文字列
フォーマット済みの 6 行目の住所行。
AddressLine7
文字列
フォーマット済みの 7 行目の住所行。
AddressLine8
文字列
フォーマット済みの 8 行目の住所行。
ApartmentLabel
文字列
アパート指定子 (STE や APT など)。例:
123 E Main St. APT 3
ApartmentNumber 文字列
アパート番号。例:
123 E Main St. APT 3
Building
文字列
建物の名前。
City
文字列
都市名。
Country
文字列
国の ISO コードまたは英語名。 ISO コードの一覧は、各国の ISO コー
ドとモジュールサポート（306ページ）を参照してください。
Department
文字列
複数の部門に整理された任意のものの個々の部分の名前。例えば、企
業の中の財務部門など。
FirmName
文字列
会社名。例:
Pitney Bowes Software
4200 PARLIAMENT PL
STE 600
LANHAM MD 20706-1844
USA
HouseNumber
文字列
家番号。例:
123 E Main St. Apt 3
POBox
文字列
私書箱番号。住所が地方配送路住所である場合は、地方配送路の私書
箱番号がここに表示されます。
PostalCode
文字列
現地の郵便当局が記入を必須とする郵便番号。例えば、米国の郵便番
号は ZIP Code です。
PostalCode.AddOn 文字列
米国の住所では、ZIP + 4® Code の最後の 4 文字がこれに該当します。
PostalCode.Base
文字列
[79]
米国の住所では、5 桁の ZIP Code がこれに該当します。
Principality
文字列
国内の地域。例えば、イングランド、スコットランド、ウェールズは
公国です。このフィールドは、通常は空白です。
StateProvince
文字列
州または省の省略形。
StreetName
文字列
ストリート名。例:
123 E Main St. Apt 3
StreetSuffix
文字列
ストリート接尾語。例:
123 E Main St. Apt 3
SubCity
文字列
REST Web サービスガイド
地区または郊外。地区または郊外を住所に含めるのが一般的な国で使
用します。例を次に示します。
33
Address Now モジュール
応答要素
書式
説明
27 Crystal Way
Bradley Stoke
Bristol BS32 8GA
この住所では "Bradley Stoke" が該当します。
SubStreet
文字列
住所の識別に使われる 2 番目のストリート名。 2 つのストリート名を
住所に含めるのが一般的な国で使用します。例を次に示します。
12 The Mews
High Street
この例では、"High Street" が 2 番目のストリート名です。このスト
リート名は、配達先を正確に特定するために使用できます。前の例の
"The Mews" は短いストリートなので、住所を正確に示すために別の
ストリート名が必要とされることから、"High Street" が追記されてい
ます。このような場合、"High Street" がメインまたは既知のストリー
ト名です。
USCountyName
文字列
米国の住所では、住所がある郡の名前です。
リターンコード
表 8 : GetGlobalCandidateAddresses のリターンコード
応答要素
書式
説明
ACRCode
文字列
ACR (住所訂正結果) コードは、各レコードでどのデータが
変更されたかを示します。このコードの意味については、
ACR コード（300ページ）を参照してください。
Confidence
文字列
返された住所に割り当てられた確信レベル。範囲は 0 ～
100 です。0 は失敗を表し、100 はマッチ結果が正しいこと
に対する確信レベルが非常に高いことを表します。
Status
文字列
マッチの成功または失敗を報告します。
Status.Code
文字列
Null
成功
F
失敗
失敗の原因 (ある場合)。
• RequestFailed
• ServerError
• CountryNotFound
Status.Description 文字列
問題の説明 (ある場合)。
Maximum records
cannot be set to 0.
Minimum value
should be 1
Status.Code=RequestFailed の場合
にこの値が表示されます。
Address Not Found Status.Code=RequestFailed の場合
にこの値が表示されます。
34
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
応答要素
書式
説明
Module not licensed Status.Code=ServerError の場合に
この値が表示されます。
Could Not Identify
Country
Status.Code=CountryNotFound の
場合にこの値が表示されます。
ValidateGlobalAddress
ValidateGlobalAddress は、米国およびカナダ以外の住所に対する高度な住所の正規化および検証機能
を提供します。 ValidateGlobalAddress は、米国およびカナダの住所の妥当性も確認できますが、そ
の他の国の住所の妥当性を確認する能力に優れています。米国およびカナダ以外の住所の妥当性を確
認する必要がある場合は、 ValidateGlobalAddress の使用を検討してください。
ValidateGlobalAddress は、Address Now モジュールに含まれています。
リソース URL
JSON エンドポイント:
http://server:port/rest/ValidateGlobalAddress/results.json
XML エンドポイント:
http://server:port/rest/ValidateGlobalAddress/results.xml
リソース URL
JSON エンドポイント:
http://server:port/rest/ValidateAddressGlobal/results.json
XML エンドポイント:
http://server:port/rest/ValidateAddressGlobal/results.xml
JSON 応答の例
次の例では、JSON 応答を要求します。
http://myserver:8080/rest/ValidateGlobalAddress/results.json?
Data.AddressLine1=1825+Kramer+Ln&Data.City=Austin&Data.StateProvince=TX
この要求から次のような JSON が返されます。
{"output_port": [{
"Confidence": "100",
"AddressLine1": "1825 Kramer Ln",
"AddressLine2": "Austin TX 78758",
"AddressLine3": "",
"AddressLine4": "",
"AddressLine5": "",
"AddressLine6": "",
"AddressLine7": "",
"AddressLine8": "",
"Department": "",
"Building": "",
REST Web サービスガイド
35
Address Now モジュール
"SubStreet": "",
"SubCity": "",
"Principality": "",
"City": "Austin",
"StateProvince": "TX",
"PostalCode": "78758",
"Country": "United States",
"FirmName": "",
"HouseNumber": "1825",
"StreetName": "Kramer",
"StreetSuffix": "Ln",
"ApartmentLabel": "",
"POBox": "",
"USCountyName": "Travis",
"WCRCode": "",
"URL1": "",
"URL2": "",
"Email1": "",
"Email2": "",
"ACRCode": "L5-P4S4A0T4R4Z6C4-100",
"OuterMatchScore": "40",
"Latitude": "",
"Longitude": "",
"ECRCode": "CoBoPeSeXoCeRoPo",
"PostalCode.Base": "78758",
"PostalCode.AddOn": "",
"user_fields": []
}]}
XML 応答の例
次の例では、XML 応答を要求します。
http://myserver:8080/rest/ValidateGlobalAddress/results.xml?
Data.AddressLine1=1825+Kramer+Ln&Data.City=Austin&Data.StateProvince=TX
この要求から次のような XML が返されます。
注 : この例では、空の応答要素を削除しています。
<ns2:xml.ValidateGlobalAddressResponse
xmlns:ns2="http://www.pb.com/spectrum/services/ValidateGlobalAddress">
<ns2:output_port>
<ns2:Address>
<ns2:Confidence>100</ns2:Confidence>
<ns2:AddressLine1>1825 Kramer Ln</ns2:AddressLine1>
<ns2:AddressLine2>Austin TX 78758</ns2:AddressLine2>
<ns2:City>Austin</ns2:City>
<ns2:StateProvince>TX</ns2:StateProvince>
<ns2:PostalCode>78758</ns2:PostalCode>
<ns2:PostalCode.Base>78758</ns2:PostalCode.Base>
<ns2:PostalCode.AddOn/>
<ns2:Country>United States</ns2:Country>
<ns2:HouseNumber>1825</ns2:HouseNumber>
<ns2:StreetName>Kramer</ns2:StreetName>
<ns2:StreetSuffix>Ln</ns2:StreetSuffix>
<ns2:USCountyName>Travis</ns2:USCountyName>
<ns2:ACRCode>L5-P4S4A0T4R4Z6C4-100</ns2:ACRCode>
<ns2:OuterMatchScore>40</ns2:OuterMatchScore>
<ns2:ECRCode>CoBoPeSeXoCeRoPo</ns2:ECRCode>
</ns2:Address>
</ns2:output_port>
</ns2:xml.ValidateGlobalAddressResponse>
36
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
要求
入力データのパラメータ
ValidateGlobalAddress は、正規化済みの住所を入力として受け取ります。どの国の住所であるかにか
かわらず、すべての住所がこのフォーマットを使用します。
表 9 : ValidateGlobalAddress の入力
パラメータ
書式
説明
Data.AddressLine1
文字列
最初の住所行。
Data.AddressLine2
文字列
2 行目の住所行。
Data.AddressLine3
文字列
3 行目の住所行。
Data.AddressLine4
文字列
4 行目の住所行。
Data.AddressLine5
文字列
5 行目の住所行。
Data.AddressLine5
文字列
6 行目の住所行。
Data.AddressLine7
文字列
7 行目の住所行。
Data.AddressLine7
文字列
8 行目の住所行。
Data.City
文字列
都市名
Data.StateProvince
文字列
州または省。
Data.PostalCode
文字列
住所の郵便番号。米国では、ZIP Code と呼びます。
™
99999
99999-9999
A9A9A9
A9A 9A9
9999
999
Data.Country
文字列
入力の国フォーマットとして選択したフォーマット (英語名
または ISO コード) を使って国を指定します。ISO コードの
一覧は、各国の ISO コードとモジュールサポート（306ペー
ジ）を参照してください。
Data.FirmName
文字列
会社名または企業名
REST Web サービスガイド
37
Address Now モジュール
オプションのパラメータ
入力データオプション
表 10 : ValidateGlobalAddress の入力データオプション
パラメータ
説明
Option.HomeCountry
デフォルト国を指定します。住所の大半がある国を指定してくださ
い。例えば、処理する住所の大部分がカナダにある場合は、カナダを
指定します。 ValidateGlobalAddress では、[StateProvince]、
[PostalCode]、または [Country] 住所フィールドで国を特定できない場
合に自国を使って住所を確認しようとします。有効な値の一覧は、各
国の ISO コードとモジュールサポート（306ページ）を参照してくだ
さい。
出力データオプション
表 11 : ValidateGlobalAddress の出力データオプション
パラメータ
説明
Option.OutputCountryFormat 出力で国の名前として使うフォーマットを指定します。次のいずれか
です。
Option.OutputCasing
E
出力の国名には英語表記を使います (デフォルト)。
I
出力の国名には 2 文字の ISO コードを使います。
U
出力の国名には 2 文字の UPU コードを使います。
出力データの大文字と小文字の区別を指定します。次のいずれかで
す。
M
出力には、大文字と小文字が混在します (デフォルト)。次に
例を示します。123 Main St Mytown FL 12345
U
出力に大文字を使用します。次に例を示します。123 MAIN
ST MYTOWN FL 12345
Option.OutputPostalCodeSeparator ZIP™ Code またはカナダ郵便番号で区切り文字 (スペースまたはハイ
フン) を使うかどうかを指定します。
例えば、区切り文字ありの ZIP + 4® Code は 20706-1844、区切り文
字なしは 207061844 になります。区切り文字ありのカナダの郵便番
号は P5E"1S7、区切り文字なしは P5E1S7 になります。
Y
区切り文字を使います (デフォルト)。
N
区切り文字を使いません。
注 : カナダの郵便番号ではスペースが、米国の ZIP + 4® コードでは
ハイフンが使用されます。
Option.ShowExtraAddressLine 都市、州/省、および郵便番号を [AddressLine] 出力フィールドのいず
れかに格納するかどうかを指定します。このオプションの設定とは関
係なく、出力フィールド [都市]、[州/省]、および [郵便番号] には常に
都市、州/省、および郵便番号が格納されます。
38
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
パラメータ
説明
Y
Y — 都市、州/省、および郵便番号を [AddressLine] 出力フィー
ルドに格納します (デフォルト)。
N
N — 都市、州/省、および郵便番号を [AddressLine] 出力フィー
ルドに格納しません。
Option.StandardizeAddressOnFail 住所を検証できない場合に正規化された住所を返すかどうかを指定し
ます。住所には、その国の標準住所書式が設定されます。このオプ
ションを選択しない場合、住所のに失敗すると出力住所コンポーネン
トフィールド ([StreetName]、[HouseNumber] など) は空白になりま
す。
Option.FormatOnFail
Option.ValidateAddress
N
失敗した住所の書式を整えません (デフォルト)。
Y
検証に失敗した住所を正規化します。
住所の妥当性を確認できない場合に書式を整えた住所を返すかどうか
を指定します。住所には、その国の標準住所書式が設定されます。
Y
住所を検証できない場合に書式設定された住所を返します。
N
住所を検証できない場合に書式設定された住所を返しません
(デフォルト)。
住所検証を有効にします。住所検証は以下の手順で進められます。
• 各コンポーネントを当該国の参照データと照合します。
• スペルの誤りを訂正します。
• 欠落しているコンポーネントを補います。
• 郵便番号を訂正するか補います。
Option.FormatAddress
Y
住所を検証します (デフォルト)。
N
住所を検証しません。
住所のコンポーネントを法律で定められたフォーマットまたはカスタ
ムフォーマットに書式設定します。
Y
住所に書式を設定します (デフォルト)。
N
住所に書式を設定しません。
正規化オプション
表 12 : ValidateGlobalAddress の正規化オプション
パラメータ
説明
Option.StandardizeComponent.Department 住所を正規化するときに [Department] フィールドに値を設定するかど
うかを指定します。
Y
はい (デフォルト)
N
いいえ
Option.StandardizeComponent.FirmName 住所を正規化するときに [FirmName] フィールドに値を設定するかど
うかを指定します。
REST Web サービスガイド
39
Address Now モジュール
パラメータ
説明
Y
はい (デフォルト)
N
いいえ
Option.StandardizeComponent.Building 住所を正規化するときに [Building] フィールドに値を設定するかどう
かを指定します。
Y
はい (デフォルト)
N
いいえ
Option.StandardizeComponent.SubBuilding 住所を正規化するときに [SubBuilding] フィールドに値を設定するかど
うかを指定します。
Y
はい (デフォルト)
N
いいえ
Option.StandardizeComponent.HouseNumber 住所を正規化するときに [HouseNumber] フィールドに値を設定する
かどうかを指定します。
Y
はい (デフォルト)
N
いいえ
Option.StandardizeComponent.SubStreet 住所を正規化するときに [SubStreet] フィールドに値を設定するかど
うかを指定します。
Y
はい (デフォルト)
N
いいえ
Option.StandardizeComponent.StreetName 住所を正規化するときに [StreetName] フィールドに値を設定するかど
うかを指定します。
Y
はい (デフォルト)
N
いいえ
Option.StandardizeComponent.POBox 住所を正規化するときに [POBox] フィールドに値を設定するかどうか
を指定します。
Y
はい (デフォルト)
N
いいえ
Option.StandardizeComponent.SubCity 住所を正規化するときに [SubCity] フィールドに値を設定するかどう
かを指定します。
Y
はい (デフォルト)
N
いいえ
Option.StandardizeComponent.City 住所を正規化するときに [City] フィールドに値を設定するかどうかを
指定します。
Y
はい (デフォルト)
N
いいえ
Option.StandardizeComponent.USCountyName 住所を正規化するときに [USCountyName] フィールドに値を設定する
かどうかを指定します。
40
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
パラメータ
説明
Y
はい (デフォルト)
N
いいえ
Option.StandardizeComponent.StateProvince 住所を正規化するときに [StateProvince] フィールドに値を設定するか
どうかを指定します。
Y
はい (デフォルト)
N
いいえ
Option.StandardizeComponent.Principality 住所を正規化するときに [Principality] フィールドに値を設定するかど
うかを指定します。
Y
はい (デフォルト)
N
いいえ
Option.StandardizeComponent.PostalCode 住所を正規化するときに [PostalCode] フィールドに値を設定するかど
うかを指定します。
Y
はい (デフォルト)
N
いいえ
Option.StandardizeComponent.Plus4 住所を正規化するときに [+4] フィールドに値を設定するかどうかを指
定します。
Y
はい (デフォルト)
N
いいえ
Option.StandardizeComponent.Country 住所を正規化するときに [Country] フィールドに値を設定するかどう
かを指定します。
Option.ReportVulgarWords
Option.FlagVulgarWords
Option.DebugOutput
REST Web サービスガイド
Y
はい (デフォルト)
N
いいえ
不適切な語を検出するかどうかを指定します。このオプションを有効
にすると、ValidateGlobalAddress は、結果を示す値を [WCRCode] 出
力フィールドに返します。
Y
はい
N
いいえ (デフォルト)
">VulgarWord<" 形式を使って、不適切な語を出力中にマークするかど
うかを指定します。
Y
はい
N
いいえ (デフォルト)
このオプションは、トラブルシューティング用の情報を出力フィール
ド [Email1]、[Email2]、[URL1]、および [URL2] に設定するかどうかを
指定します。
Y
はい
N
いいえ (デフォルト)
41
Address Now モジュール
検証オプション
表 13 : ValidateGlobalAddress 検証オプション
パラメータ
説明
Option.ValidateComponent.Department 住所を検証するときに [Department] フィールドを対象とするかどうか
を指定します。
Y
はい
N
いいえ (デフォルト)
Option.ValidateComponent.FirmName 住所を検証するときに [FirmName] フィールドを対象とするかどうか
を指定します。
Y
はい
N
いいえ (デフォルト)
Option.ValidateComponent.Building 住所を検証するときに [Building] フィールドを対象とするかどうかを
指定します。
Y
はい (デフォルト)
N
いいえ
Option.ValidateComponent.SubBuilding 住所を検証するときに [SubBuilding] フィールドを対象とするかどうか
を指定します。
Y
はい (デフォルト)
N
いいえ
Option.ValidateComponent.HouseNumber 住所を検証するときに [HouseNumber] フィールドを対象とするかど
うかを指定します。
Y
はい (デフォルト)
N
いいえ
Option.ValidateComponent.SubStreet 住所を検証するときに [SubStreet] フィールドを対象とするかどうか
を指定します。
Y
はい (デフォルト)
N
いいえ
Option.ValidateComponent.StreetName 住所を検証するときに [StreetName] フィールドを対象とするかどうか
を指定します。
Y
はい (デフォルト)
N
いいえ
Option.ValidateComponent.POBox 住所を検証するときに [POBox] フィールドを対象とするかどうかを指
定します。
42
Y
はい (デフォルト)
N
いいえ
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
パラメータ
説明
Option.ValidateComponent.SubCity 住所を検証するときに [SubCity] フィールドを対象とするかどうかを
指定します。
Y
はい (デフォルト)
N
いいえ
Option.ValidateComponent.City 住所を検証するときに [City] フィールドを対象とするかどうかを指定
します。
Y
はい (デフォルト)
N
いいえ
Option.ValidateComponent.USCountyName 住所を検証するときに [USCountyName] フィールドを対象とするかど
うかを指定します。
Y
はい (デフォルト)
N
いいえ
Option.ValidateComponent.StateProvince 住所を検証するときに [StateProvince] フィールドを対象とするかどう
かを指定します。
Y
はい (デフォルト)
N
いいえ
Option.ValidateComponent.Principality 住所を検証するときに [Principality] フィールドを対象とするかどうか
を指定します。
Y
はい (デフォルト)
N
いいえ
Option.ValidateComponent.PostalCode 住所を検証するときに [PostalCode] フィールドを対象とするかどうか
を指定します。
Y
はい (デフォルト)
N
いいえ
Option.ValidateComponent.Plus4 住所を検証するときに [Plus4] フィールドを対象とするかどうかを指
定します。
Y
はい (デフォルト)
N
いいえ
Option.ValidateComponent.Country 住所を検証するときに [Country] フィールドを対象とするかどうかを
指定します。
Y
はい (デフォルト)
N
いいえ
Option.ForceUpdate.Department 住所を検証するときに [Country] フィールドを訂正するかどうかを指
定します。
REST Web サービスガイド
43
Address Now モジュール
パラメータ
説明
Y
はい (デフォルト)
N
いいえ
Option.ForceUpdate.FirmName 住所を検証するときに [FirmName] フィールドを訂正するかどうかを
指定します。
Y
はい (デフォルト)
N
いいえ
Option.ForceUpdate.Building 住所を検証するときに [Building] フィールドを訂正するかどうかを指
定します。
Y
はい (デフォルト)
N
いいえ
Option.ForceUpdate.SubBuilding 住所を検証するときに [SubBuilding] フィールドを訂正するかどうかを
指定します。
Y
はい (デフォルト)
N
いいえ
Option.ForceUpdate.HouseNumber 住所を検証するときに [HouseNumber] フィールドを訂正するかどう
かを指定します。
Y
はい (デフォルト)
N
いいえ
Option.ForceUpdate.SubStreet 住所を検証するときに [SubStreet] フィールドを訂正するかどうかを
指定します。
Y
はい (デフォルト)
N
いいえ
Option.ForceUpdate.StreetName 住所を検証するときに [StreetName] フィールドを訂正するかどうかを
指定します。
Option.ForceUpdate.POBox
Y
はい (デフォルト)
N
いいえ
住所を検証するときに [POBox] フィールドを訂正するかどうかを指定
します。
Y
はい (デフォルト)
N
いいえ
Option.ForceUpdate.SubCity 住所を検証するときに [SubCity] フィールドを訂正するかどうかを指
定します。
44
Y
はい (デフォルト)
N
いいえ
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
パラメータ
説明
Option.ForceUpdate.City
住所を検証するときに [City] フィールドを訂正するかどうかを指定し
ます。
Y
はい (デフォルト)
N
いいえ
Option.ForceUpdate.USCountyName 住所を検証するときに [USCountyName] フィールドを訂正するかどう
かを指定します。
Y
はい (デフォルト)
N
いいえ
Option.ForceUpdate.StateProvince 住所を検証するときに [StateProvince] フィールドを訂正するかどうか
を指定します。
Y
はい (デフォルト)
N
いいえ
Option.ForceUpdate.Principality 住所を検証するときに [Principality] フィールドを訂正するかどうかを
指定します。
Y
はい (デフォルト)
N
いいえ
Option.ForceUpdate.PostalCode 住所を検証するときに [PostalCode] フィールドを訂正するかどうかを
指定します。
Option.ForceUpdate.Plus4
Y
はい (デフォルト)
N
いいえ
住所を検証するときに [Plus4] フィールドを訂正するかどうかを指定
します。
Y
はい (デフォルト)
N
いいえ
Option.ForceUpdate.Country 住所を検証するときに [Country] フィールドを訂正するかどうかを指
定します。
Y
はい (デフォルト)
N
いいえ
Option.ReplaceAlias.Department Address Now データベースにエイリアスが見つかった場合に、
[Department] フィールドを上書きするかどうかを指定します。
Y
はい
N
いいえ (デフォルト)
Option.ReplaceAlias.FirmName Address Now データベースにエイリアスが見つかった場合に、
[FirmName] フィールドを上書きするかどうかを指定します。
REST Web サービスガイド
45
Address Now モジュール
パラメータ
説明
Y
はい
N
いいえ (デフォルト)
Option.ReplaceAlias.Building Address Now データベースにエイリアスが見つかった場合に、[Building]
フィールドを上書きするかどうかを指定します。
Y
はい
N
いいえ (デフォルト)
Option.ReplaceAlias.SubBuilding Address Now データベースにエイリアスが見つかった場合に、
[SubBuilding] フィールドを上書きするかどうかを指定します。
Y
はい
N
いいえ (デフォルト)
Option.ReplaceAlias.HouseNumber Address Now データベースにエイリアスが見つかった場合に、
[HouseNumber] フィールドを上書きするかどうかを指定します。
Y
はい
N
いいえ (デフォルト)
Option.ReplaceAlias.SubStreet Address Now データベースにエイリアスが見つかった場合に、
[SubStreet] フィールドを上書きするかどうかを指定します。
Y
はい
N
いいえ (デフォルト)
Option.ReplaceAlias.StreetName Address Now データベースにエイリアスが見つかった場合に、
[StreetName] フィールドを上書きするかどうかを指定します。
Option.ReplaceAlias.POBox
Y
はい
N
いいえ (デフォルト)
Address Now データベースにエイリアスが見つかった場合に、[POBox]
フィールドを上書きするかどうかを指定します。
Y
はい
N
いいえ (デフォルト)
Option.ReplaceAlias.SubCity Address Now データベースにエイリアスが見つかった場合に、[Subcity]
フィールドを上書きするかどうかを指定します。
Option.ReplaceAlias.City
46
Y
はい
N
いいえ (デフォルト)
Address Now データベースにエイリアスが見つかった場合に、[City]
フィールドを上書きするかどうかを指定します。
Y
はい
N
いいえ (デフォルト)
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
パラメータ
説明
Option.ReplaceAlias.USCountyName Address Now データベースにエイリアスが見つかった場合に、
[USCountyName] フィールドを上書きするかどうかを指定します。
Y
はい
N
いいえ (デフォルト)
Option.ReplaceAlias.StateProvince Address Now データベースにエイリアスが見つかった場合に、
[StateProvince] フィールドを上書きするかどうかを指定します。
Y
はい
N
いいえ (デフォルト)
Option.ReplaceAlias.Principality Address Now データベースにエイリアスが見つかった場合に、
[Principality] フィールドを上書きするかどうかを指定します。
Y
はい
N
いいえ (デフォルト)
Option.ReplaceAlias.PostalCode Address Now データベースにエイリアスが見つかった場合に、
[PostalCode] フィールドを上書きするかどうかを指定します。
Option.ReplaceAlias.Plus4
Y
はい (デフォルト)
N
いいえ
Address Now データベースにエイリアスが見つかった場合に、[+4]
フィールドを上書きするかどうかを指定します。
Y
はい
N
いいえ (デフォルト)
Option.ReplaceAlias.Country Address Now データベースにエイリアスが見つかった場合に、[Country]
フィールドを上書きするかどうかを指定します。
Option.CautiousUpdate
Y
はい
N
いいえ (デフォルト)
このオプションは、[強制的に更新] オプションと併用することで、処
理中にデータが大きく変更されないようにすることができます。
Y
はい
N
いいえ (デフォルト)
Option.CrossComponentMatch 住所正規化と検証の一般的なエラーを訂正するためにクロスコンポー
ネントマッチを実行するかどうかを指定します。クロスコンポーネ
ントマッチを実行すると、入力データのフィールドにあるデータと
Address Now データベースの別のフィールドにあるデータがマッチす
るかどうかがチェックされます。
REST Web サービスガイド
Y
はい
N
いいえ (デフォルト)
47
Address Now モジュール
パラメータ
説明
Option.UseReferenceDiacritics 住所の違いが付加記号 (アクセント記号、ウムラウト記号など) のみの
場合に Validate Global Address が住所を変更して郵便データベース内
の住所の付加記号に一致させるかどうかを指定します。次のいずれか
です。
Y
はい (デフォルト)
N
いいえ
例えば、[付加記号の参照を使用] を有効にすると、データは以下のよ
うに処理されます。
入力される都市名: Chalon-Sur-Saône
郵便データベース内の都市名: CHALON SUR SAONE
出力される都市名: CHALON SUR SAONE
入力される都市名: ARTEMIVS'K
郵便データベース内の都市名: ARTEMIVSK
出力される都市名: ARTEMIVSK
一方、[付加記号の参照を使用]を有効にしない場合は、データは以下
のように処理されます。
入力される都市名: Chalon-Sur-Saône
参照される都市名: CHALON SUR SAONE
出力される都市名: Chalon-Sur-Saône
入力される都市名: ARTEMIVS'K
参照される都市名: ARTEMIVSK
出力される都市名: ARTEMIVS'K
このオプションの設定は、[書き直し方法] オプションに影響しないこ
とに注意してください。
Option.KeepStandardizationChanges 正規化による変更 ("ROAD" を "RD" に変更するなど) を ACR コードと
して報告するかどうかを指定します。
Option.AcceptanceLevel
Y
はい
N
いいえ (デフォルト)
[許容レベル] 設定は、住所全体を検証されたと見なすために検証しな
ければならない住所コンポーネントの最小限の数を指定します。 [許
容レベル] に指定された値は、ACR コードの 2 番目の文字に対応しま
す。詳細については、ACR コード（300ページ）を参照してください。
許容レベルは [内部マッチスコア] オプションとは異なります。許容レ
ベルは、Validate Global Address が検証するコンポーネントの数を指
定するオプションであり、検証対象のコンポーネントが郵便データ
ベースの住所コンポーネントにどの程度マッチするかは問いません。
一方、[内部マッチスコア] は、出力住所が検証済みの正しいバージョ
ンの入力住所である可能性を示します。
次のいずれかです。
48
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
パラメータ
Option.InnerMatchScore
説明
-1
許容レベルは、住所の国に基づいて適切なレベルに自動的に
設定されます。例えば、米国の住所は許容レベル 4 で処理さ
れます。
0
コンポーネントを 1 つも検証しません (デフォルト)
1
国名のみを検証します
2
都市名および国名を検証します
3
都市名、郵便コード、および国名を検証します
4
ストリート名、都市名、郵便コード、および国名を検証しま
す
5
構内番号、建物名、従属する建物名、私書箱、企業名、スト
リート名、都市名、郵便番号、および国名を検証します
住所検証の最小確信レベルを指定します。 [Confidence] 出力フィール
ドの値がこのレベル値と同じかそれを超える住所が検証の対象となり
ます。値がレベル値よりも小さい住所は検証されません (出力フィー
ルド [Status] に "F" が設定されます)。
0 ～ 100 の範囲の値を指定できます。値が大きいほど、住所検証の実
行に必要な確信レベルが高くなります。デフォルト値は 60 です。
Option.CompanyWeight
Address Now データベース内のデータと比較される [FirmName] フィー
ルドの相対的な重要性を示す 0 ～ 10 の範囲の整数。このオプション
は、確信値に影響するので、正しい更新と正しくない更新を区別する
ために確信の度合いを調節する目的に使えます。詳細については、
ACR コード（300ページ）を参照してください。
デフォルト値は 1 です。
Option.StreetWeight
Address Now データベース内のデータと比較される [StreetName]
フィールドの相対的な重要性を示す 0 ～ 10 の範囲の整数。このフィー
ルドが他のフィールドに対して持つ相対的な重要性を表す 0 ～ 10 の
範囲の整数です。詳細については、ACR コード（300ページ）を参照
してください。
デフォルト値は 10 です。
Option.CityWeight
Address Now データベース内のデータと比較される [City] フィールド
の相対的な重要性を示す 0 ～ 10 の範囲の整数。このフィールドが他
のフィールドに対して持つ相対的な重要性を表す 0 ～ 10 の範囲の整
数です。詳細については、ACR コード（300ページ）を参照してくだ
さい。
デフォルト値は 8 です。
Option.PostcodeWeight
REST Web サービスガイド
Address Now データベース内のデータと比較される [PostalCode]
フィールドの相対的な重要性を示す 0 ～ 10 の範囲の整数。このフィー
ルドが他のフィールドに対して持つ相対的な重要性を表す 0 ～ 10 の
範囲の整数です。詳細については、ACR コード（300ページ）を参照
してください。
49
Address Now モジュール
パラメータ
説明
デフォルト値は 8 です。
Option.OuterMatchScoreLines 外部マッチスコア行を計算するときに使う住所の行数を示す 0 ～ 8
の範囲の値。デフォルト値は 8 です。外部マッチスコア行の詳細に
ついては、外部マッチスコア（56ページ）を参照してください。
出力フォーマットオプション
表 14 : ValidateGlobalAddress の出力フォーマットオプション
パラメータ
説明
Option.FormatComponent.Department [Department] フィールドにフォーマット済み住所の出力を設定するか
どうかを指定します。
Y
はい (デフォルト)
N
いいえ
Option.FormatComponent.FirmName [FirmName] フィールドにフォーマット済み住所の出力を設定するか
どうかを指定します。
Y
はい (デフォルト)
N
いいえ
Option.FormatComponent.Building [Building] フィールドにフォーマット済み住所の出力を設定するかどう
かを指定します。
Y
はい (デフォルト)
N
いいえ
Option.FormatComponent.SubBuilding [SubBuilding] フィールドにフォーマット済み住所の出力を設定するか
どうかを指定します。
Y
はい (デフォルト)
N
いいえ
Option.FormatComponent.HouseNumber [HouseNumber] フィールドにフォーマット済み住所の出力を設定する
かどうかを指定します。
Y
はい (デフォルト)
N
いいえ
Option.FormatComponent.SubStreet [SubStreet] フィールドにフォーマット済み住所の出力を設定するかど
うかを指定します。
Y
はい (デフォルト)
N
いいえ
Option.FormatComponent.StreetName [StreetName] フィールドにフォーマット済み住所の出力を設定するか
どうかを指定します。
50
Y
はい (デフォルト)
N
いいえ
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
パラメータ
説明
Option.FormatComponent.POBox [POBox] フィールドにフォーマット済み住所の出力を設定するかどう
かを指定します。
Y
はい (デフォルト)
N
いいえ
Option.FormatComponent.SubCity [SubCity] フィールドにフォーマット済み住所の出力を設定するかどう
かを指定します。
Y
はい (デフォルト)
N
いいえ
Option.FormatComponent.City [City] フィールドにフォーマット済み住所の出力を設定するかどうか
を指定します。
Y
はい (デフォルト)
N
いいえ
Option.FormatComponent.USCountyName [USCountyName] フィールドにフォーマット済み住所の出力を設定す
るかどうかを指定します。
Y
はい (デフォルト)
N
いいえ
Option.FormatComponent.StateProvince [StateProvince] フィールドにフォーマット済み住所の出力を設定する
かどうかを指定します。
Y
はい (デフォルト)
N
いいえ
Option.FormatComponent.Principality [Principality] フィールドにフォーマット済み住所の出力を設定するか
どうかを指定します。
Y
はい (デフォルト)
N
いいえ
Option.FormatComponent.PostalCode [PostalCode] フィールドにフォーマット済み住所の出力を設定するか
どうかを指定します。
Y
はい (デフォルト)
N
いいえ
Option.FormatComponent.Plus4 [+4] フィールドにフォーマット済み住所の出力を設定するかどうかを
指定します。
Y
はい (デフォルト)
N
いいえ
Option.FormatComponent.Country [Country] フィールドにフォーマット済み住所の出力を設定するかどう
かを指定します。
REST Web サービスガイド
Y
はい
N
いいえ (デフォルト)
51
Address Now モジュール
パラメータ
説明
Option.Transliteration
出力住所の付加記号をフォーマットする方法を指定します。次のいず
れかです。
0
書き直しを実行しません。付加記号は、入力または郵便データ
ベースで提供されたままで残されます。こちらがデフォルトで
す。
1
付加記号を除去し、それに相当する非装飾文字で置き換えま
す。
2
言語固有の書き直しルールに従って、付加記号をそれに相当す
る非装飾文字または文字シーケンスに書き直します。
例えば、スウェーデンの住所に 3 つの書き直しオプションを適用した
場合のそれぞれの結果を以下に示します。 "Västra Frölunda" の違いに
注目してください。
0
Gustaf Wernersgata 12 S-42132 Västra Frölunda
1
Gustaf Wernersgata 12 S-42132 Vastra Frolunda
2
Gustaf Wernersgata 12 S-42132 Vaestra Froelunda
応答
住所データ出力
表 15 : ValidateGlobalAddress の住所データ出力
応答要素
書式
説明
AddressLine1
文字列
フォーマット済みの最初の住所行。
AddressLine2
文字列
フォーマット済みの 2 行目の住所行。
AddressLine3
文字列
フォーマット済みの 3 行目の住所行。
AddressLine4
文字列
フォーマット済みの 4 行目の住所行。
AddressLine5
文字列
フォーマット済みの 5 行目の住所行。
AddressLine6
文字列
フォーマット済みの 6 行目の住所行。
AddressLine7
文字列
フォーマット済みの 7 行目の住所行。
AddressLine8
文字列
フォーマット済みの 8 行目の住所行。
ApartmentLabel
文字列
アパート指定子 (STE や APT など)。例:
123 E Main St. APT 3
ApartmentNumber
文字列
アパート番号。例:
123 E Main St. APT 3
52
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
応答要素
書式
説明
Building
文字列
建物の名前。
City
文字列
都市名。
Country
文字列
国の ISO コードまたは英語名。 ISO コードの一覧は、各国
の ISO コードとモジュールサポート（306ページ）を参照し
てください。
Department
文字列
フランス語圏やスペイン語圏で使われる国内の従属する地
区。たとえば、フランスは 100 の department (県) に分割
されます。
FirmName
文字列
会社名。例:
Pitney Bowes Software
4200 PARLIAMENT PL
STE 600
LANHAM MD 20706-1844
USA
HouseNumber
文字列
家番号。例:
123 E Main St. Apt 3
Latitude
文字列
住所から確認できる最も精度の高い緯度。ポイントレベル
の場所またはセントロイドである場合があります。精度レ
ベルは、[ECRCode] 出力フィールドをチェックすると確認
できます。詳細については、ECR コード（55ページ）を参
照してください。
Longitude
文字列
住所から確認できる最も精度の高い経度。ポイントレベル
の場所またはセントロイドである場合があります。精度レ
ベルは、[ECRCode] 出力フィールドをチェックすると確認
できます。詳細については、ECR コード（55ページ）を参
照してください。
POBox
文字列
郵便局の私書箱番号。住所が地方配送路住所である場合は、
地方配送路の私書箱番号がここに表示されます。
PostalCode
文字列
郵便番号。米国では、 ZIP Code™ になります。
PostalCode.AddOn
文字列
ZIP + 4® コードの 4 桁アドオン部分。例えば、60655-1844
という ZIP Code™ において、4 桁のアドオン部分は 1844
になります (米国住所のみ)。
PostalCode.Base
文字列
[79]
5 桁の ZIP Code™。例えば、20706 (米国の住所のみ)。
Principality
文字列
[79]
国内の地域。例えば、イングランド、スコットランド、
ウェールズは公国です。このフィールドは、通常は空白で
す。
StateProvince
文字列
州または省の省略形。
StreetName
文字列
ストリート名。例:
123 E Main St. Apt 3
StreetSuffix
文字列
ストリート接尾語。例:
123 E Main St. Apt 3
REST Web サービスガイド
53
Address Now モジュール
応答要素
書式
説明
SubCity
文字列
地区または郊外。地区または郊外を住所に含めるのが一般
的な国で使用します。例を次に示します。
27 Crystal Way
Bradley Stoke
Bristol BS32 8GA
この住所では "Bradley Stoke" が該当します。
SubStreet
文字列
住所の識別に使われる 2 番目のストリート名。 2 つのスト
リート名を住所に含めるのが一般的な国で使用します。例
を次に示します。
12 The Mews
High Street
この例では、"High Street" が 2 番目のストリート名です。
このストリート名は、配達先を正確に特定するために使用
できます。前の例の "The Mews" は短いストリートなので、
住所を正確に示すために別のストリート名が必要とされる
ことから、"High Street" が追記されています。このような
場合、"High Street" がメインまたは既知のストリート名で
す。
USCountyName
文字列
米国の住所では、住所がある郡の名前です。
リターンコード
表 16 : ValidateGlobalAddress のリターンコード
54
応答要素
書式
説明
ACRCode
文字列
ACR (住所訂正結果) コードは、各レコードでどのデータが
変更されたかを示します。このコードの意味については、
ACR コード（300ページ）を参照してください。
Confidence
文字列
返された住所に割り当てられた確信レベル。範囲は 0 ～
100 です。0 は失敗を表し、100 はマッチ結果が正しいこと
に対する確信レベルが非常に高いことを表します。この値
は、ACR コードの最後の 3 文字と同じであり、検証マッチ
スコアと呼ばれます。詳細については、ACR コード
（300ページ）を参照してください。
ECRCode
文字列
住所訂正結果 (ECR) コードは、住所に対して返される緯度/
経度の精度レベルを表します。詳細については、ECR コー
ド（55ページ）を参照してください。
Email1
文字列
追加の正規化情報。
Email2
文字列
追加の正規化情報。
OuterMatchScore
文字列
各住所行への変更を測るスコア。詳細については、外部マッ
チスコア（56ページ）を参照してください。
Status
文字列
マッチの成功または失敗を報告します。
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
応答要素
書式
説明
• null—Success
• F—Failure
Status.Code
文字列
失敗の原因 (ある場合)。
• UnableToValidate
• ServerError
• CountryNotFound
Status.Description
文字列
問題の説明 (ある場合)。
• Address Not Found— Status.Code=UnableToValidate の
場合にこの値が表示されます。
• Module not licensed— Status.Code=ServerError の場合
にこの値が表示されます。
• Could Not Identify Country—
Status.Code=CountryNotFound の場合にこの値が表示さ
れます。
URL1
文字列
追加の正規化情報。
URL2
文字列
追加の正規化情報。
WCRCode
文字列
語訂正結果 (WCR) コードは、入力住所に不適切な語が見つ
かったことを示します。コードは、2 つの要素に分かれて
います。
• ロケーションコード — 次のいずれかの値です。
• AB — 不適切な語が住所に見つかったことを示します。
• NB — 不適切な語が名前に見つかったことを示します。
• 個数 — ロケーションコードが示す場所に見つかった不適
切な語の数。
例えば、"AB2" は 2 つの不適切な語が入力住所に見つかっ
たことを意味します。
ECR コード
住所訂正結果 (ECR) コードは、住所に対して返される緯度/経度の精度レベルを表します。コードは、
接頭文字とコード本体がダッシュで区切られるフォーマットで構成されます。
接頭文字は常に "EL" で始まり、これに全体の精度レベルを示す 1 ～ 5 の番号が続きます。
• 5 — ポイントジオコード
• 4 — ストリートセントロイド
• 3 — 郵便番号セントロイド
• 2 — 都市セントロイド
• 1 — 地域セントロイド
コードの本体は、住所とジオコードのマッチングに使われたコンポーネントを示します。本体が英数
字で構成されることに注意してください。コード本体の意味は次のとおりです。
• P — 敷地/家番号 (私書箱番号を含む)
• S — ストリート
• T — 都市
REST Web サービスガイド
55
Enterprise Routing モジュール
• R — 地域/州
• Z — 郵便番号
• C—国
コードの本体で使用できる数字オプションは、4 または 0 です。
• 4 — コンポーネントデータが、ジオコードと住所のマッチング検出に使用できました。
• 0 — コンポーネントデータは使用できませんでした。
例: EL4-P0S4T4R4Z4C4
この例では、P の次にある 0 は、この住所マッチング検出に敷地/家番号を使用できなかったものの、
それを除く、ストリート名から国名までのコンポーネントは使用できたことを意味します。
外部マッチスコア
外部マッチスコアは、住所を検証するために ValidateGlobalAddress が各住所行をどの程度変更した
かを示します。このスコアは、正規化前の住所行を検証/フォーマット後の住所と比較して決定されま
す。オプションを 0 より大きな値に設定した場合に、このスコアが生成されます。
外部マッチスコアは、検証マッチスコアと似ています。後者は ACR コードの一部です (ACR コード
（300ページ）を参照)。両者の違いは、外部マッチスコアが住所行への変更 (フォーマットなど) を数
値化するのに対し、検証マッチスコアはデータを検証できたかどうかのみを数値化することです。
例えば、次のような入力住所行を処理前に受け取ったとします。
住所行 1: 5 camden cres
住所行 2: bath
住所行 3: uk
この住所行は、処理後に以下のようになります。
住所行 1: 5 Camden Crescent
住所行 2: Bath
住所行 3: BA1 5HY
住所行 4: United Kingdom
このデータの検証マッチスコアは 84% であり、外部マッチスコアは 23% です。
検証マッチスコアの値が高いのは、住所コンポーネントが検証前でもかなり正確だったからです。ス
トリート名は、大文字と小文字の違いと省略形が使われていたことを除き、実在の名称でした。都市
と国の名前はどちらも有効でした。唯一正しくなかったのが郵便番号です (元の住所には欠落していま
した)。結果として、84% という比較的高い検証マッチスコアが得られました。
外部マッチスコアが低いのは、フォーマット後の住所行が入力住所とかなり異なるからです。前の例
では、入力住所行 3 は "uk" でしたが、出力では "BA1 5HY" となっています。住所行 4 は入力では空
でしたが、出力では値が設定されました。住所行 1 も変更されました。よって、外部スコアはかなり
低い数値になります。
Enterprise Routing モジュール
GetTravelBoundary
GetTravelBoundary は、ロケーションから一定の時間または距離で、車両または徒歩で到達可能なエ
リアの境界を示します。この機能では、時間到達圏または距離到達圏の計算に基づくポリゴンを取得
します。時間到達圏とは、始点から一定時間内に道路を通って到達できるエリアを表すポリゴンまた
56
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
はポイントの集まりです。距離到達圏とは、始点から一定距離の移動で到達できるエリアを表すポリ
ゴンまたはポイントの集まりです。 Get Travel Boundary 操作 (到達圏定義とも呼ばれます) は、始点、
単位 (距離または時間)、1 つ以上のコスト、およびそれらに関連付けられたタグを入力として受け取
り、生成された経路境界を返します。コストとは、到達圏計算に使用する時間または距離の量を意味
します。タグは、コストを一意に指す文字列で、対応する結果とのマッチングに使用されます。複数
のコストを “;” 区切り文字列として提供することで、コストを入力として指定できます。
GetTravelBoundary は、Enterprise Routing モジュールに含まれています。
注 : GetTravelBoundary は、Web サービスとしてのみ利用可能です。 Get Travel Boundary サービス
を、Java、C++、C、.NET、または COM API を介して利用することはできません。
リソース URL
JSON エンドポイント:
http://server:port/rest/GetTravelBoundary/results.json
XML エンドポイント:
http://server:port/rest/GetTravelBoundary/results.xml
http://server:port/soap/GetTravelBoundary
JSON 応答の例
次の例は JSON 応答を要求します。
http://myserver:8080/rest/GetTravelBoundary/results.json?
Data.Latitude=33.751748&Data.Longitude=-84.364014&Data.TravelBoundaryCost=10&
Data.TravelBondaryCostUnits=Kilometers
この要求が返す JSON は次のようになります。
注 : この例では、短縮のため一部のポイントが削除されています。
{"output_port": [{
"IsoNodeResponse": [],
"IsoPolygonResponse":
{
"srsName": "epsg:4326",
"Polygon": [
{
"srsName": "epsg:4326",
"Exterior": {"LineString": [{"Pos":
{
"X": -84.34868168466456,
"Y": 33.68373169496257
},
{
"X": -84.36945064055561,
"Y": 33.69293307108579
},
{
"X": -84.3694506405556,
"Y": 33.69293307108579
},
{
"X": -84.3694506405556,
"Y": 33.69303002973829
},
{
"X": -84.37104825254721,
"Y": 33.69391558543121
REST Web サービスガイド
[
57
Enterprise Routing モジュール
},
{
"X": -84.37104825254721,
"Y": 33.6936408692491
},
{
"X": -84.42163929894845,
"Y": 33.716054477754355
},
{
"X": -84.4440058668311,
"Y": 33.710741143596806
},
{
"X": -84.43921303085625,
"Y": 33.72800947960886
},
{
"X": -84.45678676276404,
"Y": 33.73376559161287
},
{
"X": -84.43921303085625,
"Y": 33.73996448146335
},
...
]}]}
}]
},
"user_fields": [
{
"name": "TravelBondaryCostUnits",
"value": "Kilometers"
}]
}]}
XML 応答の例
次の例は XML 応答を要求します。
http://myserver:8080/rest/GetTravelBoundary/results.xml?
Data.TravelBoundaryCostUnits=Kilometers&Data.Latitude=33.751748&
Data.Longitude=-84.364014&Data.TravelBoundaryCost=10
この要求が返す XML は次のようになります。
注 : この例では、短縮のため一部のポイントが削除されています。
<ns3:xml.GetTravelBoundaryResponse
xmlns:ns2="http://www.mapinfo.com/midev/service/geometries/v1"
xmlns:ns3="http://www.pb.com/spectrum/services/GetTravelBoundary">
<ns3:output_port>
<ns3:IsoRouteResponse>
<ns3:IsoNodeResponse/>
<ns3:IsoPolygonResponse
xsi:type="ns2:MultiPolygon"
srsName="epsg:4326"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ns2:Polygon srsName="epsg:4326">
<ns2:Exterior>
<ns2:LineString>
<ns2:Pos>
<ns2:X>-84.34868168466456</ns2:X>
<ns2:Y>33.68373169496257</ns2:Y>
</ns2:Pos>
<ns2:Pos>
<ns2:X>-84.36945064055561</ns2:X>
<ns2:Y>33.69293307108579</ns2:Y>
</ns2:Pos>
58
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
<ns2:Pos>
<ns2:X>-84.3694506405556</ns2:X>
<ns2:Y>33.69293307108579</ns2:Y>
</ns2:Pos>
<ns2:Pos>
<ns2:X>-84.3694506405556</ns2:X>
<ns2:Y>33.69303002973829</ns2:Y>
</ns2:Pos>
<ns2:Pos>
<ns2:X>-84.37104825254721</ns2:X>
<ns2:Y>33.69391558543121</ns2:Y>
</ns2:Pos>
<ns2:Pos>
<ns2:X>-84.37104825254721</ns2:X>
<ns2:Y>33.6936408692491</ns2:Y>
</ns2:Pos>
<ns2:Pos>
<ns2:X>-84.42163929894845</ns2:X>
<ns2:Y>33.716054477754355</ns2:Y>
</ns2:Pos>
<ns2:Pos>
<ns2:X>-84.4440058668311</ns2:X>
<ns2:Y>33.710741143596806</ns2:Y>
</ns2:Pos>
<ns2:Pos>
<ns2:X>-84.43921303085625</ns2:X>
<ns2:Y>33.72800947960886</ns2:Y>
</ns2:Pos>
<ns2:Pos>
<ns2:X>-84.45678676276404</ns2:X>
<ns2:Y>33.73376559161287</ns2:Y>
</ns2:Pos>
...
</ns2:LineString>
</ns2:Exterior>
</ns2:Polygon>
</ns3:IsoPolygonResponse>
<ns3:user_fields/>
</ns3:IsoRouteResponse>
</ns3:output_port>
</ns3:xml.GetTravelBoundaryResponse>
例
ケース 1、単一のコスト:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:get="http://www.pb.com/spectrum/services/GetTravelBoundary">
<soapenv:Header/>
<soapenv:Body>
<get:GetTravelBoundaryRequest>
<get:input_port>
<get:IsoRouteRequest>
<get:Latitude>33.751748</get:Latitude>
<get:Longitude>-84.364014</get:Longitude>
<get:TravelBoundaryCost>10</get:TravelBoundaryCost>
<get:TravelBoundaryCostUnits>Kilometers</get:TravelBoundaryCostUnits>
</get:IsoRouteRequest>
</get:input_port>
</get:GetTravelBoundaryRequest>
</soapenv:Body>
</soapenv:Envelope>
応答は次のようになります。
REST Web サービスガイド
59
Enterprise Routing モジュール
注 : この例では、短縮のため一部のポイントが削除されています。
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns4:GetTravelBoundaryResponse xmlns:ns2="http://spectrum.pb.com/"
xmlns:ns3="http://www.mapinfo.com/midev/service/geometries/v1"
xmlns:ns4="http://www.pb.com/spectrum/services/GetTravelBoundary">
<ns4:output_port>
<ns4:IsoRouteResponse>
<ns4:IsoNodeResponse/>
<ns4:IsoPolygonResponse
xsi:type="ns3:MultiPolygon"
srsName="epsg:4326"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ns3:Polygon srsName="epsg:4326">
<ns3:Exterior>
<ns3:LineString>
<ns3:Pos>
<ns3:X>-84.34868168466456</ns3:X>
<ns3:Y>33.68373169496257</ns3:Y>
</ns3:Pos>
<ns3:Pos>
<ns3:X>-84.36945064055561</ns3:X>
<ns3:Y>33.69293307108579</ns3:Y>
</ns3:Pos>
<ns3:Pos>
<ns3:X>-84.3694506405556</ns3:X>
<ns3:Y>33.69293307108579</ns3:Y>
</ns3:Pos>
<ns3:Pos>
<ns3:X>-84.3694506405556</ns3:X>
<ns3:Y>33.69303002973829</ns3:Y>
</ns3:Pos>
<ns3:Pos>
<ns3:X>-84.37104825254721</ns3:X>
<ns3:Y>33.69391558543121</ns3:Y>
</ns3:Pos>
<ns3:Pos>
<ns3:X>-84.37104825254721</ns3:X>
<ns3:Y>33.6936408692491</ns3:Y>
</ns3:Pos>
<ns3:Pos>
<ns3:X>-84.42163929894845</ns3:X>
<ns3:Y>33.716054477754355</ns3:Y>
</ns3:Pos>
<ns3:Pos>
<ns3:X>-84.4440058668311</ns3:X>
<ns3:Y>33.710741143596806</ns3:Y>
</ns3:Pos>
<ns3:Pos>
<ns3:X>-84.43921303085625</ns3:X>
<ns3:Y>33.72800947960886</ns3:Y>
</ns3:Pos>
<ns3:Pos>
<ns3:X>-84.45678676276404</ns3:X>
<ns3:Y>33.73376559161287</ns3:Y>
</ns3:Pos>
...
</ns3:LineString>
</ns3:Exterior>
</ns3:Polygon>
</ns4:IsoPolygonResponse>
<ns4:user_fields/>
</ns4:IsoRouteResponse>
</ns4:output_port>
</ns4:GetTravelBoundaryResponse>
</soap:Body>
</soap:Envelope>
60
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
ケース 2、複数のコスト:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:get="http://www.pb.com/spectrum/services/GetTravelBoundary">
<soapenv:Header/>
<soapenv:Body>
<get:GetTravelBoundaryRequest>
<get:input_port>
<get:IsoRouteRequest>
<get:Latitude>33.751748</get:Latitude>
<get:Longitude>-84.364014</get:Longitude>
<get:TravelBoundaryCost>5;10</get:TravelBoundaryCost>
<get:TravelBoundaryCostUnits>Kilometers</get:TravelBoundaryCostUnits>
</get:IsoRouteRequest>
</get:input_port>
</get:GetTravelBoundaryRequest>
</soapenv:Body>
</soapenv:Envelope>
応答は次のようになります。
注 : この例では、短縮のため一部のポイントが削除されています。
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns4:GetTravelBoundaryResponse xmlns:ns2="http://spectrum.pb.com/"
xmlns:ns3="http://www.mapinfo.com/midev/service/geometries/v1"
xmlns:ns4="http://www.pb.com/spectrum/services/GetTravelBoundary">
<ns4:output_port>
<ns4:IsoRouteResponse>
<ns4:cost>5</ns4:cost>
<ns4:costUnits>Kilometers</ns4: costUnits >
<ns4:IsoNodeResponse/>
<ns4:IsoPolygonResponse
xsi:type="ns3:MultiPolygon"
srsName="epsg:4326"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ns3:Polygon srsName="epsg:4326">
<ns3:Exterior>
<ns3:LineString>
<ns3:Pos>
<ns3:X>-84.34868168466456</ns3:X>
<ns3:Y>33.68373169496257</ns3:Y>
</ns3:Pos>
<ns3:Pos>
<ns3:X>-84.36945064055561</ns3:X>
<ns3:Y>33.69293307108579</ns3:Y>
</ns3:Pos>
<ns3:Pos>
<ns3:X>-84.3694506405556</ns3:X>
<ns3:Y>33.69293307108579</ns3:Y>
</ns3:Pos>
<ns3:Pos>
<ns3:X>-84.3694506405556</ns3:X>
<ns3:Y>33.69303002973829</ns3:Y>
</ns3:Pos>
<ns3:Pos>
<ns3:X>-84.37104825254721</ns3:X>
<ns3:Y>33.69391558543121</ns3:Y>
</ns3:Pos>
<ns3:Pos>
<ns3:X>-84.37104825254721</ns3:X>
<ns3:Y>33.6936408692491</ns3:Y>
</ns3:Pos>
<ns3:Pos>
<ns3:X>-84.42163929894845</ns3:X>
<ns3:Y>33.716054477754355</ns3:Y>
REST Web サービスガイド
61
Enterprise Routing モジュール
</ns3:Pos>
<ns3:Pos>
<ns3:X>-84.4440058668311</ns3:X>
<ns3:Y>33.710741143596806</ns3:Y>
</ns3:Pos>
<ns3:Pos>
<ns3:X>-84.43921303085625</ns3:X>
<ns3:Y>33.72800947960886</ns3:Y>
</ns3:Pos>
<ns3:Pos>
<ns3:X>-84.45678676276404</ns3:X>
<ns3:Y>33.73376559161287</ns3:Y>
</ns3:Pos>
...
</ns3:LineString>
</ns3:Exterior>
</ns3:Polygon>
</ns4:IsoPolygonResponse>
<ns4:user_fields/>
</ns4:IsoRouteResponse>
<ns4:IsoRouteResponse>
<ns4:cost>10</ns4:cost>
<ns4:costUnits>Kilometers</ns4: costUnits >
<ns4:IsoNodeResponse/>
<ns4:IsoPolygonResponse
xsi:type="ns3:MultiPolygon"
srsName="epsg:4326"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ns3:Polygon srsName="epsg:4326">
<ns3:Exterior>
<ns3:LineString>
<ns3:Pos>
<ns3:X>-84.34868168466456</ns3:X>
<ns3:Y>33.68373169496257</ns3:Y>
</ns3:Pos>
<ns3:Pos>
<ns3:X>-84.36945064055561</ns3:X>
<ns3:Y>33.69293307108579</ns3:Y>
</ns3:Pos>
<ns3:Pos>
<ns3:X>-84.3694506405556</ns3:X>
<ns3:Y>33.69293307108579</ns3:Y>
</ns3:Pos>
<ns3:Pos>
<ns3:X>-84.3694506405556</ns3:X>
<ns3:Y>33.69303002973829</ns3:Y>
</ns3:Pos>
<ns3:Pos>
<ns3:X>-84.37104825254721</ns3:X>
<ns3:Y>33.69391558543121</ns3:Y>
</ns3:Pos>
<ns3:Pos>
<ns3:X>-84.37104825254721</ns3:X>
<ns3:Y>33.6936408692491</ns3:Y>
</ns3:Pos>
<ns3:Pos>
<ns3:X>-84.42163929894845</ns3:X>
<ns3:Y>33.716054477754355</ns3:Y>
</ns3:Pos>
<ns3:Pos>
<ns3:X>-84.4440058668311</ns3:X>
<ns3:Y>33.710741143596806</ns3:Y>
</ns3:Pos>
<ns3:Pos>
<ns3:X>-84.43921303085625</ns3:X>
<ns3:Y>33.72800947960886</ns3:Y>
</ns3:Pos>
<ns3:Pos>
<ns3:X>-84.45678676276404</ns3:X>
<ns3:Y>33.73376559161287</ns3:Y>
62
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
</ns3:Pos>
...
</ns3:LineString>
</ns3:Exterior>
</ns3:Polygon>
</ns4:IsoPolygonResponse>
<ns4:user_fields/>
</ns4:IsoRouteResponse>
</ns4:output_port>
</ns4:GetTravelBoundaryResponse>
</soap:Body>
</soap:Envelope>
要求
入力データのパラメータ
GetTravelBoundary は、コスト、コスト単位、ポイント緯度、およびポイント経度を入力として受け
取ります。以下の表に、入力のフォーマットとレイアウトに関する情報を示します。
表 17 : GetTravelBoundary 入力データ
パラメータ
書式
説明
Data.Latitude
文字列
ポイントの緯度。Option.CoordinateFormat パラ
メータで選択されたフォーマットを使って緯度を
指定します。
Data.Longitude
文字列
ポイントの経度。 Option.CoordinateFormat パラ
メータで選択されたフォーマットを使って経度を
指定します。
Data.TravelBoundaryCost
文字列
(オプション) Data.TravelBoundaryCostUnits]パラ
メータまたは
Option.DefaultTravelBoundaryCostUnits パラメー
タで指定された単位で表わされた距離または時間
のコスト。例えば、指定された単位がマイルのと
きにこのフィールドに 10 を指定すると、コスト
は 10 マイルになります。
このフィールドを使って、デフォルト経路境界コ
ストをレコード単位で上書きできます。
また、複数のコストを指定することも可能で、値
を ";" で区切られた文字列として指定します。指
定されたすべてのコストに対して個別に Iso Route
Response が返されます。複数のコストを指定し
た場合、応答にはコストとその応答に関連付けら
れている costUnits が含まれます。
Data.TravelBoundaryCostUnits
文字列
(オプション) 経路境界の計算に使用される計測単
位のタイプ。次のいずれかです。
• Feet
• Hours
• Kilometers
REST Web サービスガイド
63
Enterprise Routing モジュール
パラメータ
書式
説明
•
•
•
•
•
Meters
Miles
Minutes
Seconds
Yards
このフィールドを使って、デフォルト経路境界コ
スト単位をレコード単位で上書きできます。
オプションのパラメータ
入力オプション
表 18 : GetTravelBoundary の入力オプション
パラメータ
説明
Option.DataSetResourceName 検索プロセスで使用するデータが格納されたデータベースの名前。Enterprise
Routing モジュールのルーティングデータベースリソースツールで指定さ
れたデータベース名を使用してください。詳細については、『Spectrum™
Technology Platform 管理ガイド』を参照してください。
Option.CoordinateSystem 入力される座標の座標系。フォーマットは、European Petroleum Survey
Group (EPSG) コード、SRID コード、または MAPINFO コードでなければ
なりません。 codespace:code という形式で、座標参照系を指定します。
例えば、緯度/経度 (WGS 84) で表されるジオメトリは、EPSG:4326 とな
ります。デフォルト値は、緯度/経度 (WGS 84) として知られる EPSG:4326
です。これは、世界規模の座標系であり、ナビゲーションや測量に広く使
用されている NAVSTAR Global Positioning System (GPS: 全地球測位シス
テム) に関連付けられた地球基準座標系です。この測地系は、地球の中心
("地心") を原点とし、衛星および地上データによって定義されています。
EPSG コードの詳細については、www.spatialreference.org を参照してく
ださい。 EPSG に対してサポートされるコードスペースのリストを取得す
るには、SOAP リクエスト List Supported CoordSys by Code Space を
Geometry Service デモページ
http://localhost:8080/Spatial/GeometryService/DemoPage.html から送
信します。
Option.CoordinateFormat 入力座標の緯度/経度のフォーマットを指定します。
注 : このオプションは、緯度/経度座標系を指定した場合のみに使用しま
す。座標系が緯度/経度座標系ではない場合は、座標フォーマットを
[小数] に設定します。
次のいずれかです。
64
Decimal
(90.000000, 180.000000)
DecimalAssumed
(90000000, 180000000)。こちらがデフォ
ルトです。
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
パラメータ
説明
DegreesMinutesSeconds
(90 00 00N, 180 00 00W)
PreZero
(090000000N, 180000000W)
PreZeroDecimal
(090.000000N, 180.000000W)
Option.DefaultTravelBoundaryCost コスト単位の値。デフォルトは 10 です。
Option.DefaultTravelBoundaryCostUnits 経路境界の計算に使う測定単位。次のいずれかです。
•
•
•
•
•
•
•
•
Feet
Hours
Kilometers
Meters
Miles
Minutes
Seconds
Yards
Option.historicTrafficTimeBucket ルーティング計算において、トラフィック速度履歴を使用するかどうかを
指定します。これらの速度は、1 日のうちの異なるタイムバケットに基づ
きます。この機能を使用するには、トラフィック速度履歴がデータに含ま
れている必要があります。各国/地域のデータに対するバケット定義は同じ
です。バケット値に対する速度は異なる場合があります。次のオプション
があります。
None
デフォルト値です。計算において、トラフィックデータ履歴
は使用しません。代わりに速度の平均値を使用します。
AMPeak
午前のピーク速度でルートを計算します。午前ピークのタイ
ムバケットは、1 日のうちの 07:00 ～ 10:00 です。
PMPeak
午後のピーク速度でルートを計算します。午後ピークのタイ
ムバケットは、1 日のうちの 16:00 ～ 19:00 です。
OffPeak
オフピーク (日中) 速度でルートを計算します。オフピークの
タイムバケットは、1 日のうちの 10:00 ～ 16:00 です。
Night
夜間速度でルートを計算します。夜間のタイムバケットは、
1 日のうちの 22:00 ～ 04:00 です。
出力オプション
表 19 : GetTravelBoundary の出力オプション
Parameter
説明
Option.ResultType
返す結果のタイプを指定します。次のいずれかです。
AccessibleNodes isoChrone 全体を返します。
REST Web サービスガイド
Geometry
isoChrone 計算に到達しうる、道路沿いのすべて
のポイントを返します。
StartNodes
入力される住所で指定される場所を返します。
65
Enterprise Routing モジュール
Parameter
説明
Option.SimplificationFactor
元のポイントをどの割合で返す必要があるか (結果のポリゴンの基に
なるポイントの割合) を指定します。
Option.BandingStyle
結果に使用する境界線表示形式を指定します。境界線表示形式は、複
数のコストに基づいて表示できる複数の isoChrone または境界線のタ
イプです。
Donut
境界は、次に小さな境界をくり抜く方法で確定され
ます。
Encompassing 境界は、他のすべての境界から独立して確定されま
す。
Option.ReturnHoles
Option.ReturnIslands
境界内の到達不可能領域を返すかどうかを指定します。これは、道順
に従って適切な時間または距離で到達できない、より大きな境界内に
存在する領域を指します。
Y
境界内の到達不可能領域を返します。
N
境界内の到達不可能領域を返しません。こちらがデフォルト
です。
境界外の到達可能領域を返すかどうかを指定します。これは、適切な
時間または距離で到達できない、主要境界の外にある小さな領域で
す。
Y
境界外の到達可能領域を返します。
N
境界外の到達可能領域を返しません。こちらがデフォルト
です。
経路オプション
経路オプションでは、道路以外を移動する際の移動速度や、経路境界を計算する際に幹線道路のみを
走行するかどうかなどを指定します。多くの経路オプションは、一般道走行速度に関連するもので
す。
表 20 : GetTravelBoundary の経路オプション
パラメータ
説明
Option.MaximumOffRoadDistance
道路以外を移動する距離の最大値を指定します。道路以外
とは、私道や進入路などのことです。例えば、道路外距離
の最大値を 1 マイルと指定すると、道路から 1 マイル以上
離れた地点は、経路境界に含まれません。道路外距離の最
大値として 0 を指定すると、道路から少しでもそれた地点
は経路境界に含まれません。道路以外を移動する際の速度
は、一般道走行速度オプションによって指定します。
Option.Units
返されるデータの単位を指定します。次のいずれかです。
• キロメートル (デフォルト)
• メートル
66
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
パラメータ
説明
• マイル
Option.MajorRoads
計算時に、すべての道路を含めるか、幹線道路のみを含め
るかを指定します。デフォルトでは、幹線道路が True に設
定され、Get Travel Boundary が計算されます。これにより
パフォーマンスが向上しますが、精度は低下する可能性が
あります。
次のマップは、すべての道路を走行する場合の経路境界を
表します。
次のマップは、幹線道路のみを走行する場合の経路境界を
表します。
REST Web サービスガイド
67
Enterprise Routing モジュール
パラメータ
説明
次のいずれかです。
Option.DefaultAmbientSpeed
Y
計算時に、幹線道路のみを含めます。こちらがデ
フォルトです。
N
計算時に、すべての道路を含めます。
経路境界を検索するために使用する、道路以外を移動する
際の速度を指定します。道路以外とは、私道や進入路など
のことです。
このオプションは、Option.DefaultCostUnits パラメータ、
または Data.TravelBoundaryCostUnits パラメータで時間値
を指定した場合のみ有効です。デフォルト値は 15 です。
速度の単位は Option.AmbientSpeedUnit パラメータで指定
します。
経路境界計算において道路外の移動の処理を制御するには、
道路外を移動する際の速度 (一般道走行速度) を指定する必
要があります。一般道走行速度は、経路境界を表すポリゴ
ンの大きさや形状に影響を与える可能性があります。一般
的には、一般道走行速度が速いほど、ポリゴンは大きくな
ります。例えば、あと 5 分の移動が可能で、一般道走行速
度が 15 マイル/時の場合は、到達可能地点まで 1.25 マイル
の距離があることになります。一般道走行速度を 10 マイ
ル/時に落とすと、到達可能地点までの距離は 0.83 マイルに
なります。Option.MaximumOffRoadDistance パラメータを
使用することにより、道路外を移動する距離を制限できる
ことに注意してください。
注 : 歩行者の経路境界を計算する場合は、デフォルト一般
道走行速度を 3 MPH (5 KPH) に変更することを推奨
します。
Option.AmbientSpeedUnit
Option.DefaultAmbientSpeed パラメータで指定する値に使
用する単位を指定します。
KPH
キロメートル/時
MPH
マイル/時こちらがデフォルトです。
MTPS
メートル/秒
Option.AmbientSpeed.RoadType.<Type> 道路の種類ごとに、道路外を移動する際の一般道走行速度
を指定します。道路のタイプに対する一般道走行速度を指
定しない場合は、Option.DefaultAmbientSpeed パラメータ
で指定されたデフォルト一般道走行速度が適用されます。
次のマップは、一般道走行速度のオーバーライド値を指定
しない場合の経路境界の例を示しています。
68
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
パラメータ
説明
比較のために、一般道走行速度のオーバーライド値を指定
した場合の、上と同じ経路境界を次のマップに示します。
<Type> には、次の種類があります。
•
•
•
•
•
•
•
•
REST Web サービスガイド
AccessWay
Backroad
Connector
Ferry
Footpath
LimitedAccessDenseUrban
LimitedAccessRural
LimitedAccessSuburban
69
Enterprise Routing モジュール
パラメータ
説明
•
•
•
•
•
•
•
•
•
•
•
•
•
•
LimitedAccessUrban
LocalRoadDenseUrban
LocalRoadRural
LocalRoadSuburban
LocalRoadUrban
MajorLocalRoadDenseUrban
MajorLocalRoadRural
MajorLocalRoadSuburban
MajorLocalRoadUrban
MajorRoadDenseUrban
MajorRoadRural
MajorRoadSuburban
MajorRoadUrban
MinorLocalRoadDenseUrban
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
MinorLocalRoadRural
MinorLocalRoadSuburban
MinorLocalRoadUrban
NormalRoadDenseUrban
NormalRoadRural
NormalRoadRural
NormalRoadUrban
PrimaryHighwayDenseUrban
PrimaryHighwayRural
PrimaryHighwaySuburban
PrimaryHighwayUrban
RampDenseUrban
RampLimitedAccess
RampMajorRoad
RampPrimaryHighway
RampRural
RampSecondaryHighway
RampUrban
RampSuburban
SecondaryHighwayDenseUrban
SecondaryHighwayRural
SecondaryHighwaySuburban
SecondaryHighwayUrban
応答
Get Travel Boundary は、次のフィールドを返します。
表 21 : GetTravelBoundary の出力
70
応答要素
書式
説明
Status
文字列
マッチの成功または失敗を報告します。
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
応答要素
Status.Code
書式
文字列
説明
NULL
成功
F
失敗
失敗の原因 (ある場合)。次のいずれかです。
• InsufficientInputData (緯度/経度の欠落)
• MalformedInputData (誤った入力フォーマット)
• InputOutOfRange (範囲外の入力)
• EngineError (エンジン由来のエラー)
Status.Description
文字列
Status.Code で示される失敗に関する説明。
GetTravelCostMatrix
GetTravelCostMatrix は、複数の始点と終点の間の移動時間と距離を計算します。 GetTravelCostMatrix
を使用して、複数の始点から複数の終点の間の最短または最速ルートを検索し、個々のルートの合計
時間および距離 (ルートコスト) を算出できます。例えば、4 つの始点 (S1 ～ S4) と 4 つの終点 (E1
～ E4) を入力した場合、次の図に示すように合計 16 件のルートが返されます。
マトリクスルーティングは主に、消防署や警察署といった特定のサービスの応答時間および範囲を特
定するために使用します。最初の通報から 20 分以内に事故または事件に対応できる人員を 1 人以上
配備するといったサービスレベルアグリーメント (SLA) の、正確な保証範囲を提示するために、この
ような計算が必要になる場合があります。この計算を分析ツールとして使用することにより、救急
車、警察官、または消防隊員が、合理的な時間以内に不動産/人物まで駆けつけられる確率に基づい
て、保険対象の不動産および人物のリスクを判定できます。
注 : Get Travel Cost Matrix は、SOAP Web サービスとしてのみ利用可能です。 Get Travel Cost Matrix
を、REST を介して利用することはできません。 Java、C++、C、.NET、または COM API を介
して利用することもできません。
GetTravelCostMatrix は、Enterprise Routing モジュールに含まれています。
GetTravelDirections
GetTravelDirections は、2 つのポイントまたは複数のポイントに対するルーティング情報を返します。
始点の緯度/経度と終点の緯度/経度を入力として受け取り、ステージの設定方法によって、最速または
最短ルートを返します。
国ごとに、Enterprise Routing モジュール -<国> という形式の名前が付けられた固有のデータベースが
あります。各データベースには、固有の国コードも付与されています。例えば、オーストリアのデー
タベースの名前は、"Enterprise Routing モジュール - オーストリア" で、オーストリアのバッチ国コー
ドは "A1T" です。データベースごとに個別のライセンスが必要です。
REST Web サービスガイド
71
Enterprise Tax モジュール
注 : Get Travel Directions は、SOAP Web サービスとしてのみ利用可能です。 Get Travel Directions
を、REST を介して利用することはできません。 Java、C++、C、.NET、または COM API を介
して利用することもできません。
GetTravelDirections は、Enterprise Routing モジュールに含まれています。
Enterprise Tax モジュール
AssignGeoTAXInfo
AssignGeoTAXInfo identifies the tax districts that apply to a given address. Specifically, AssignGeoTAXInfo
returns this information about an address:
•
•
•
•
•
•
•
•
•
•
Latitude/longitude coordinates
FIPS state codes and county codes
County names
MCD/CCD codes and names
CBSA/CSA codes and names
Place codes and names
Incorporated or unincorporated status codes
Cross-reference tax keys
Result indicators
Optionally, the relationship of an address to user-defined polygons
AssignGeoTAXInfo optionally includes enhanced tax jurisdiction information for an address, including:
• Insurance premium districts—Areas designated for the collection of taxes imposed on insurance
policy premiums, based on the policy holder's address. Insurance premium districts are created by
state governments.
• Payroll tax districts—Areas designated for the collection of taxes imposed on employers to support
state or local government facilities and services, based on the employee's and/or employer's address.
Examples include taxes collected for districts to pay for schools, police, or other services. Payroll tax
districts are created by state or local governments.
• Payroll system tax codes—Codes that represent specific jurisdictions that collect payroll tax. Using
payroll system tax codes has advantages over using the payroll tax district information returned by
Assign GeoTAX Info:
• AssignGeoTAXInfo uses an additional database to determine payroll tax codes, resulting in more
accurate payroll tax determination.
• Many payroll systems use specific codes to determine withholding amounts. Since you can customize
the payroll tax codes returned by AssignGeoTAXInfo, you can set up a process where
AssignGeoTAXInfo returns the exact payroll tax codes required by your payroll system, instead of
returning jurisdictional IDs that must then be translated into the codes used by your system.
• Property tax districts—Areas designated for the collection of taxes imposed on property owners to
support local government facilities and services, based on the property's location. Examples include
taxes collected for districts to pay for schools, police, or other services. Property tax districts are created
by local governments.
• Special purpose tax districts—Areas designated for the collection of taxes imposed on residents to
support specialized services for residents of the district, based on the resident's address. Examples
include services such as sewer service, transit service, or water resources. Special purpose tax districts
are created by legislative action, court action, or public referendums. This optional information requires
the use of boundary files which require an additional license. Contact your Pitney Bowes Software
sales representative for more information.
• Sales and Use Tax Rates—Using the optional Pitney Bowes Software Sales and Use Tax Rate file,
AssignGeoTAXInfo can return sales and use tax rates for each of the assigned tax jurisdictions as
well as the total tax rate for the assigned locations.
72
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
AssignGeoTAXInfo is part of the Enterprise Tax Module.
Resource URL
JSON endpoint:
http://server:port/rest/AssignGeoTaxInfo/results.json
XML endpoint:
http://server:port/rest/AssignGeoTaxInfo/results.xml
Example with JSON Response
The following example requests a JSON response:
http://myserver:8080/rest/AssignGeoTAXInfo/results.json?
Data.AddressLine1=1+Global+View&Data.City=Troy&
Data.StateProvince=NY&Data.PostalCode=12180
The JSON returned by this request would be:
{"output_port": [{
"Confidence": "100.0",
"ProcessedBy": "GTX",
"Census.MatchCode": "S",
"Census.MatchLevel": "Street",
"County.Code": "083",
"County.Name": "Rensselaer",
"StateCode": "36",
"LatLong": "42.683028-073.702968",
"LatLong.MatchCode": "R",
"LatLong.MatchLevel": "Rooftop",
"Latitude": "42.683028",
"Longitude": "-073.702969",
"State.Abbreviation": "NY",
"Place.Code": "00000",
"Place.IncorporatedFlag": "Uninc",
"AddressLine1": "1 GLOBAL VW",
"City": "TROY",
"StateProvince": "NY",
"PostalCode": "121808371",
"AddressMatch.MatchCode": "S80",
"AddressMatch.LocationCode": "AS0",
"AddressMatch.LastLine": "TROY,NY 12180-8371"
"AddressMatch.Zip": "12180",
"AddressMatch.Zip4": "8371",
"AddressMatch.GenRC": "S"
"AddressMatch.DataTypeName": "TOMTOM",
"MCD.DistanceToBorder": "000002938",
"Place.DistanceToBorder": "00000000",
"GNISCode": "000000000",
}]}
Example with XML Response
The following example requests an XML response:
http://myserver:8080/rest/AssignGeoTAXInfo/results.xml?
Data.AddressLine1=1+Global+View&Data.City=Troy&
Data.StateProvince=NY&Data.PostalCode=12180
REST Web サービスガイド
73
Enterprise Tax モジュール
The XML returned by this request would be:
<ns2:xml.AssignGeoTAXInfoResponse
xmlns:ns2="http://www.pb.com/spectrum/services/AssignGeoTAXInfo">
<ns2:output_port>
<ns2:Address>
<ns2:Confidence>100.0</ns2:Confidence>
<ns2:ProcessedBy>GTX</ns2:ProcessedBy>
<ns2:Census.MatchCode>S</ns2:Census.MatchCode>
<ns2:Census.MatchLevel>Street</ns2:Census.MatchLevel>
<ns2:County.Code>083</ns2:County.Code>
<ns2:County.Name>Rensselaer</ns2:County.Name>
<ns2:StateCode>36</ns2:StateCode>
<ns2:LatLong>42.683028-073.702968</ns2:LatLong>
<ns2:LatLong.MatchCode>R</ns2:LatLong.MatchCode>
<ns2:LatLong.MatchLevel>Rooftop</ns2:LatLong.MatchLevel>
<ns2:Latitude>42.683028</ns2:Latitude>
<ns2:Longitude>-073.702969</ns2:Longitude>
<ns2:State.Abbreviation>NY</ns2:State.Abbreviation>
<ns2:Place.Code>00000</ns2:Place.Code>
<ns2:Place.IncorporatedFlag>Uninc</ns2:Place.IncorporatedFlag>
<ns2:AddressLine1>1 GLOBAL VW</ns2:AddressLine1>
<ns2:City>TROY</ns2:City>
<ns2:StateProvince>NY</ns2:StateProvince>
<ns2:PostalCode>121808371</ns2:PostalCode>
<ns2:AddressMatch.MatchCode>S80</ns2:AddressMatch.MatchCode>
<ns2:AddressMatch.LocationCode>AS0</ns2:AddressMatch.LocationCode>
<ns2:AddressMatch.LastLine>TROY, NY
12180-8371</ns2:AddressMatch.LastLine>
<ns2:AddressMatch.Zip>12180</ns2:AddressMatch.Zip>
<ns2:AddressMatch.Zip4>8371</ns2:AddressMatch.Zip4>
<ns2:AddressMatch.GenRC>S</ns2:AddressMatch.GenRC>
<ns2:AddressMatch.DataTypeName>TOMTOM</ns2:AddressMatch.DataTypeName>
<ns2:MCD.DistanceToBorder>000002938</ns2:MCD.DistanceToBorder>
<ns2:Place.DistanceToBorder>00000000</ns2:Place.DistanceToBorder>
<ns2:GNISCode>000000000</ns2:GNISCode>
<ns2:LatLong.StreetMatchCode/>
<ns2:LatLong.StreetMatchLevel/>
</ns2:Address>
</ns2:output_port>
</ns2:xml.AssignGeoTAXInfoResponse>
要求
Parameters for Input Data
The following table provides information on the format of AssignGeoTAXInfo input.
表 22 : AssignGeoTAXInfo Input Data
74
Parameter
Format
Description
Data.AddressLine1
String
[100]
First address line
Data.AddressLine2
String
[100]
Second address line
Data.AddressLine2
String
[100]
Third address line
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
Parameter
Format
Description
Data.AddressLine4
String
[100]
Fourth address line
Data.BufferWidth
String
[10]
Specifies the width of the polygon buffers to use for Boundary
File processing. The buffer width is used to determine if a
point is close to the edge of a polygon. The output field
BufferRelation indicates whether or not the point is within the
polygon's buffer area. For more information, see バッファリ
ング（304ページ）.
This field overrides the value specified in the
Option.DefaultBufferWidth parameter. Specify the border
width in the units specified by the Option.DistanceUnits
parameter.
If you do not specify a buffer width in this input field, the
default is used.
Data.CandidateID
String [1] For a multi-match outcome, indicates which match result
should be returned; valid values are 1-9.
Data.City
String
[50]
City name
Data.Country
String
[var]
The country where the address resides. The data you enter
in this field has no impact on processing. It is simply passed
through to output.
注 : AssignGeoTAXInfo only supports US addresses.
Data.FirmName
String
[var]
Company or firm name
Data.PostalCode
String [9] Nine-digit ZIP Code
Data.StateProvince
String
[50]
The state where the address resides. The data you enter in
this field has no impact on processing. It is simply passed
through to output.
Data.UseBufferWidth
Long
[10]
Specifies the width of the polygon buffers to use for
User-Defined Boundary File processing. The buffer width is
used to determine if a point is close to the edge of a polygon.
The output field BufferRelation indicates whether or not the
point is within the polygon's buffer area. For more information,
see バッファリング（304ページ）.
This field overrides the value specified in the
Option.DefaultBufferWidth parameter. Specify the border
width in the units specified by the Option.DistanceUnits
parameter.
If you do not specify a buffer width in this input field, the
default is used.
REST Web サービスガイド
75
Enterprise Tax モジュール
Matching Options
Matching options control the address search methodology and match results handling returned by
AssignGeoTAXInfo. 表 23 : AssignGeoTAXInfo Matching Options （76ページ） lists the address
search and matching options.
表 23 : AssignGeoTAXInfo Matching Options
Parameter
Description
Optional files: The following options enable the database resource(s) to use in the search process.
Option.UseGeoTaxAuxiliaryFile Specifies whether or not AssignGeoTAXInfo should attempt a match
to the GeoTAX Auxiliary file. The GeoTAX Auxiliary file contains new
addresses that have not yet been added to the Master File.
Option.UseAuxiliaryFile
Option.UseStateProvidedFile
Y
Use the GeoTAX Auxiliary file for matching.
N
Do not use the GeoTAX Auxiliary file for matching. (default)
Specifies whether or not AssignGeoTAXInfo should attempt a match
to a User Auxiliary file. User Auxiliary files are user-defined files that
the Enterprise Tax Module uses to override results from the master
files in street-level matching.
Y
Use the User Auxiliary file for matching.
N
Do not use the User Auxiliary file for matching. (default)
Specifies whether or not AssignGeoTAXInfo should attempt a match
to the state-supplied file. Use this option in combination with
FileSearchOrder to specify a state-supplied file to use.
State-supplied files are provided by individual state governments. By
matching to the state-supplied files, you can remain compliant with tax
jurisdiction assignment requirements mandated by new federal and
state laws, such as the Mobile Telecommunications Sourcing Act and
the Florida state Communications Services Tax Simplification Law.
There are two supported file formats: the Florida-native format and the
national TS-158 format (ANSI Transaction Set No. 158). The state of
Florida provides address files in both the TS-158 and its own native
format. The state of Washington provides address data in the TS-158
format.
Assign GeoTAX Info attempts to match to the state supplied file first.
If a state match cannot be found, it attempts a match to the master
files.
Y
Use the State-supplied file for matching.
N
Do not use the State-supplied file for matching. (default)
注 : You must install the appropriate State-supplied file to use these
options. For instructions, see the Spectrum™ Technology
Platform Installation Guide.
Option.FileSearchOrder
Specifies which state-supplied file to use. This option only takes effect
if you specify Option.UseStateProvidedFile=Y. One of the following:
FLOnly
76
Use only the Florida-native formatted file.
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
Parameter
Description
TSOnly
Use only the TS-158 formatted file.
Option.UseRelaxedSecondaryMatching Specifies whether or not AssignGeoTAXInfo matches input addresses
with secondary information to records without secondary information.
This option applies only to Florida-native files.
Y
Use relaxed secondary matching.
N
Do not use relaxed secondary matching. (default)
Address Searching and Matching Options: The following options can be enabled for use in the
address search and match processes.
Option.GsMatchMode
Option.GsSearchArea
Option.GsSearchRadius
Match modes determine the leniency used to make a match between
your input and the reference database. Select a match mode based
on the quality of your input and your desired output. For example, if
you have an input database that is prone to errors, you may want to
select the relaxed match mode.
0 - Exact
Requires a very tight match. This restrictive mode
generates the fewest match candidates, which decreases
the processing time. When using this mode, ensure that
your input is very clean; free of misspellings and
incomplete addresses.
1 - Close
Requires a close match and generates a moderate
number of match candidates. (default)
2Relaxed
Allows a loose match and generates the most match
candidates, which increases the processing time and
results in more multiple matches. Use this mode if you
are not confident that your input is clean; free of
misspellings and incomplete addresses. This is the only
mode that does not respect the street parity when making
an address match.
The search area options allow for searching the address' finance area
or an expanded area specified by distance.
1
Searches the entire finance area for a match. A finance area is
a region defined by the U.S. Postal Service and typically consists
of a set of contiguous ZIP Codes.(default)
2
Searches the area specified by the radius in miles. The search
area can be extended up to a 99-mile radius from the centroid
of the input ZIP Code to assist in finding a match when the input
address contains limited or inaccurate city or ZIP Code
information. The expanded area is confined to within the state's
borders.
Radius for search area.
1-99 miles
Search radius. (default = 25 miles)
Option.GsEnableFirstLetterExpanded Looks for the correct first letter of a street address if the first letter is
missing or incorrect. The Enterprise Tax Module searches through the
alphabet looking for possible correct first letters to complete the street
address.
REST Web サービスガイド
77
Enterprise Tax モジュール
Parameter
Description
注 : This feature is disabled by default and cannot be enabled in
Exact mode.
Y
Enable first letter change matches.
N
Do not allow first letter change matches. (default)
Option.GsEnableRangedAddress Matches to a house range input. Some business locations are identified
by address ranges. For example, a shopping plaza could be addressed
as 10-12 Front St. - this is how business mail is typically addressed to
such a business location. When this feature is enabled, the address
range is geocoded to the interpolated mid-point of the range.
Option.GsAlternateLookup
Y
Allow address range matches.
N
Do not allow address range matches. (default)
This option allows specifying the preferred way to match when both
an address and firm name are provided. The matching method can be
set to match to the address rather than the firm name or vice versa. If
neither are specified, the default matching method is to match to the
address line only.
1
Searches for street name, but if there isn't a match, will use
the firm name.
2
Looks up the firm name, but if there isn't a match, will use
the street name.
3
Searches only street records. (default)
Option.GsMultiMatchResolution A multi-match occurs when multiple equally-scored matches are found
in either the Points or Streets files and cannot be resolved to a single
best candidate. There are several choices for handling a multi-match
outcome:
N
No matches are returned. (default)
R
Return the first match candidate in the list.
A
The information for all the match candidates is returned.
Specifying Default State-Supplied File Options
If you use the Spectrum™ Technology Platform API, note that the value you specify in the Management
Console for the State supplied file field controls the default settings for three AssignGeoTAXInfo API
options: UseStateProvidedFile, UseRelaxedSecondary, and FileSearchOrder. The following table show
how each value in the State supplied file field affects these three options.
"State supplied file" value
78
UseStateProvidedFile FileSearchOrder UseRelaxedSecondary
None
N
N/A
N
Florida-native
Y
FSOnly
N
Florida-native with relaxed
secondary matching
Y
FSOnly
Y
TS-158
Y
TSOnly
N
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
Geocoding Options
Geocoding is the process of determining the latitude/longitude coordinates of a given address. Address
coordinates are used as the basis for determining the tax jurisdictions for an address. Geocoding options
control how AssignGeoTAXInfo determines address latitude/longitude coordinates.
表 24 : AssignGeoTAXInfo Geocoding Options
Parameter
Description
Option.Database.GTX
Select the database resource to use in the geocoding process.
Latitude/Longitude placement: The following options can be set for the geocode result.
Option.LatLongOffset
Indicates the offset distance in feet from the street center line.
オフセット距離は、ジオコードがストリートの中央に位置付け
られるのを防ぐために、ストリートレベルのジオコーディング
で使われます。ストリートレベルのジオコーディングを行うと、
住所が位置するストリートの中心点の緯度/経度が返されますが、
これを補正するのがオフセットです。住所が指し示す建物はス
トリートの真上に建っているわけではないので、路上のポイン
トに相当する住所のジオコードが返されるのは不都合です。ジ
オコードは、ストリートに面して建つ建物の場所を表している
必要があります。例えば、50 フィートのオフセットは、ジオコー
ドがストリートの中心から 50 フィート離れた場所を表すことを
意味します。距離は、住所のストリートセグメントから垂直方
向に計算されます。また、オフセットは、ストリートをはさん
で向かい合う住所が同じポイントになるのを防ぐ目的にも使わ
れます。以下に、オフセットポイントと元のポイントとの比較
図を示します。
Option.Squeeze
REST Web サービスガイド
0
No offset. (default)
20
Twenty feet offset from street center line.
40
Forty feet offset from street center line.
60
Sixty feet offset from street center line.
Specifies if AssignGeoTAXInfo should squeeze the street end
points when determining the geocode of an address in street-level
matching. The squeeze value is 5% (2.5% from each endpoint).
The following diagram compares the end points of a street
segment to the squeezed end points of a street segment.
79
Enterprise Tax モジュール
Parameter
Option.LatLongFormat
Description
Y
Apply squeeze.
N
Do not apply squeeze. (default)
Indicates the desired format for returned latitude/longitude. Options
include:
PreZero
Latitude/longitude in the following format:
090000000N180000000W. (default)
PreZeroDecimal
Latitude/longitude in the following format:
090.000000N180.000000W.
Decimal
Latitude/longitude in the following format:
90.000000-180.000000.
DecimalAssumed Latitude/longitude in the following format:
90000000-180000000.
DegMinSec
Latitude/longitude in the following format: 90
00 00N180 00 00W.
Expanded Geocoding options: The following options enable additional geocoding functionality.
Option.GsEnableAddressPointInterpolation Address point interpolation uses a patented process that improves
upon regular street segment interpolation by inserting point data
into the interpolation process.
注 : This feature is only for use with point-level geocoding.
A match is first attempted using the loaded points data. If an exact
point match is found in the points data, then searching ceases
and the point match is returned. If an exact point match was not
found, the Enterprise Tax Module attempts to find high and low
boundary address points to use for address point interpolation.
Y
Enable address point interpolation.
N
Disable address point interpolation. (default)
Minimum geocode quality:
Option.GsEnableGeographicFallback The default search does not perform a search of geographic
centroids. When enabled, the Geographic Fallback feature locates
the first city, county and/or state centroid, and then matches from
the set of possible matches found.
80
Y
If a definitive match cannot be made, then return the
next higher level geographic centroid.
N
Disable geographic fallback feature. (default)
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
Parameter
Description
Option.GsEnableStreetCentroid
If an input street address cannot be found using the street number
and name, the Enterprise Tax Module then searches the input
ZIP Code or city/state for the closest match. If the Enterprise Tax
Module is able to locate the street, it returns a geocode along the
matched street segment rather than the geocode for the entered
ZIP Code or ZIP + 4.
When using street locator geocoding, if no exact matching house
number is found, a match code of either E029 (no matching range,
single street segment found), or E030 (no matching range, multiple
street segment) returns. For example, if you enter Main St and
there are both an E Main St and a W Main St within the input ZIP
Code, then an E030 returns and the location code returned is
reflective of the input ZIP Code. The location code returned begins
with a 'C' when matched to a single street segment, indicated by
E029. The Enterprise Tax Module does not change the street
name on the output address.
Y
If a street or point match cannot be made, then return
a street level centroid.
N
Do not return a street level centroid if a match cannot
be made. (default)
Boundary matching: The following options can be set when matching to a boundary file such as SPD,
IPD, PAY, Place and MCD or user-defined.
Option.DistanceUnits
Option.DefaultBufferWidth
Specifies the units in which to measure distance. One of the
following:
Miles
Distances are measured in miles.
Km
Distances are measured in kilometers.
Feet
Distances are measured in feet. (default)
Meters
Distances are measured in meters.
Specifies the buffer width to use for tax district boundary files. The
tax district boundary files are the Special Purpose District (SPD)
file, the Insurance Premium District (IPD) file, the Payroll Tax
District (PAY) file, the Personal Property Tax District (PTD) file
and Place and MCD files.
The default buffer width that you specify here can be overridden
on a record-by-record basis using the BufferWidth input field.
For more information on buffers, see バッファリング（304ペー
ジ）.
Option.DefaultUserBufferWidth
Specifies the buffer width to use for user-defined boundary files.
Specify the distance in the units of measurement specified in the
Distance units option. For information on buffers, see バッファ
リング（304ページ）. The default buffer width that you specify
here can be overridden on a record-by-record basis using the
BufferWidth input field.
注 : To use buffers, the user-defined boundary file must support
buffers.
REST Web サービスガイド
81
Enterprise Tax モジュール
Output Data Options
Data options control the data returned by AssignGeoTAXInfo. 表 25 : AssignGeoTAXInfo Data Options
（82ページ） lists the output data options.
表 25 : AssignGeoTAXInfo Data Options
Parameter
Description
Option.GeoTAXOutputRecordType Select one or more of the following to obtain the type of data you want
returned. AssignGeoTAXInfo groups the output fields into record types.
If you do not want all of the fields in a record type returned, do not select
the check box, and list only those fields you want returned in Extra
Output Fields.
•
•
•
•
•
•
•
C—Census
L—Latitude/Longitude
T—Tax Jurisdiction
U—User-defined boundary file
W—Payroll System Tax Codes
X—Auxiliary File
B—PB Software Sales and Use Tax Rate file
You can also specify one, and only one, of the following:
I
Insurance Premium Tax District (IPD)
P
Property Tax District (PTD)
R
Payroll Tax District (PAY)
S
Special Purpose Tax District (SPD)
For a description of the fields in each output group, see Response
（83ページ）.
注 : If you specify W, to obtain the best payroll system tax code match
possible.
Option.TaxKey
Option.TaxRate
82
If you integrate AssignGeoTAXInfo with third-party tax compliance
software from Vertex or Taxware, select which vendor you use. This
controls the value returned in the GeoTAXKey output field. One of the
following:
T
Return the Taxware jurisdiction code for the address.
Y
Return the Vertex jurisdiction code for the address. Select this
option if you obtained a MatchMaster file from Vertex.
V
Return the Vertex jurisdiction code for the address. Select this
option if you obtained a Vertex file from Pitney Bowes
Software.
N
Do not return either the Taxware or Vertex jurisdiction codes
(default).
Indicates the sales and use tax rate type to return or None:
N
Do not return sales and use tax rates. (default)
G
Return the General sales and use tax rates.
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
Parameter
Description
A
Return the Automotive sales and use tax rates.
C
Return the Construction sales and use tax rates.
Return the Medical sales and use tax rates.
Option.OutputFields
Indicates the individual output fields you want returned. You can use
this field instead of the Output Record Type to limit the output to those
fields that are important to your current data needs.
For a list of the fields included in each data type, see Response（83ペー
ジ）.
Output Format
Output format options control how AssignGeoTAXInfo formats output data. The following table lists the
output format options.
表 26 : AssignGeoTAXInfo Output Format Options
Parameter
Description
Option.OutputCasing
Specifies the casing of these output fields: County.Name, CBSA.Name,
MCD.Name, Place.Name, IPDn.DistrictName, PAYn.DistrictName,
SPDn.DistrictName, and PTCn.PayrollDescription.
One of the following:
M
The output in mixed case (default). For example:
Rensselaer.
U
The output in upper case. For example: RENSSELAER.
Response
Result Indicators
The following table lists the results returned from the address matching and geocoding process.
表 27 : Address Matching and Geocoding Status Output Fields
Response Element
Confidence
Max.
Description
Field
Length
(bytes)
4
Indicates the confidence in the output provided; from 0
to 100. The higher the score, the higher the confidence
in the match. Calculated based on the match results for
individual output fields, using the following algorithm:
Census.MatchCode + LatLong.StreetMatchCode +
LatLong.MatchCode
REST Web サービスガイド
83
Enterprise Tax モジュール
Response Element
Max.
Description
Field
Length
(bytes)
The maximum confidence score is 100, so if this
calculation results in a value greater than 100, the
Confidence score is returned as 100.
AssignGeoTAXInfo uses the following values:
• Census.MatchCode
•
•
•
•
•
•
•
Confidence.SurfaceType
AddressMatch.MatchCode
3
5
A = 85
G = 85
S = 85
U = 85
9 = 65
5 = 45
null = 0
Indicates the confidence surface type. Setting a non-zero
buffer width enables confidence generation. To
determine a confidence level, a confidence surface is
first generated. The confidence surface provides the
smallest possible area wherein an address is likely to
be located.
0
Undefined
1
The search failed - the address was not
found.
2
Intersection confidence surface generated.
3
Interpolated street segment.
4
Point-level match.
5
State confidence surface generated.
6
County confidence surface generated.
7
City confidence surface generated.
8
Reserved
9
A ZIP Code confidence surface generated.
10
A ZIP+2 confidence surface generated.
11
A ZIP+4 confidence surface generated.
12
Reserved
13
A street centroid confidence surface
generated.
The Match Code indicates the portions of the address
that matched or did not match to the reference file.
For the list of match codes, see Match Codes.
AddressMatch.GenRC
2
General Return Code indicating the type of match.
5
84
ZIP Code match
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
Response Element
AddressMatch.DataTypeName
Max.
Description
Field
Length
(bytes)
20
9
ZIP+4 Code match
A
User Auxiliary file match
C
Street Centroid match
F
Geographic Fallback match
G
State-supplied file match
I
Intersection match
L
Landmark Auxiliary file match
M
Multiple match (multi-match)
O
Input Latitude/Longitude coordinates match
P
Address point match
S
Street address match
X
Aborted processing or expired database
Blank
Did not match
Indicates the file from which the match was obtained.
One of the following:
•
•
•
•
•
•
•
•
•
•
USPS
TIGER
TOMTOM - Streets
NAVTEQ - Streets
TOMTOM_POINT
CENTRUS_POINT
NAVTEQ_POINT
STATE_FILE
USER_AUXILIARY
LANDMARK_AUXILIARY
AddressMatch.NumCandidates
2
When there are multiple equally-scored matches, returns
the number of multiple match candidates found.
AddressMatch.LocationCode
5
The Location Code indicates the methodology used to
complete the geocode and may also provide some
information about the quality of the geocode.
For the list of location codes, see Location Codes.
LatLong.MatchCode
REST Web サービスガイド
2
Latitude/Longitude General Return Code. Denotes the
level for which the geocode was determined.
2
ZIP + 2 centroid
4
ZIP + 4 Code centroid
B
Block group centroid
C
City centroid
I
Intersection
85
Enterprise Tax モジュール
Response Element
Max.
Description
Field
Length
(bytes)
L
Match using the Landmark Auxiliary file
O
Latitude/longitude was input
R
Address-level based on street address
S
State centroid
T
Census tract centroid
U
Address-level match using the GeoTAX
Auxiliary Database
Z
ZIP Code centroid based on a five-digit ZIP
code
null
No latitude/longitude determined
If the General Return Code (see Result Indicators) is
"P" (point match), then the following are possible values
and have the following meaning:
LatLong.StreetMatchCode
86
2
0
Latitude/Longitude coordinates from User
Dictionary.
2
Latitude/Longitude coordinates from Parcel
Centroid.
4
Latitude/Longitude coordinates from Address
Point.
5
Latitude/Longitude coordinates from Structure
Centroid.
7
Latitude/Longitude coordinates from
manually-placed Point.
8
Latitude/Longitude coordinates from Front Door
Point.
9
Latitude/Longitude coordinates from Driveway
Offset Point.
A
Latitude/Longitude coordinates from Street
Access Point.
B
Latitude/Longitude coordinates from Base
Parcel Point.
Output street address return code.
H
House number not found on street
L
Latitude/longitude not determined on
auxiliary match
S
Street not found in ZIP Code
Z
ZIP Code not found in street address
database
N
Street-level matching option not selected
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
Response Element
Max.
Description
Field
Length
(bytes)
null
The street was successfully matched
Auxiliary File
The following table lists the output fields that contain auxiliary file data. To include auxiliary file data in
the output, set Option.GeoTAXOutputRecordType = X. The following table lists the output fields that
contain tax jurisdiction data.
表 28 : Auxiliary File Output Fields
Response Element
Max.
Description
Field
Length
(bytes)
AuxiliaryData.AuxiliaryFile
301
Data retrieved as a result of an auxiliary match from the
user-defined area of the auxiliary file.
AuxiliaryData.StateFile
201
Data retrieved as a result of a state match. Data content
and format vary depending on the state file used.
Census
The census output fields contains census information from the U.S. Census, including Minor Civil Divisions
(MCDs) and Census County Division (CCD) names and codes. MCDs are the primary political or
administrative divisions of a county, representing many kinds of legal entities with a variety of governmental
and administrative functions. CCDs are established in states where there are no legally established
MCDs. The Census Bureau recognizes MCDs in 28 states and has established CCDs in 21 states. The
District of Columbia has no primary divisions, and the city of Washington, DC is considered equivalent
to an MCD for data presentation purposes.
Census data also contains the Federal Information Processing Standards (FIPS) codes for each state
and county. The FIPS State Code and the FIPS County Code are both used by the Census Bureau to
identify these geographic units.
The following table lists the output fields that contain census data. To include census data in the output,
set Option.GeoTAXOutputRecordType = C.
表 29 : Census Data Output Fields
Response Element
Max.
Description
Field
Length
(bytes)
Census.Block
4
Census Block ID.
Census.BlockGroup
2
Census Block Group code.
Census.MatchCode
2
The level of match obtained against the databases.
REST Web サービスガイド
87
Enterprise Tax モジュール
Response Element
Max.
Description
Field
Length
(bytes)
注 : This field is always included in the output
regardless of whether or not you choose to include
census data in the output.
Census.MatchLevel
19
A
Auxiliary street match
G
State file address match
S
Street address match
U
GeoTAX Auxiliary file match
9
ZIP + 4 Code level match
5
ZIP Code level match
null
Unsuccessful match
The level of match obtained against the databases.
注 : This field is always included in the output
regardless of whether or not you choose to include
census data in the output.
Auxiliary
Auxiliary street match
Aux2
GeoTAX Auxiliary file match
Street
Street address match
Gov
State file address match
ZIP+4
ZIP + 4 Code level match
ZIP
ZIP Code level match
null
No match
Census.Tract
7
Six-digit tract number extracted from the
Census.BlockCode.
County.Code
4
Three-digit Federal Information Processing Standards
(FIPS) county code extracted from the
Census.BlockCode.
注 : This field is always included in the output
regardless of whether or not you choose to include
census data in the output.
County.Name
26
Name of the county.
注 : This field is always included in the output
regardless of whether or not you choose to include
census data in the output.
88
MCD.Code
6
Minor Civil Division/Census County Division (MCD/CCD)
Code.
MCD.Name
41
Minor Civil Division/Census County Division (MCD/CCD)
name.
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
Response Element
MCD.PointStatus
Max.
Description
Field
Length
(bytes)
2
An address can be compared to a Minor Civil Division
(MCD)/county subdivision file (Cousub.txt). This output
field returns the result for a comparison between the
matched address point to the polygon defined by the
Cousub.txb file.
For more information on buffers, see バッファリング
（304ページ）.
注 : The buffer distance for Cousub.txb is internally
set to zero and cannot be modified.
P
The point is in the polygon.
I
The point is in the buffer area inside the
polygon.
B
The point is in the buffer area and outside
of the polygon.
blank
Polygon not found.
MCD.DistanceToBorder
10
Returns the distance in feet between the matched
address point to the polygon defined by the Cousub.txb
file.
MCD.Confidence
4
Provides the percentage overlap of the geocode to the
MCD polygon layer. The returned percentage value
describes the probability that the point falls in the MCD.
CBSA.Code
6
Core Based Statistical Area (CBSA) code.
CBSA.Name
76
Core Based Statistical Area (CBSA) name.
CBSA.MetroFlag
2
Indicates if the CBSA is a "Metropolitan Statistical Area"
or a "Micropolitan Statistical Area".
Y Metropolitan Statistical Area - A Core Based
Statistical Area associated with at least one
urbanized area that has a population of at least
50,000. The Metropolitan Statistical Area comprises
the central county or counties containing the core,
plus adjacent outlying counties having a high
degree of social and economic integration with the
central county as measured through commuting.
N Micropolitan Statistical Area - A Core Based
Statistical Area associated with at least one urban
cluster that has a population of at least 10,000, but
less than 50,000. The Micropolitan Statistical Area
comprises the central county or counties containing
the core, plus adjacent outlying counties having a
high degree of social and economic integration with
the central county as measured through commuting.
CBSAD.Code
REST Web サービスガイド
6
Core Based Statistical Area Division (CBSAD) code.
89
Enterprise Tax モジュール
Response Element
Max.
Description
Field
Length
(bytes)
CBSAD.Name
73
Core Based Statistical Area Division (CBSAD) name.
CSA.Code
4
Combined Statistical Area (CSA) code.
CSA.Name
78
Combined Statistical Area (CSA) name.
State.Abbreviation
3
Two-character state abbreviation.
注 : This field is always included in the output
regardless of whether or not you choose to include
census data in the output
StateCode
3
Two-digit Federal Information Processing Standards
(FIPS) state code extracted from the Census.BlockCode.
注 : This field is always included in the output
regardless of whether or not you choose to include
census data in the output.
Latitude/Longitude
The following table lists the output fields that contain latitude and longitude data. Latitude/Longitude data
contains the coordinates for the address and additional information about how AssignGeoTAXInfo
determined the latitude and longitude. To include latitude/longitude data in the output, set
Option.GeoTAXOutputRecordType = L.
表 30 : Latitude/Longitude Output Fields
Response Element
90
Max.
Description
Field
Length
(bytes)
Latitude
8
Seven-digit number in degrees and calculated to four
decimal places (in the format you specified).
Latitude.Directional
2
Latitude directional.
N
North
S
South
LatLong
23
Returned latitude/longitude, in the format you specified
(up to 22 alphanumeric characters).
LatLong.MatchCode
2
Latitude/Longitude General Return Code. Denotes the
level for which the geocode was determined.
2
ZIP + 2 centroid
4
ZIP + 4 Code centroid
B
Block group centroid
C
City centroid
I
Intersection
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
Response Element
Max.
Description
Field
Length
(bytes)
L
Match using the Landmark Auxiliary file
O
Latitude/longitude was input
R
Address-level based on street address
S
State centroid
T
Census tract centroid
U
Address-level match using the GeoTAX
Auxiliary Database
Z
ZIP Code centroid based on a five-digit ZIP
code
null
No latitude/longitude determined
If the General Return Code (see Result Indicators) is
"P" (point match), then the following are possible values
and have the following meaning:
LatLong.MatchLevel
REST Web サービスガイド
14
0
Latitude/Longitude coordinates from User
Dictionary.
2
Latitude/Longitude coordinates from Parcel
Centroid.
4
Latitude/Longitude coordinates from Address
Point.
5
Latitude/Longitude coordinates from Structure
Centroid.
7
Latitude/Longitude coordinates from
manually-placed Point.
8
Latitude/Longitude coordinates from Front Door
Point.
9
Latitude/Longitude coordinates from Driveway
Offset Point.
A
Latitude/Longitude coordinates from Street
Access Point.
B
Latitude/Longitude coordinates from Base
Parcel Point.
A description of the value returned in the
LatLong.MatchCode field.
ZIP+2
ZIP + 2 centroid
ZIP+4
ZIP + 4 centroid
Block
Block group centroid
CityCentroid
City centroid
Intersection
Intersection match
91
Enterprise Tax モジュール
Response Element
LatLong.StreetMatchCode
Max.
Description
Field
Length
(bytes)
2
LatLong.StreetMatchLevel
LandmarkAux
Match using the Landmark
Auxiliary file
LatLonInput
Input Latitude/Longitude
coordinates was used
Rooftop
Exact address match
StateCentroid
State centroid
Tract
Census tract centroid
Auxiliary
Address-level match using the
GeoTAX Auxiliary Database
ZIP
ZIP Code centroid
Output street address return code.
H
House number not found on street
L
Latitude/longitude not determined on
auxiliary match
S
Street not found in ZIP Code
Z
ZIP Code not found in street address
database
N
Street-level matching option not selected
null
The street was successfully matched
Street level match used to determine the
latitude/longitude
FullMatch
Successful match
HouseNotFound
House number not found on
street
LatLongNotFound Latitude/longitude not determined
on auxiliary match
92
StreetNotFound
Street not found in ZIP Code
ZipNotFound
ZIP Code not found in street
address database
NotUsed
Street-level matching option not
selected
Longitude
8
Seven-digit number in degrees and calculated to four
decimal places (in the format specified).
Longitude.Directional
2
Longitude directional.
E
East
W
West
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
Input Address
AssignGeoTAXInfo always returns the input address as part of the output. The input address fields are
returned as input from the data. AssignGeoTAXInfo does not change these input values.
表 31 : Input Address Output Fields
Response Element
Max.
Description
Field
Length
(bytes)
AddressLine1
101
Input address line 1.
AddressLine2
101
Input address line 2.
AddressLine3
101
Input address line 3.
AddressLine4
101
Input address line 4.
City
51
Input address city.
Country
25
Input address country.
FirmName
101
Input address firm name.
PostalCode
10
Input address postal code
StateProvince
51
Input address state.
Payroll System Tax Code
The following table lists the output fields that contain Payroll System Tax Code (PTC) data. For more
information on payroll tax districts, see AssignGeoTAXInfo（72ページ）. To include this data in the
output, set Option.GeoTAXOutputRecordType = W.
注 : AssignGeoTAXInfo returns up to six payroll tax codes per address.
表 32 : Payroll System Tax Code Output Fields
Response Element
NumberPTCsFound
PTCn.MatchCode
REST Web サービスガイド
Max.
Description
Field
Length
(bytes)
2
The number of payroll tax codes found for this address.
2 per
PTC
Indicates the level of match obtained for the address. In
order from most specific match to least, the possible
match codes are:
P
The address was matched to a specific Payroll
District ID. This is the most specific match.
G
The address was matched to a GNIS Code.
F
The address was matched to a county's FIPS
code.
93
Enterprise Tax モジュール
Response Element
Max.
Description
Field
Length
(bytes)
S
The address was matched to a state's FIPS
code. This is the least specific match.
PTCn.PayrollCode
16 per
PTC
A code that represents a taxing authority in a payroll
application. This is a user-defined code. The specific
codes are determined by the payroll application that
utilizes the data returned by AssignGeoTAXInfo.
PTCn.PayrollDescription
41 per
PTC
A description of the purpose of this payroll code.
PTCn.PayrollFlag
7 per
PTC
A user-defined flag from the PTC database.
StateCounty
33
The state abbreviation and county name.
Tax Jurisdiction
Tax jurisdiction data contains information about the "place" for the location. A "place" is a geographic
area defined on the basis of population criteria that vary by state; or, an area recognized as significant
because it is located in an incorporated municipality. Places are used to determine tax jurisdiction.
The following table lists the output fields that contain tax jurisdiction data. To include tax jurisdiction data
in the output, set Option.GeoTAXOutputRecordType = T.
表 33 : Tax Jurisdiction Output Fields
Response Element
GeoTAXKey
Max.
Description
Field
Length
(bytes)
10
The value in this field varies depending on the option
you specified in the Option.TaxKey option:
If you specified T, GeoTAXKey contains the proprietary
codes used in Taxware tax compliance software. You
can use this code in your Taxware application to find out
the tax rate for the jurisdiction.
If you specified Y or V, GeoTAXKey contains the
®
proprietary Vertex jurisdiction code (comprised of a
®
two-digit Vertex state code, three-digit FIPS county
®
code, and four-digit Vertex city code). You can use this
®
code in your Vertex application to find out the tax rate
for the jurisdiction.
GeoTAXKey.MatchCode
2
Return code denoting the level of match obtained against
the Vertex or Taxware cross reference files.
E
94
Exact match using five fields: FIPS state code,
FIPS county code, FIPS or GNIS place code,
ZIP Code, and FIPS place name.
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
Response Element
GeoTAXKey.MatchLevel
GNISCode
Max.
Description
Field
Length
(bytes)
12
10
P
Partial match using four fields: FIPS state code,
FIPS county code, FIPS or GNIS place code,
and ZIP Code.
A
Alternate match using two fields: ZIP Code,
FIPS place name.
N
Record is default coded based on valid state
code.
null
No matching record found.
A description of the value returned in the
GeoTAXKey.MatchCode field.
Exact
Exact match. See description in
GeoTAXKey.MatchCode.
Partial
Partial match. See description in
GeoTAXKey.MatchCode.
Alternate
Alternate match. See description in
GeoTAXKey.MatchCode.
DefaultCode
Record is default coded. See
description in
GeoTAXKey.MatchCode.
NoMatch
No matching record found.
Unique nine-digit Geographic Names Information System
(GNIS) code.
注 : This field is always included in the output
regardless of whether or not you choose to include
census data in the output.
Place.ClassCode
3
Place class code. Place class codes are used to
determine the proper taxing jurisdictions
注 : This field is always included in the output
regardless of whether or not you choose to include
tax jurisdiction data in the output.
Place.Code
6
An identifier for a specific place. A "place" is a
geographic area defined on the basis of population
criteria that vary by state. Or, an area recognized as
significant because it is located in an incorporated
municipality.
注 : This field is always included in the output
regardless of whether or not you choose to include
tax jurisdiction data in the output.
Place.IncorporatedFlag
REST Web サービスガイド
8
Indicates whether the address is located in an
incorporated or unincorporated place. A "place" is a
geographic area defined on the basis of population
95
Enterprise Tax モジュール
Response Element
Max.
Description
Field
Length
(bytes)
criteria that vary by state. Or, an area recognized as
significant because it is located in an incorporated
municipality.
注 : This field is always included in the output
regardless of whether or not you choose to include
tax jurisdiction data in the output.
Place.LastAnnexedDate
8
Inc
Incorporated place code.
Uninc
Unincorporated place code.
Unknown
Incorporation status unknown.
Last annexed date, in the format MM/YYYY, representing
the month and year of the most recent boundary change
or the most recent available boundary information.
注 : This field is always included in the output
regardless of whether or not you choose to include
tax jurisdiction data in the output.
Place.LastUpdatedDate
8
Last updated date, in the format MM/YYYY, reflecting
the month and year when TomTom updated the
database to reflect attribute (name change, FIPS change,
etc.) or boundary edits to the Place.
注 : This field is always included in the output
regardless of whether or not you choose to include
tax jurisdiction data in the output.
Place.LastVerifiedDate
8
Last verified date, in the format MM/YYYY, representing
the month and year that TomTom verified municipality
change information.
注 : This field is always included in the output
regardless of whether or not you choose to include
tax jurisdiction data in the output.
Place.Name
41
The name of the "place" where the address is located.
A "place" is a geographic area defined on the basis of
population criteria that vary by state. Or, an area
recognized as significant because it is located in an
incorporated municipality.
注 : This field is always included in the output
regardless of whether or not you choose to include
tax jurisdiction data in the output.
Place.PointStatus
2
Returns the result for a comparison between the
matched address point to the polygon defined by the
Place.txb file.
For more information on buffers, see バッファリング
（304ページ）.
96
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
Response Element
Max.
Description
Field
Length
(bytes)
注 : The buffer distance for Place.txb is internally set
to zero and cannot be modified.
P
The point is in the polygon.
I
The point is in the buffer area inside the
polygon.
B
The point is in the buffer area and outside
of the polygon.
blank
Polygon not found.
注 : This field is always included in the output
regardless of whether or not you choose to include
tax jurisdiction data in the output.
Place.DistanceToBorder
10
Returns the distance between the matched address point
to the polygon defined by the Place.txb file.
注 : This field is always included in the output
regardless of whether or not you choose to include
tax jurisdiction data in the output.
Place.Confidence
4
Provides the percentage overlap of the geocode to the
Place polygon layer. The returned percentage value
describes the probability that the point falls in the
specified Place.
注 : This field is always included in the output
regardless of whether or not you choose to include
tax jurisdiction data in the output.
User-Defined Boundary File
The following table lists the output fields that contain data returned from user-defined boundary files. To
include this data in the output, set Option.GeoTAXOutputRecordType = U.
注 : AssignGeoTAXInfo can return up to 10 user-defined areas for each input address.
表 34 : Output Fields for User-Defined Boundary Files
Response Element
NumberUserBoundariesFound
UserBoundaryn.BoundaryDescription
REST Web サービスガイド
Max.
Description
Field
Length
(bytes)
3
The number of user-defined polygons found for the
address.
51 per A description of the polygon.
User
Boundary
97
Enterprise Tax モジュール
Response Element
Max.
Description
Field
Length
(bytes)
UserBoundaryn.BoundaryID
11 per The ID of the polygon as specified in the user-defined
User
boundary file.
Boundary
UserBoundaryn.BufferRelation
2 per Indicates where in the polygon the address resides in
User
relation to the edge of the area.
Boundary
One of the following:
P
The address is inside the polygon at a distance
from the edge that is greater than the specified
buffer width. Buffer width is specified either by the
option or by the input field BufferWidth.
I
The address is inside the polygon but is close to
the edge. This indicates that the address is in the
buffer area specified either by the option or by the
input field BufferWidth.
B
The address is outside the polygon but is close to
the edge. This indicates that the address is in the
buffer area specified either by the option or by the
input field BufferWidth.
For more information, see バッファリング（304ページ）.
UserBoundaryn.DistanceToBorder
10 per Indicates the distance from the address to the border of
User
the polygon. The distance is in the units specified by the
Boundary option.
UserBoundaryn.SupplementalBoundaryID
11 per A supplemental ID as specified in the user-defined
User
boundary file.
Boundary
UserBoundaryn.BoundaryConfidence
4 per Provides the percentage overlap of the geocode to the
User
User-defined boundary polygon layer. The returned
Boundary percentage value describes the probability that the point
falls in the User-defined boundary area.
Insurance Premium Tax District
The following table lists the output fields that contain Insurance Premium Tax District (IPD) data. For
more information on insurance premium tax districts, see AssignGeoTAXInfo（72ページ）. To include
IPD data in the output, set Option.GeoTAXOutputRecordType = I.
注 : AssignGeoTAXInfo returns multiple districts for IPDs, SPDs, PTDs, and PAYs.
98
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
表 35 : Insurance Premium Tax District Output Fields
Response Element
NumberIPDsFound
IPDn.BoundaryBuffer.BufferRelation
Max.
Description
Field
Length
(bytes)
3
2 per
IPD
The number of Insurance Premium Tax Districts found
for the address
Indicates where in the district the address resides in
relation to the edge of the district.
One of the following:
P
The address is inside the district at a distance from
the edge that is greater than the specified buffer
width. Buffer width is specified either by the option
or by the input field BufferWidth.
I
The address is inside the district but is close to the
edge. This indicates that the address is in the
buffer area specified either by the option or by the
input field BufferWidth.
B
The address is outside the district but is close to
the edge. This indicates that the address is in the
buffer area specified either by the option or by the
input field BufferWidth.
For more information, see バッファリング（304ページ）.
IPDn.BoundaryBuffer.DistanceToBorder
10 per
IPD
Indicates the distance from the address to the border of
the district.
IPDn.BoundaryConfidence
4 per
IPD
Provides the percentage overlap of the geocode to the
IPD boundary polygon layer. The returned percentage
value describes the probability that the point falls in the
IPD boundary area.
IPDn.DistrictID
11 per
IPD
IPD ID.
IPDn.DistrictName
61 per
IPD
IPD name.
IPDn.DistrictType
7 per
IPD
IPD district type.
IPDn.UpdateDate
7 per
IPD
IPD update date (MMYYYY).
IPDn.VersionDate
7 per
IPD
IPD compiled date (MMYYYY).
IPDn.Notes
21 per
IPD
Tax code descriptions.
IPDn.ChangeDate
7 per
IPD
IPD change date.
IPDn.EffectiveDate
7 per
IPD
MMDDYY - Identifies when district becomes active State supplied
REST Web サービスガイド
For example: 01, 33, A, B
99
Enterprise Tax モジュール
Response Element
Max.
Description
Field
Length
(bytes)
For example: 010108
IPDn.ExpirationDate
7 per
IPD
MMDDYY - Identifies when district becomes inactive State supplied
For example: 063009
IPDn.FireRate
IPDn.FireFlag
21 per
IPD
Format is dependent on associated flag
6 per
IPD
P - Percentage; .1 = 10%, .0575 = 5.75%
For example: .13, 15.00 or 3;7
F - Flat Fee dollar amount
M - Multiple Percentages has a semi colon as a delimiter.
3;7 = "3% or 7%"
IPDn.CasualtyRate
IPDn.CasualtyFlag
21 per
IPD
Format is dependent on associated flag
6 per
IPD
P - Percentage; .1 = 10%, .0575 = 5.75%
For example: .13, 15.00 or 3;7
F - Flat Fee dollar amount
M - Multiple Percentages has a semicolon as a delimiter.
3;7 = "3% or 7%"
IPDn.VehicleRate
IPDn.VehicleFlag
21 per
IPD
Format is dependent on associated flag
6 per
IPD
P - Percentage; .1 = 10%, .0575 = 5.75%
Possible Values: .13, 15.00 or 3;7
F - Flat Fee dollar amount
M - Multiple Percentages has a semicolon as a delimiter.
3;7 = "3% or 7%"
IPDn.MarineRate
IPDn.MarineFlag
21 per
IPD
Format is dependent on associated flag
6 per
IPD
P - Percentage; .1 = 10%, .0575 = 5.75%
For example: .13, 15.00 or 3;7
F - Flat Fee dollar amount
M - Multiple Percentages has a semicolon as a delimiter.
3;7 = "3% or 7%"
IPDn.HealthRate
IPDn.HealthFlag
21 per
IPD
Format is dependent on associated flag
6 per
IPD
P - Percentage; .1 = 10%, .0575 = 5.75%
For example: .13, 15.00 or 3;7
F - Flat Fee dollar amount
M - Multiple Percentages has a semicolon as a delimiter.
3;7 = "3% or 7%"
IPDn.LifeRate
100
21 per
IPD
Format is dependent on associated flag
For example: .13, 15.00 or 3;7
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
Response Element
IPDn.LifeFlag
Max.
Description
Field
Length
(bytes)
6 per
IPD
P - Percentage; .1 = 10%, .0575 = 5.75%
F - Flat Fee dollar amount
M - Multiple Percentages has a semicolon as a delimiter.
3;7 = "3% or 7%"
IPDn.OtherRate
IPDn.OtherFlag
21 per
IPD
Format is dependent on associated flag
6 per
IPD
P - Percentage; .1 = 10%, .0575 = 5.75%
For example: .13, 15.00 or 3;7
F - Flat Fee dollar amount
M - Multiple Percentages has a semicolon as a delimiter.
3;7 = "3% or 7%"
IPDn.MinimumRate
IPDn.MinimumFlag
21 per
IPD
Format is dependent on associated flag
6 per
IPD
P - Percentage; .1 = 10%, .0575 = 5.75%
Possible Values: .13, 15.00 or 3;7
F - Flat Fee dollar amount
M - Multiple Percentages has a semicolon as a delimiter.
3;7 = "3% or 7%"
Payroll Tax District
The following table lists the output fields that contain Payroll Tax District (PAY) data. For more information
on payroll tax districts, see AssignGeoTAXInfo（72ページ）. To include this data in the output, set
Option.GeoTAXOutputRecordType = R.
注 : AssignGeoTAXInfo returns multiple districts for IPDs, SPDs, PTDs, and PAYs.
表 36 : Payroll Tax District Output Fields
Response Element
NumberPAYsFound
PAYn.BoundaryBuffer.BufferRelation
Max.
Description
Field
Length
(bytes)
3
2 per
PAY
Number of PAYs returned.
Indicates where in the district the address resides in
relation to the edge of the district.
One of the following:
REST Web サービスガイド
P
The address is inside the district at a distance from
the edge that is greater than the specified buffer
width. Buffer width is specified either by the option
or by the input field BufferWidth.
I
The address is inside the district but is close to the
edge. This indicates that the address is in the
101
Enterprise Tax モジュール
Response Element
Max.
Description
Field
Length
(bytes)
buffer area specified either by the option or by the
input field BufferWidth.
B
The address is outside the district but is close to
the edge. This indicates that the address is in the
buffer area specified either by the option or by the
input field BufferWidth.
For more information, see バッファリング（304ページ）.
PAYn.BoundaryBuffer.DistanceToBorder
10 per
PAY
Indicates the distance from the address to the border of
the district. The distance is in the units specified by the
option.
PAYn.BoundaryConfidence
4 per
PAY
Provides the percentage overlap of the geocode to the
PAY boundary polygon layer. The returned percentage
value describes the probability that the point falls in the
PAY boundary area.
PAYn.DistrictID
11 per
PAY
PAY district ID.
PAYn.DistrictName
61 per
PAY
PAY district name.
PAYn.DistrictType
7 per
PAY
PAY district type.
PAYn.ID
11 per
PAY
PAY ID.
PAYn.MunicipalEMSTax
2 per
PAY
PAY municipality emergency municipal services tax.
The values for Pennsylvania are:
Y
Levies the tax
N
Does not levy the tax
All other states are null.
PAYn.MunicipalIncomeTax
2 per
PAY
PAY municipality income tax.
The values for Pennsylvania are:
R
Resident
N
Non-resident
B
Both
X
None
All other states are null.
PAYn.SchoolDistrictEMSTax
102
2 per
PAY
PAY school district emergency municipal services tax.
The Values for Pennsylvania are:
Y
Levies the tax
N
Does not levy the tax
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
Response Element
Max.
Description
Field
Length
(bytes)
All other states are null.
PAYn.SchoolDistrictIncomeTax
2 per
PAY
PAY school district income tax.
The values for Pennsylvania are:
R
Resident
N
Non-resident
B
Both
X
N
The values for Ohio are:
R
Resident
X
None
All other states are null.
Property Tax District
The following table lists the output fields that contain Property Tax District (PTD) data. For more information
on property tax districts, see AssignGeoTAXInfo（72ページ）. To include this data in the output, set
Option.GeoTAXOutputRecordType = P.
注 : AssignGeoTAXInfo returns multiple districts for IPDs, SPDs, PTDs, and PAYs.
表 37 : Property Tax District Output Fields
Response Element
NumberPTDsFound
PTDn.BoundaryBuffer.BufferRelation
Max.
Description
Field
Length
(bytes)
3
2 per
PTD
Number of PTDs returned.
Indicates where in the district the address resides in
relation to the edge of the district.
One of the following:
REST Web サービスガイド
P
The address is inside the district at a distance from
the edge that is greater than the specified buffer
width. Buffer width is specified either by the option
or by the input field BufferWidth.
I
The address is inside the district but is close to the
edge. This indicates that the address is in the
buffer area specified either by the option or by the
input field BufferWidth.
B
The address is outside the district but is close to
the edge. This indicates that the address is in the
buffer area specified either by the option or by the
input field BufferWidth.
103
Enterprise Tax モジュール
Response Element
Max.
Description
Field
Length
(bytes)
For more information, see バッファリング（304ページ）.
PTDn.BoundaryBuffer.DistanceToBorder
10 per
PTD
Indicates the distance from the address to the border of
the district. The distance is in the units specified by the
option.
PTDn.BoundaryConfidence
4 per
PTD
Provides the percentage overlap of the geocode to the
PTD boundary polygon layer. The returned percentage
value describes the probability that the point falls in the
PTD boundary area.
PTDn.DistrictID
11 per
PTD
PTD district ID.
PTDn.DistrictName
61 per
PTD
PTD district name.
PTDn.DistrictType
2 per
PTD
PTD district type. Only returned for Indiana.
R
Reporting district
B
Billing district
PTDn.JurisdictionID
11 per
PTD
PTD jurisdiction ID.
PTDn.UpdateDate
7 per
PTD
PTD update date.
Special Purpose Tax District
The following table lists the output fields that contain Special Purpose Tax District (SPD) data. For more
information on special purpose tax districts, see AssignGeoTAXInfo（72ページ）. To include this data
in the output, set Option.GeoTAXOutputRecordType = S.
注 : AssignGeoTAXInfo returns multiple districts for IPDs, SPDs, PTDs, and PAYs.
表 38 : Special Purpose Tax District Output Fields
Response Element
NumberSPDsFound
SPDn.BoundaryBuffer.BufferRelation
Max.
Description
Field
Length
(bytes)
3
2 per
SPD
Number of SPDs returned.
Indicates where in the district the address resides in
relation to the edge of the district.
One of the following:
P
104
The address is inside the district at a distance from
the edge that is greater than the specified buffer
width. Buffer width is specified either by the option
or by the input field BufferWidth.
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
Response Element
Max.
Description
Field
Length
(bytes)
I
The address is inside the district but is close to the
edge. This indicates that the address is in the
buffer area specified either by the option or by the
input field BufferWidth.
B
The address is outside the district but is close to
the edge. This indicates that the address is in the
buffer area specified either by the option or by the
input field BufferWidth.
For more information, see バッファリング（304ページ）.
SPDn.BoundaryBuffer.DistanceToBorder
10 per
SPD
Indicates the distance from the address to the border of
the district. The distance is in the units specified by the
option.
SPDn.BoundaryConfidence
4 per
SPD
Provides the percentage overlap of the geocode to the
SPD boundary polygon layer. The returned percentage
value describes the probability that the point falls in the
SPD boundary area.
SPDn.CompiledDate
7 per
SPD
SPD compiled date.
SPDn.DistrictCode
4 per
SPD
3-digit district type code.
SPDn.DistrictName
61 per
SPD
SPD name.
SPDn.DistrictNumber
6 per
SPD
SPD district number.
SPDn.EffectiveDate
7 per
SPD
SPD effective date.
SPDn.UpdateDate
7 per
SPD
SPD update date.
SPDn.VersionDate
7 per
SPD
SPD version date.
Sales and Use Tax Rates
The following table lists the output fields that contain the sales and use tax rate data.
To include tax rate data in the output, set Option.GeoTAXOutputRecordType = B.
To select the tax rate type, set Option.TaxRate to one of the following:
N
Do not return sales and use tax rates. (default)
G
Return the General sales and use tax rates.
A
Return the Automotive sales and use tax rates.
C
Return the Construction sales and use tax rates.
M
Return the Medical sales and use tax rates.
REST Web サービスガイド
105
Enterprise Tax モジュール
注 : You must be a licensed user of the Pitney Bowes Software Sales and Use Tax Rate file to use this
feature.
表 39 : Sales and Use Tax Rate Output Fields
Response Element
TaxRate.RC
Max.
Description
Field
Length
(bytes)
2
Tax Rate return code denoting the level of match
obtained agained the Pitney Bowes Software Sales and
Use Tax Rate file:
E
Exact match, using all 5 fields
P
Partial match, using 4 fields
A
Alternate match, using 3 fields
N
Record is default-coded based on valid
state code.
Blank
No matching PB Software Sales and Use
Tax Rate record found.
Municipal.SalesTaxRate
11
Municipality sales tax rate for the selected tax rate type.
County.SalesTaxRate
11
County sales tax rate for the selected tax rate type.
State.SalesTaxRate
11
State sales tax rate for the selected tax rate type.
SPDn.SalesTaxRate
11 per
SPD
TaxRate.SalesTotal
11
The sum of the individual Municipal, County, State and
SPD sales tax rates.
Municipal.UseTaxRate
11
Municipality use tax rate for the selected tax rate type.
County.UseTaxRate
11
County use tax rate for the selected tax rate type.
State.UseTaxRate
11
State use tax rate for the selected tax rate type.
SPDn.UseTaxRate
11 per
SPD
Use tax rate for up to 10 Special Purpose Districts (SPD).
TaxRate.UseTotal
11
The sum of the individual Municipal, County, State and
SPD use tax rates.
Sales tax rate for up to 10 Special Purpose Districts
(SPD).
Error Reporting
The following table defines the error reporting output fields.
106
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
表 40 : Error Output Fields
Response Element
GTX.ErrorCode
Max.
Description
Field
Length
(bytes)
3
This field contains a return code if the GeoTAX engine
experiences an abnormal termination.
注 : This field contains the same set of codes returned
by the standalone GeoTAX software and is
intended for users who have migrated from
GeoTAX to Spectrum™ Technology Platform.
The first character indicates the file (or set of files
affected).
Blank
Matcher terminated normally
A
User Auxiliary file problem
CE
coubsub.txb file problem
CI
Confidence engine problem
D
Boundary file
F
User-defined boundary file problem
G
Address Matching engine problem
L
Licensing problem
S
State file problem
U
GeoTAX Auxiliary file problem
X
Combination of Street and state file
problem
Z
zip.gsb file problem
The second position is one of the following:
GTX.ErrorDescription
81
E
Fatal issue, program terminating
F
Expired database
I
Informational
If the GeoTAX engine experiences an abnormal
termination, this field contains a text description of the
reason. It is blank if GeoTAX terminated normally.
注 : This field contains the same set of descriptions
returned by the standalone GeoTAX software and
is intended for users who have migrated from
GeoTAX to Spectrum™ Technology Platform.
SI-"TS158 FILES NOT FOUND"
SI-"TS158 FILES VINTAGE OR INCOMPLETE DB
ERROR"
SI-"STATE FILES NOT FOUND"
SE-"STATE AND TS158 FILES NOT FOUND"
SE-"STATE NOT FOUND AND TS158 VINTAGE
REST Web サービスガイド
107
Enterprise Tax モジュール
Response Element
Max.
Description
Field
Length
(bytes)
ERROR"
SI-"STATE FILES VINTAGE OR INCOMPLETE DB
ERROR"
SE-"STATE VINTAGE ERROR AND TS158 NOT
FOUND"
SE-"STATE AND TS158 FILES VINTAGE OR
INCOMPLETE DB ERROR"
GI-"STREET FILES NOT FOUND"
XI-"STREET AND TS158 FILES NOT FOUND"
XI-"STREET NOT FOUND AND TS158 FILES VINTAGE
ERROR"
XI-"STREET AND STATE FILES NOT FOUND"
XE-"STREET STATE AND TS158 FILES NOT FOUND"
XE-"STREET AND STATE NOT FOUND AND TS158
VINTAGE ERROR"
XI-"STREET NOT FOUND AND STATE VINTAGE
ERROR"
XE-"STREET AND TS158 NOT FOUND AND STATE
VINTAGE ERROR"
XE-"STREET NOT FOUND AND STATE AND TS158
VINTAGE ERROR"
GI-"STREET FILES VINTAGE OR INCOMPLETE DB
ERROR"
XI-"STREET VINTAGE ERROR AND TS158 NOT
FOUND"
XI-"STREET AND TS158 FILES VINTAGE OR
INCOMPLETE DB ERROR"
XI-"STREET VINTAGE ERROR AND STATE NOT
FOUND"
XE-"STREET VINTAGE ERROR AND STATE AND
TS158 NOT FOUND"
XE-"STREET AND TS158 VINTAGE ERROR AND
STATE NOT FOUND"
XI-"STREET AND STATE FILES VINTAGE OR
INCOMPLETE DB ERROR"
XE-"STREET AND STATE VINTAGE ERROR AND
TS158 NOT FOUND"
XE-"STREET STATE AND TS158 VINTAGE ERROR"
LF-"INVALID FUNCTION PASSED TO GTDBLIO : "
AI-"GENIO ERROR: FILE = G1GTAUX , FUNC = , ST
="
UI-"GENIO ERROR: FILE = G1GTAX2 , FUNC = , ST
="
XF-"The (DB Vintage) database has expired!"
XF-"The (SPD file Vintage) SPD File has expired!"
DI- "UNABLE TO VALIDATE BOUNDARY LICENSE"
DI- "UNABLE TO OPEN BOUNDARY FILE"
DI- "BOUNDARY FILE NOT FOUND"
FI- "UNABLE TO VALIDATE USER BOUNDARY
LICENSE"
FI- "UNABLE TO OPEN USER BND FILE"
FI- "USER BND FILE NOT FOUND"
108
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
Response Element
GTX.WarnCode
Max.
Description
Field
Length
(bytes)
3
This field contains warning codes returned by the
GeoTAX engine. It is blank if no warnings were issued.
A value of WN indicates a database will expire next
month.
注 : This field contains the same set of codes returned
by the standalone GeoTAX software and is
intended for users who have migrated from
GeoTAX to Spectrum™ Technology Platform.
GTX.WarnDescription
81
A text description of any warnings returned by the
GeoTAX engine.
注 : This field contains the same set of descriptions
returned by the standalone GeoTAX software and
is intended for users who have migrated from
GeoTAX to Spectrum™ Technology Platform.
Status
2
Reports the success or failure of the match attempt.
null
Success
F
Failure. Some examples of failures are your
license expired or you did not select any
output record types and fields for
AssignGeoTAXInfo to return.
Status.Code
12
If AssignGeoTAXInfo could not process the address,
this field will show the reason. Currently there is one
possible value for this field: Invalid Address.
Status.Description
64
If AssignGeoTAXInfo could not process the address,
this field will show a description of the failure. One of the
following:
TS158 FILES NOT FOUND
TS158 FILES VINTAGE OR INCOMPLETE DB ERROR
STATE FILES NOT FOUND
STATE AND TS158 FILES NOT FOUND
STATE NOT FOUND AND TS158 VINTAGE ERROR
STATE FILES VINTAGE OR INCOMPLETE DB ERROR
STATE VINTAGE ERROR AND TS158 NOT FOUND
STATE AND TS158 FILES VINTAGE OR INCOMPLETE
DB ERROR
STREET FILES NOT FOUND
STREET AND TS158 FILES NOT FOUND
STREET NOT FOUND AND TS158 FILES VINTAGE
ERROR
STREET AND STATE FILES NOT FOUND
STREET STATE AND TS158 FILES NOT FOUND
STREET AND STATE NOT FOUND AND TS158
VINTAGE ERROR
STREET NOT FOUND AND STATE VINTAGE ERROR
STREET AND TS158 NOT FOUND AND STATE
REST Web サービスガイド
109
Enterprise Tax モジュール
Response Element
Max.
Description
Field
Length
(bytes)
VINTAGE ERROR
STREET NOT FOUND AND STATE AND TS158
VINTAGE ERROR
STREET FILES VINTAGE OR INCOMPLETE DB
ERROR
STREET VINTAGE ERROR AND TS158 NOT FOUND
STREET AND TS158 FILES VINTAGE OR
INCOMPLETE DB ERROR
STREET VINTAGE ERROR AND STATE NOT FOUND
STREET VINTAGE ERROR AND STATE AND TS158
NOT FOUND
STREET AND TS158 VINTAGE ERROR AND STATE
NOT FOUND
STREET AND STATE FILES VINTAGE OR
INCOMPLETE DB ERROR
STREET AND STATE VINTAGE ERROR AND TS158
NOT FOUND
STREET STATE AND TS158 VINTAGE ERROR
INVALID FUNCTION PASSED TO GTDBLIO :
GENIO ERROR: FILE = G1GTAUX , FUNC = , ST =
GENIO ERROR: FILE = G1GTAX2 , FUNC = , ST =
The (DB Vintage) database has expired!
The (SPD file Vintage) SPD File has expired!
UNABLE TO VALIDATE BOUNDARY LICENSE
UNABLE TO OPEN BOUNDARY FILE
BOUNDARY FILE NOT FOUND
UNABLE TO VALIDATE USER BOUNDARY LICENSE
UNABLE TO OPEN USER BND FILE
USER BND FILE NOT FOUND
CalculateDistance
CalculateDistance takes two sets of latitude/longitude coordinates as input, calculates the distance
between the coordinates, and returns the distance between the two points.
CalculateDistance is part of the Enterprise Tax Module.
Resource URL
JSON endpoint:
http://server:port/rest/CalculateDistance/results.json
XML endpoint:
http://server:port/rest/CalculateDistance/results.xml
110
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
Example with JSON Response
The following example requests a JSON response:
http://myserver:8080/rest/CalculateDistance/results.json?
Data.SecondLatitude=41.881833&Option.LatLongFormat=Decimal&
Data.SecondLongitude=-87.785587&Data.FirstLatitude=41.857333&
Data.FirstLongitude=-88.325183
The JSON returned by this request would be:
{"output_port": [{
"Distance": "27.799",
"user_fields": []
}]}
Example with XML Response
The following example requests an XML response:
http://myserver:8080/rest/CalculateDistance/results.xml?
Data.SecondLatitude=41.881833&Option.LatLongFormat=Decimal&
Data.SecondLongitude=-87.785587&Data.FirstLatitude=41.857333&
Data.FirstLongitude=-88.325183
The XML returned by this request would be:
<ns2:xml.CalculateDistanceResponse
xmlns:ns2="http://www.pb.com/spectrum/services/CalculateDistance">
<ns2:output_port>
<ns2:Result>
<ns2:Distance>27.799</ns2:Distance>
<ns2:user_fields/>
</ns2:Result>
</ns2:output_port>
</ns2:xml.CalculateDistanceResponse>
要求
Parameters for Input Data
CalculateDistance takes latitude and longitude information as input.
表 41 : CalculateDistance Input Data
Parameter
Description
Data.FirstLatitude
Latitude of the first point for which you want distance returned.
Data.FirstLatitude.Directional First latitude directional.
Data.FirstLongitude
N
North
S
South
Longitude of the first point for which you want distance returned.
Data.FirstLongitude.Directional First longitude directional.
REST Web サービスガイド
E
East
W
West
111
Enterprise Tax モジュール
Parameter
Description
Data.SecondLatitude
Latitude of the second point for which you want distance returned.
Data.SecondLatitude.Directional Second latitude directional.
Data.SecondLongitude
N
North
S
South
Longitude of the second point for which you want distance returned.
Data.SecondLongitude.Directional Second longitude directional.
E
East
W
West
Parameters for Options
表 42 : Output Data and Format Options
Parameter
Description
Option.LatLongFormat
Indicates the format of the input latitude/longitude. The options are:
Option.ReturnUnits
DegMinSec
For example 90 00 00N180 00 00W.
PreZero
(090000000N180000000W). Default.
PreZeroDecimal
(090.000000N180.000000W)
Decimal
(90.000000-180.000000)
DecimalAssumed
(90000000-180000000)
Indicates the measurement units returned for distance calculation:
•
•
•
•
Miles
Km
Feet
Meters
Response
CalculateDistance always returns the Confidence field to indicate the confidence in the output provided.
If CalculateDistance fails to process the data, it returns the fields Status, Status.Code, and
Status.Descriptions. These fields provide information on why CalculateDistance failed to process the
data. Some examples of failures are your license expired or you did not select any output record types
and fields for CalculateDistance to return. The following table provides the record-level qualifiers and
data outputs for CalculateDistance.
112
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
表 43 : CalculateDistance Output Fields
Response Element
Max.
Description
Field
Length
(bytes)
Distance
9
Distance between the two input coordinates in the units
of measurement that you specified.
Status
2
Reports the success or failure of the match attempt:
null
Success
F
Failure
Status.Code
2
Reason for failure or error. If Status = F, Status.Code =
Failure.
Status.Description
64
Description of the problem. If Status = F,
Status.Description = Unable to compute distance.
ReverseGeoTAXInfoLookup
ReverseGeoTAXInfoLookup allows latitude/longitude coordinates to be supplied as input and identifies
the tax districts that apply to the given coordinate. Specifically, ReverseGeoTAXInfoLookup can return
the following information about a location:
•
•
•
•
•
•
•
•
FIPS state codes and county codes
State and county names
MCD codes and names
Place codes and names
Boundary file districts
Cross-reference tax keys
The relationship of the input coordinates to user-defined polygons
Sales and use tax rates, if licensed for the Pitney Bowes Software Sales and Use Tax Rate File
ReverseGeoTAXInfoLookup optionally includes enhanced tax jurisdiction information for a location,
including:
• Insurance premium districts—Areas designated for the collection of taxes imposed on insurance
policy premiums, based on the policy holder's address. Insurance premium districts are created by
state governments.
• Payroll tax districts—Areas designated for the collection of taxes imposed on employers to support
state or local government facilities and services, based on the employee's and/or employer's address.
Examples include taxes collected for districts to pay for schools, police, or other services. Payroll tax
districts are created by state or local governments.
• Payroll system tax codes—Codes that represent specific jurisdictions that collect payroll tax. Using
payroll system tax codes has advantages over using the payroll tax district information returned by
ReverseGeoTAXInfoLookup:
• ReverseGeoTAXInfoLookup uses an additional database to determine payroll tax codes, resulting
in more accurate payroll tax determination.
• Many payroll systems use specific codes to determine withholding amounts. Since you can customize
the payroll tax codes returned by ReverseGeoTAXInfoLookup, you can set up a process where
ReverseGeoTAXInfo Lookup returns the exact payroll tax codes required by your payroll system,
instead of returning jurisdictional IDs that must then be translated into the codes used by your system.
• Property tax districts—Areas designated for the collection of taxes imposed on property owners to
support local government facilities and services, based on the property's location. Examples include
REST Web サービスガイド
113
Enterprise Tax モジュール
taxes collected for districts to pay for schools, police, or other services. Property tax districts are created
by local governments.
• Special purpose tax districts—Areas designated for the collection of taxes imposed on residents to
support specialized services for residents of the district, based on the resident's address. Examples
include services such as sewer service, transit service, or water resources. Special purpose tax districts
are created by legislative action, court action, or public referendums. This optional information requires
the use of boundary files which require an additional license. Contact your Pitney Bowes Software
sales representative for more information.
Using the optional Pitney Bowes Software Sales and Use Tax Rate file, ReverseGeoTAXInfoLookup
includes tax rate data for a location, including:
Tax rate type:
•
•
•
•
General
Automotive
Medical
Construction
Sales and/or use tax rates for:
•
•
•
•
•
State
County
Municipality
Up to 10 SPDs
Total Rate - the sum of the individual state, county, municipality and SPD rates.
Required input format
The required format for the input coordinates is as follows:
表 44 : Required Input Latitude/Longitude Format
Response Element
Format
Data.InputLatitude
00.000000 or without the decimal point 00000000
Data.InputLongitude
000.000000 or without the decimal point 000000000, or
00.000000 or without the decimal point 00000000
ReverseGeoTAXInfoLookup is part of the Enterprise Tax Module.
Resource URL
JSON endpoint:
http://server:port/rest/ReverseGeoTAXInfoLookup/results.json
XML endpoint:
http://server:port/rest/ReverseGeoTAXInfoLookup/results.xml
Example with JSON Response
The following example requests a JSON response:
http://myserver:8080/rest/ReverseGeoTAXInfoLookup/results.json
?Data.InputLatitude=40.018998&Data.InputLongitude=-105.239580
114
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
The JSON returned by this request would be:
{"output_port": [{
"Confidence": "100.0",
"ProcessedBy": "GTX",
"County.Code": "013",
"County.Name": "Boulder",
"StateCode": "08",
"InputLatitude": "40.018998",
"InputLongitude": "-105.239580",
"State.Abbreviation": "CO",
"Place.ClassCode": "C1",
"Place.Code": "07850",
"Place.IncorporatedFlag": "Inc",
"Place.Name": "Boulder",
"Place.LastAnnexedDate": "10/2011",
"Place.LastUpdatedDate": "04/2013",
"Place.LastVerifiedDate": "01/2013",
"Place.DistanceToBorder": "000000387",
"Place.PointStatus": "P",
"GNISCode": "002409883",
"GTX.ErrorCode": "",
"GTX.ErrorDescription": "",
"GTX.WarnCode": "",
"GTX.WarnDescription": ""
}]}
Example with XML Response
The following example requests an XML response:
http://myserver:8080/rest/ReverseGeoTAXInfoLookup/results.xml
?Data.InputLatitude=40.018998&Data.InputLongitude=-105.239580
The XML returned by this request would be:
ns2:xml.ReverseGeoTAXInfoLookup
xmlns:ns2="http://www.pb.com/spectrum/services/ReverseGeoTAXInfoLookup">
<ns2:output_port>
<ns2:Address>
<ns2:Confidence>100.0</ns2:Confidence>
<ns2:ProcessedBy>GTX</ns2:ProcessedBy>
<ns2:County.Code>013</ns2:County.Code>
<ns2:County.Name>Boulder</ns2:County.Name>
<ns2:StateCode>08</ns2:StateCode>
<ns2:InputLatitude>40.018998</ns2:InputLatitude>
<ns2:InputLongitude>-105.239580</ns2:InputLongitude>
<ns2:State.Abbreviation>CO</ns2:State.Abbreviation>
<ns2:Place.ClassCode>C1</ns2:Place.ClassCode>
<ns2:Place.Code>07850</ns2:Place.Code>
<ns2:Place.IncorporatedFlag>Inc</ns2:Place.IncorporatedFlag>
<ns2:Place.Name>Boulder</ns2:Place.Name>
<ns2:Place.LastAnnexedDate>10/2011</ns2:Place.LastAnnexedDate>
<ns2:Place.LastUpdatedDate>04/2013</ns2:Place.LastUpdatedDate>
<ns2:Place.LastVerifiedDate>01/2013</ns2:Place.LastVerifiedDate>
<ns2:Place.DistanceToBorder>000000387</ns2:Place.DistanceToBorder>
<ns2:Place.PointStatus>P</ns2:Place.PointStatus>
<ns2:GNISCode>002409883</ns2:GNISCode>
<ns2:GTX.ErrorCode>""</ns2:GTX.ErrorCode>
<ns2:GTX.ErrorDescription>""</ns2:GTX.ErrorDescription>
<ns2:GTX.WarnCode>""</ns2:GTX.WarnCode>
<ns2:GTX.WarnDescription>""</ns2:GTX.WarnDescription>
</ns2:Address>
</ns2:output_port>
</ns2:xml.ReverseGeoTAXInfoLookup>
REST Web サービスガイド
115
Enterprise Tax モジュール
要求
Geocoding Options
Reverse geocoding information lookup is the process of taking an input latitude/longitude coordinate
and returning jurisdictional tax information. The geocoding options define the database to use for matching
and specify the distance units and buffer distance to use when matching to a boundary file.
表 45 : ReverseGeoTAXInfoLookup Geocoding Options
Parameter
Description
Option.Database.GTX
Select the database resource to use in the reverse geocoding lookup
process.
Boundary matching: The following options can be set when matching to a boundary file such as SPD,
IPD, PAY, Place and MCD, or user-defined.
Option.DistanceUnits
Option.DefaultBufferWidth
Specifies the units in which to measure distance. One of the following:
Feet
Distances are measured in feet. (Default)
Km
Distances are measured in kilometers.
Meters
Distances are measured in meters.
Miles
Distances are measured in miles.
Specifies the buffer width to use for tax district boundary files. The tax
district boundary files are the Special Purpose District (SPD) file, the
Insurance Premium District (IPD) file, the Payroll Tax District (PAY) file,
the Personal Property Tax District (PTD) file, Place and MCD files.
The default buffer width that you specify here can be overridden on a
record-by-record basis using the BufferWidth input field.
For more information on buffers, see バッファリング（304ページ）.
Option.DefaultUserBufferWidth Specifies the buffer width to use for user-defined boundary files. Specify
the distance in the units of measurement specified in the Distance units
option. For information on buffers, see バッファリング（304ページ）.
The default buffer width that you specify here can be overridden on a
record-by-record basis using the BufferWidth input field.
注 : To use buffers, the user-defined boundary file must support
buffers.
Output Data Options
Data options control the data returned by ReverseGeoTAXInfoLookup. 表 46 : ReverseGeoTAXInfo
Lookup Data Options （116ページ） lists the output data options.
表 46 : ReverseGeoTAXInfo Lookup Data Options
Parameter
Description
Option.GeoTAXOutputRecordType Select one or more of the following to obtain the type of data you want
returned. ReverseGeoTAXInfo Lookup groups the output fields into
116
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
Parameter
Description
record types. If you do not want all of the fields in a record type returned,
do not select the check box, and list only those fields you want returned
in Extra Output Fields.
•
•
•
•
•
•
C—Census
T—Tax Jurisdiction
U—User-defined boundary file
W—Payroll System Tax Codes
X—Auxiliary File
B—PB Software Sales and Use Tax Rate file
You can also specify one, and only one, of the following:
I
Insurance Premium Tax District (IPD)
P
Property Tax District (PTD)
R
Payroll Tax District (PAY)
S
Special Purpose Tax District (SPD)
For a description of the fields in each output group, see Response
（118ページ）.
注 : If you specify W, to obtain the best payroll system tax code match
possible.
Option.TaxKey
Option.TaxRate
If you integrate ReverseGeoTAXInfo Lookup with third-party tax
compliance software from Vertex or Taxware, select which vendor you
use. This controls the value returned in the GeoTAXKey output field.
One of the following:
T
Return the Taxware jurisdiction code for the address.
Y
Return the Vertex jurisdiction code for the address. Select this
option if you obtained a MatchMaster file from Vertex.
V
Return the Vertex jurisdiction code for the address. Select this
option if you obtained a Vertex file from Pitney Bowes
Software.
N
Do not return either the Taxware or Vertex jurisdiction codes
(default).
Select the desired Sales tax rate type or None:
N
Do not return sales tax rates. (default)
G
Return the General sales tax rates.
A
Return the Automotive sales tax rates.
C
Return the Construction sales tax rates.
Return the Medical sales tax rates.
Option.OutputFields
Indicates the individual output fields you want returned. You can use
this field instead of the Output Record Type to limit the output to those
fields that are important to your current data needs.
For a list of the fields included in each data type, see Response（118ペー
ジ）.
REST Web サービスガイド
117
Enterprise Tax モジュール
Output Format
Output format options control how ReverseGeoTAXInfo Lookup formats output data. The following table
lists the output format options.
表 47 : ReverseGeoTAXInfoLookup Output Format Options
Parameter
Description
Option.OutputCasing
Specifies the casing of these output fields: County.Name, MCD.Name,
Place.Name, IPDn.DistrictName, PAYn.DistrictName,
SPDn.DistrictName, and PTCn.PayrollDescription.
One of the following:
M
The output in mixed case (default). For example: Boulder.
U
The output in upper case. For example: BOULDER.
Response
Auxiliary File
The following table lists the output fields that contain auxiliary file data. To include auxiliary file data in
the output, set Option.GeoTAXOutputRecordType = X. The following table lists the output fields that
contain tax jurisdiction data.
表 48 : Auxiliary File Output Fields
Response Element
Max.
Description
Field
Length
(bytes)
AuxiliaryData.AuxiliaryFile
301
Data retrieved as a result of an auxiliary match from the
user-defined area of the auxiliary file.
AuxiliaryData.StateFile
201
Data retrieved as a result of a state match. Data content
and format vary depending on the state file used.
Census
The census output fields contains census information from the U.S. Census, including Minor Civil Divisions
(MCDs) and Census County Division (CCD) names and codes. MCDs are the primary political or
administrative divisions of a county, representing many kinds of legal entities with a variety of governmental
and administrative functions. CCDs are established in states where there are no legally established
MCDs. The Census Bureau recognizes MCDs in 28 states and has established CCDs in 21 states. The
District of Columbia has no primary divisions, and the city of Washington, DC is considered equivalent
to an MCD for data presentation purposes.
Census data also contains the Federal Information Processing Standards (FIPS) codes for each state
and county. The FIPS State Code and the FIPS County Code are both used by the Census Bureau to
identify these geographic units.
The following table lists the output fields that contain census data. To include census data in the output,
set Option.GeoTAXOutputRecordType = C.
118
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
表 49 : Census Data Output Fields
Response Element
County.Code
Max.
Description
Field
Length
(bytes)
4
Three-digit Federal Information Processing Standards
(FIPS) county code extracted from the
Census.BlockCode.
注 : This field is always included in the output
regardless of whether or not you choose to include
census data in the output.
County.Name
26
Name of the county.
注 : This field is always included in the output
regardless of whether or not you choose to include
census data in the output.
MCD.Code
6
Minor Civil Division/Census County Division (MCD/CCD)
Code.
MCD.Name
41
Minor Civil Division/Census County Division (MCD/CCD)
name.
MCD.PointStatus
2
An address can be compared to a Minor Civil Division
(MCD)/county subdivision file (Cousub.txt). This output
field returns the result for a comparison between the
matched geocode location to the polygon defined by the
Cousub.txb file.
For more information on buffers, see バッファリング
（304ページ）.
注 : The buffer distance for Cousub.txb is internally
set to zero and cannot be modified.
P
The point is in the polygon.
I
The point is in the buffer area inside the
polygon.
B
The point is in the buffer area and outside
of the polygon.
blank
Polygon not found.
MCD.DistanceToBorder
10
Returns the distance in feet between the matched
address point to the polygon defined by the Cousub.txb
file.
StateCode
3
Two-digit Federal Information Processing Standards
(FIPS) state code extracted from the Census.BlockCode.
注 : This field is always included in the output
regardless of whether or not you choose to include
census data in the output.
REST Web サービスガイド
119
Enterprise Tax モジュール
Input Latitude/Longitude
ReverseGeoTAXInfoLookup always returns the input coordinates as part of the output. The input
latitude/longitude fields are returned as input from the data. ReverseGeoTAXInfoLookup does not change
these input values.
表 50 : Input Latitude/Longitude Output Fields
Response Element
Max.
Description
Field
Length
(bytes)
InputLatitude
12
Input latitude.
InputLongitude
12
Input longitude.
Payroll System Tax Code
The following table lists the output fields that contain Payroll System Tax Code (PTC) data. For more
information on payroll tax districts, see Reverse GeoTAX Info Lookup. To include this data in the output,
set Option.GeoTAXOutputRecordType = W.
注 : ReverseGeoTAXInfoLookup returns up to six payroll tax codes per input location.
表 51 : Payroll System Tax Code Output Fields
Response Element
NumberPTCsFound
PTCn.MatchCode
120
Max.
Description
Field
Length
(bytes)
2
The number of payroll system tax codes found for this
location.
2 per
PTC
Indicates the level of match obtained for the location. In
order from most specific match to least, the possible
match codes are:
P
The address was matched to a specific Payroll
District ID. This is the most specific match.
G
The address was matched to a GNIS Code.
F
The address was matched to a county's FIPS
code.
S
The address was matched to a state's FIPS
code. This is the least specific match.
PTCn.PayrollCode
16 per
PTC
A code that represents a taxing authority in a payroll
application. This is a user-defined code. The specific
codes are determined by the payroll application that
utilizes the data returned by ReverseGeoTAXInfo
Lookup.
PTCn.PayrollDescription
41 per
PTC
A description of the purpose of this payroll code.
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
Response Element
PTCn.PayrollFlag
StateCounty
Max.
Description
Field
Length
(bytes)
7 per
PTC
33
A user-defined flag from the PTC database.
The state abbreviation and county name.
Tax Jurisdiction
Tax jurisdiction data contains information about the "place" for the location. A "place" is a geographic
area defined on the basis of population criteria that vary by state; or, an area recognized as significant
because it is located in an incorporated municipality. Places are used to determine tax jurisdiction.
The following table lists the output fields that contain tax jurisdiction data. To include tax jurisdiction data
in the output, set Option.GeoTAXOutputRecordType = T.
表 52 : Tax Jurisdiction Output Fields
Response Element
GeoTAXKey
Max.
Description
Field
Length
(bytes)
10
The value in this field varies depending on the option
you specified in the Option.TaxKey option:
If you specified T, GeoTAXKey contains the proprietary
codes used in Taxware tax compliance software. You
can use this code in your Taxware application to find out
the tax rate for the jurisdiction.
If you specified Y or V, GeoTAXKey contains the
®
proprietary Vertex jurisdiction code (comprised of a
®
two-digit Vertex state code, three-digit FIPS county
®
code, and four-digit Vertex city code). You can use this
®
code in your Vertex application to find out the tax rate
for the jurisdiction.
GeoTAXKey.MatchCode
REST Web サービスガイド
2
Return code denoting the level of match obtained against
the Vertex or Taxware cross reference files.
E
Exact match using five fields: FIPS state code,
FIPS county code, FIPS or GNIS place code,
ZIP Code, and FIPS place name.
P
Partial match using four fields: FIPS state code,
FIPS county code, FIPS or GNIS place code,
and ZIP Code.
A
Alternate match using two fields: ZIP Code,
FIPS place name.
N
Record is default coded based on valid state
code.
null
No matching record found.
121
Enterprise Tax モジュール
Response Element
GeoTAXKey.MatchLevel
GNISCode
Max.
Description
Field
Length
(bytes)
12
10
A description of the value returned in the
GeoTAXKey.MatchCode field.
Exact
Exact match. See description in
GeoTAXKey.MatchCode.
Partial
Partial match. See description in
GeoTAXKey.MatchCode.
Alternate
Alternate match. See description in
GeoTAXKey.MatchCode.
DefaultCode
Record is default coded. See
description in
GeoTAXKey.MatchCode.
NoMatch
No matching record found.
Unique nine-digit Geographic Names Information System
(GNIS) code.
注 : This field is always included in the output
regardless of whether or not you choose to include
census data in the output.
Place.ClassCode
3
Place class code. Place class codes are used to
determine the proper taxing jurisdictions
注 : This field is always included in the output
regardless of whether or not you choose to include
tax jurisdiction data in the output.
Place.Code
6
An identifier for a specific place. A "place" is a
geographic area defined on the basis of population
criteria that vary by state. Or, an area recognized as
significant because it is located in an incorporated
municipality.
注 : This field is always included in the output
regardless of whether or not you choose to include
tax jurisdiction data in the output.
Place.IncorporatedFlag
8
Indicates whether the address is located in an
incorporated or unincorporated place. A "place" is a
geographic area defined on the basis of population
criteria that vary by state. Or, an area recognized as
significant because it is located in an incorporated
municipality.
注 : This field is always included in the output
regardless of whether or not you choose to include
tax jurisdiction data in the output.
122
Inc
Incorporated place code.
Uninc
Unincorporated place code.
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
Response Element
Max.
Description
Field
Length
(bytes)
Unknown
Place.LastAnnexedDate
8
Incorporation status unknown.
Last annexed date, in the format MM/YYYY, representing
the month and year of the most recent boundary change
or the most recent available boundary information.
注 : This field is always included in the output
regardless of whether or not you choose to include
tax jurisdiction data in the output.
Place.LastUpdatedDate
8
Last updated date, in the format MM/YYYY, reflecting
the month and year when TomTom updated the
database to reflect attribute (name change, FIPS change,
etc.) or boundary edits to the Place.
注 : This field is always included in the output
regardless of whether or not you choose to include
tax jurisdiction data in the output.
Place.LastVerifiedDate
8
Last verified date, in the format MM/YYYY, representing
the month and year that TomTom verified municipality
change information.
注 : This field is always included in the output
regardless of whether or not you choose to include
tax jurisdiction data in the output.
Place.Name
41
The name of the "place" for the location. A "place" is a
geographic area defined on the basis of population
criteria that vary by state. Or, an area recognized as
significant because it is located in an incorporated
municipality.
注 : This field is always included in the output
regardless of whether or not you choose to include
tax jurisdiction data in the output.
Place.PointStatus
2
Returns the result for a comparison between the
matched geocode location to the polygon defined by the
Place.txb file.
For more information on buffers, see バッファリング
（304ページ）.
REST Web サービスガイド
P
The point is in the polygon.
I
The point is in the buffer area inside the
polygon.
B
The point is in the buffer area and outside
of the polygon.
blank
Polygon not found.
123
Enterprise Tax モジュール
Response Element
Place.DistanceToBorder
Max.
Description
Field
Length
(bytes)
10
Returns the distance in feet between the matched
address point to the polygon defined by the Place.txb
file.
User-Defined Boundary File
The following table lists the output fields that contain data returned from user-defined boundary files. To
include this data in the output, set Option.GeoTAXOutputRecordType = U.
注 : ReverseGeoTAXInfoLookup can return up to 10 user-defined areas for each input location.
表 53 : Output Fields for User-Defined Boundary Files
Response Element
NumberUserBoundariesFound
Max.
Description
Field
Length
(bytes)
3
The number of user-defined polygons found for the
address.
UserBoundaryn.BoundaryDescription
51 per A description of the polygon.
User
Boundary
UserBoundaryn.BoundaryID
11 per The ID of the polygon as specified in the user-defined
User
boundary file.
Boundary
UserBoundaryn.BufferRelation
2 per Indicates where in the polygon the location resides in
User
relation to the edge of the area.
Boundary
One of the following:
P
The geocode is inside the polygon at a distance
from the edge that is greater than the specified
buffer width. Buffer width is specified either by the
option or by the input field BufferWidth.
I
The geocode is inside the polygon but is close to
the edge. This indicates that the address is in the
buffer area specified either by the option or by the
input field BufferWidth.
B
The geocode is outside the polygon but is close
to the edge. This indicates that the address is in
the buffer area specified either by the option or by
the input field BufferWidth.
For more information, see バッファリング（304ページ）.
UserBoundaryn.DistanceToBorder
124
10 per Indicates the distance in feet from the input location to
User
the border of the polygon.
Boundary
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
Response Element
UserBoundaryn.SupplementalBoundaryID
Max.
Description
Field
Length
(bytes)
11 per A supplemental ID as specified in the user-defined
User
boundary file.
Boundary
Insurance Premium Tax Districts
The following table lists the output fields that contain Insurance Premium Tax Districts (IPD) data. For
more information on insurance premium tax districts, see ReverseGeoTAXInfoLookup（113ページ）.
To include IPD data in the output, set Option.GeoTAXOutputRecordType = I.
注 : ReverseGeoTAXInfoLookup returns multiple districts for IPDs, SPDs, PTDs, and PAYs.
表 54 : Insurance Premium Tax District Output Fields
Response Element
NumberIPDsFound
IPDn.BoundaryBuffer.BufferRelation
Max.
Description
Field
Length
(bytes)
3
2 per
IPD
The number of Insurance Premium Tax Districts found
for the location.
Indicates where in the district the location resides in
relation to the edge of the district.
One of the following:
P
The location is inside the district at a distance from
the edge that is greater than the specified buffer
width. Buffer width is specified either by the option
or by the input field BufferWidth.
I
The location is inside the district but is close to the
edge. This indicates that the location is in the
buffer area specified either by the option or by the
input field BufferWidth.
B
The location is outside the district but is close to
the edge. This indicates that the location is in the
buffer area specified either by the option or by the
input field BufferWidth.
For more information, see バッファリング（304ページ）.
IPDn.BoundaryBuffer.DistanceToBorder
10 per
IPD
Indicates the distance in feet from the location to the
border of the district.
IPDn.DistrictID
11 per
IPD
IPD ID.
IPDn.DistrictName
61 per
IPD
IPD name.
IPDn.DistrictType
7 per
IPD
IPD district type.
REST Web サービスガイド
125
Enterprise Tax モジュール
Response Element
Max.
Description
Field
Length
(bytes)
IPDn.UpdateDate
7 per
IPD
IPD update date (MMYYYY).
IPDn.VersionDate
7 per
IPD
IPD compiled date (MMYYYY).
IPDn.Notes
21 per
IPD
Tax code descriptions.
IPDn.ChangeDate
7 per
IPD
IPD change date.
IPDn.EffectiveDate
7 per
IPD
MMDDYY - Identifies when district becomes active State supplied
For example: 01, 33, A, B
For example: 010108
IPDn.ExpirationDate
7 per
IPD
MMDDYY - Identifies when district becomes inactive State supplied
For example: 063009
IPDn.FireRate
IPDn.FireFlag
21 per
IPD
Format is dependent on associated flag
6 per
IPD
P - Percentage; .1 = 10%, .0575 = 5.75%
For example: .13, 15.00 or 3;7
F - Flat Fee dollar amount
M - Multiple Percentages has a semi colon as a delimiter.
3;7 = "3% or 7%"
IPDn.CasualtyRate
IPDn.CasualtyFlag
21 per
IPD
Format is dependent on associated flag
6 per
IPD
P - Percentage; .1 = 10%, .0575 = 5.75%
For example: .13, 15.00 or 3;7
F - Flat Fee dollar amount
M - Multiple Percentages has a semicolon as a delimiter.
3;7 = "3% or 7%"
IPDn.VehicleRate
IPDn.VehicleFlag
21 per
IPD
Format is dependent on associated flag
6 per
IPD
P - Percentage; .1 = 10%, .0575 = 5.75%
For example: .13, 15.00 or 3;7
F - Flat Fee dollar amount
M - Multiple Percentages has a semicolon as a delimiter.
3;7 = "3% or 7%"
IPDn.MarineRate
IPDn.MarineFlag
126
21 per
IPD
Format is dependent on associated flag
6 per
IPD
P - Percentage; .1 = 10%, .0575 = 5.75%
For example: .13, 15.00 or 3;7
F - Flat Fee dollar amount
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
Response Element
Max.
Description
Field
Length
(bytes)
M - Multiple Percentages has a semicolon as a delimiter.
3;7 = "3% or 7%"
IPDn.HealthRate
IPDn.HealthFlag
21 per
IPD
Format is dependent on associated flag
6 per
IPD
P - Percentage; .1 = 10%, .0575 = 5.75%
For example: .13, 15.00 or 3;7
F - Flat Fee dollar amount
M - Multiple Percentages has a semicolon as a delimiter.
3;7 = "3% or 7%"
IPDn.LifeRate
IPDn.LifeFlag
21 per
IPD
Format is dependent on associated flag
6 per
IPD
P - Percentage; .1 = 10%, .0575 = 5.75%
For example: .13, 15.00 or 3;7
F - Flat Fee dollar amount
M - Multiple Percentages has a semicolon as a delimiter.
3;7 = "3% or 7%"
IPDn.OtherRate
IPDn.OtherFlag
21 per
IPD
Format is dependent on associated flag
6 per
IPD
P - Percentage; .1 = 10%, .0575 = 5.75%
Possible Values: .13, 15.00 or 3;7
F - Flat Fee dollar amount
M - Multiple Percentages has a semicolon as a delimiter.
3;7 = "3% or 7%"
IPDn.MinimumRate
IPDn.MinimumFlag
21 per
IPD
Format is dependent on associated flag
6 per
IPD
P - Percentage; .1 = 10%, .0575 = 5.75%
For example: .13, 15.00 or 3;7
F - Flat Fee dollar amount
M - Multiple Percentages has a semicolon as a delimiter.
3;7 = "3% or 7%"
Payroll Tax Districts
The following table lists the output fields that contain Payroll Tax District (PAY) data. For more information
on payroll tax districts, see Reverse GeoTAX Info Lookup. To include this data in the output, set
Option.GeoTAXOutputRecordType = R.
注 : ReverseGeoTAXInfoLookup returns multiple districts for IPDs, SPDs, PTDs, and PAYs.
REST Web サービスガイド
127
Enterprise Tax モジュール
表 55 : Payroll Tax District Output Fields
Response Element
NumberPAYsFound
PAYn.BoundaryBuffer.BufferRelation
Max.
Description
Field
Length
(bytes)
3
Number of payroll tax districts found for the location.
2 per
PAY
Indicates where in the district the location resides in
relation to the edge of the district.
One of the following:
P
The location is inside the district at a distance from
the edge that is greater than the specified buffer
width. Buffer width is specified either by the option
or by the input field BufferWidth.
I
The location is inside the district but is close to the
edge. This indicates that the location is in the
buffer area specified either by the option or by the
input field BufferWidth.
B
The location is outside the district but is close to
the edge. This indicates that the location is in the
buffer area specified either by the option or by the
input field BufferWidth.
For more information, see バッファリング（304ページ）.
PAYn.BoundaryBuffer.DistanceToBorder
10 per
PAY
Indicates the distance in feet from the location to the
border of the district.
PAYn.DistrictID
11 per
PAY
PAY district ID.
PAYn.DistrictName
61 per
PAY
PAY district name.
PAYn.DistrictType
7 per
PAY
PAY district type.
PAYn.ID
11 per
PAY
PAY ID.
PAYn.MunicipalEMSTax
2 per
PAY
PAY municipality emergency municipal services tax.
The values for Pennsylvania are:
Y
Levies the tax
N
Does not levy the tax
All other states are null.
PAYn.MunicipalIncomeTax
128
2 per
PAY
PAY municipality income tax.
The values for Pennsylvania are:
R
Resident
N
Non-resident
B
Both
X
None
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
Response Element
Max.
Description
Field
Length
(bytes)
All other states are null.
PAYn.SchoolDistrictEMSTax
2 per
PAY
PAY school district emergency municipal services tax.
The Values for Pennsylvania are:
Y
Levies the tax
N
Does not levy the tax
All other states are null.
PAYn.SchoolDistrictIncomeTax
2 per
PAY
PAY school district income tax.
The values for Pennsylvania are:
R
Resident
N
Non-resident
B
Both
X
N
The values for Ohio are:
R
Resident
X
None
All other states are null.
Property Tax District
The following table lists the output fields that contain Property Tax District (PTD) data. For more information
on property tax districts, see ReverseGeoTAXInfoLookup（113ページ）. To include this data in the
output, set Option.GeoTAXOutputRecordType = P.
注 : ReverseGeoTAXInfoLookup returns multiple districts for IPDs, SPDs, PTDs, and PAYs.
表 56 : Property Tax District Output Fields
Response Element
NumberPTDsFound
PTDn.BoundaryBuffer.BufferRelation
Max.
Description
Field
Length
(bytes)
3
2 per
PTD
The number of Property Tax Districts found for the
location.
Indicates where in the district the location resides in
relation to the edge of the district.
One of the following:
P
REST Web サービスガイド
The location is inside the district at a distance from
the edge that is greater than the specified buffer
width. Buffer width is specified either by the option
or by the input field BufferWidth.
129
Enterprise Tax モジュール
Response Element
Max.
Description
Field
Length
(bytes)
I
The location is inside the district but is close to the
edge. This indicates that the location is in the
buffer area specified either by the option or by the
input field BufferWidth.
B
The location is outside the district but is close to
the edge. This indicates that the address is in the
buffer area specified either by the option or by the
input field BufferWidth.
For more information, see バッファリング（304ページ）.
PTDn.BoundaryBuffer.DistanceToBorder
10 per
PTD
Indicates the distance in feet from the location to the
border of the district.
PTDn.DistrictID
11 per
PTD
PTD district ID.
PTDn.DistrictName
61 per
PTD
PTD district name.
PTDn.DistrictType
2 per
PTD
PTD district type. Only returned for Indiana.
R
Reporting district
B
Billing district
PTDn.JurisdictionID
11 per
PTD
PTD jurisdiction ID.
PTDn.UpdateDate
7 per
PTD
PTD update date.
Special Purpose Tax Districts
The following table lists the output fields that contain Special Purpose Tax Districts (SPD) data. For more
information on special purpose tax districts, see Reverse GeoTAX Info Lookup. To include this data
in the output, set Option.GeoTAXOutputRecordType = S.
注 : ReverseGeoTAXInfoLookup returns multiple districts for IPDs, SPDs, PTDs, and PAYs.
表 57 : Special Purpose Tax District Output Fields
Response Element
NumberSPDsFound
SPDn.BoundaryBuffer.BufferRelation
Max.
Description
Field
Length
(bytes)
3
2 per
SPD
Number of Special Purpose Tax Districts found for the
location.
Indicates where in the district the location resides in
relation to the edge of the district.
One of the following:
130
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
Response Element
Max.
Description
Field
Length
(bytes)
P
The location is inside the district at a distance from
the edge that is greater than the specified buffer
width. Buffer width is specified either by the option
or by the input field BufferWidth.
I
The location is inside the district but is close to the
edge. This indicates that the location is in the
buffer area specified either by the option or by the
input field BufferWidth.
B
The location is outside the district but is close to
the edge. This indicates that the location is in the
buffer area specified either by the option or by the
input field BufferWidth.
For more information, see バッファリング（304ページ）.
SPDn.BoundaryBuffer.DistanceToBorder
10 per
SPD
Indicates the distance in feet from the address to the
border of the district.
SPDn.CompiledDate
7 per
SPD
SPD compiled date.
SPDn.DistrictCode
4 per
SPD
3-digit district type code.
SPDn.DistrictName
61 per
SPD
SPD name.
SPDn.DistrictNumber
6 per
SPD
SPD district number.
SPDn.EffectiveDate
7 per
SPD
SPD effective date.
SPDn.UpdateDate
7 per
SPD
SPD update date.
SPDn.VersionDate
7 per
SPD
SPD version date.
Sales and Use Tax Rates
The following table lists the output fields that contain the sales and use tax rate data.
To include tax rate data in the output, set Option.GeoTAXOutputRecordType = B.
To select the tax rate type, set Option.TaxRate to one of the following:
N
Do not return sales and use tax rates. (default)
G
Return the General sales and use tax rates.
A
Return the Automotive sales and use tax rates.
C
Return the Construction sales and use tax rates.
M
Return the Medical sales and use tax rates.
REST Web サービスガイド
131
Enterprise Tax モジュール
注 : You must be a licensed user of the Pitney Bowes Software Sales and Use Tax Rate file to use this
feature.
表 58 : Sales and Use Tax Rate Output Fields
Response Element
TaxRate.RC
Max.
Description
Field
Length
(bytes)
2
Tax Rate return code denoting the level of match
obtained agained the Pitney Bowes Software Sales and
Use Tax Rate file:
E
Exact match, using all 5 fields
P
Partial match, using 4 fields
A
Alternate match, using 3 fields
N
Record is default-coded based on valid
state code.
Blank
No matching PB Software Sales and Use
Tax Rate record found.
Municipal.SalesTaxRate
11
Municipality sales tax rate for the selected tax rate type.
County.SalesTaxRate
11
County sales tax rate for the selected tax rate type.
State.SalesTaxRate
11
State sales tax rate for the selected tax rate type.
SPDn.SalesTaxRate
11 per
SPD
TaxRate.SalesTotal
11
The sum of the individual Municipal, County, State and
SPD sales tax rates.
Municipal.UseTaxRate
11
Municipality use tax rate for the selected tax rate type.
County.UseTaxRate
11
County use tax rate for the selected tax rate type.
State.UseTaxRate
11
State use tax rate for the selected tax rate type.
SPDn.UseTaxRate
11 per
SPD
Use tax rate for up to 10 Special Purpose Districts (SPD).
TaxRate.UseTotal
11
The sum of the individual Municipal, County, State and
SPD use tax rates.
Sales tax rate for up to 10 Special Purpose Districts
(SPD).
Error Reporting
The following table defines the error reporting output fields.
132
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
表 59 : Error Output Fields
Response Element
GTX.ErrorCode
Max.
Description
Field
Length
(bytes)
3
This field contains a return code if the GeoTAX engine
experiences an abnormal termination.
注 : This field contains the same set of codes returned
by the standalone GeoTAX software and is
intended for users who have migrated from
GeoTAX to Spectrum™ Technology Platform.
The first character indicates the file (or set of files
affected).
Blank
Matcher terminated normally
A
User Auxiliary file problem
CE
coubsub.txb file problem
CI
Confidence engine problem
D
Boundary file
F
User-defined boundary file problem
G
Address Matching engine problem
L
Licensing problem
S
State file problem
U
GeoTAX Auxiliary file problem
X
Combination of Street and state file
problem
Z
zip.gsb file problem
The second position is one of the following:
GTX.ErrorDescription
81
E
Fatal issue, program terminating
F
Expired database
I
Informational
If the GeoTAX engine experiences an abnormal
termination, this field contains a text description of the
reason. It is blank if GeoTAX terminated normally. The
maximum length is 80.
注 : This field contains the same set of descriptions
returned by the standalone GeoTAX software and
is intended for users who have migrated from
GeoTAX to Spectrum™ Technology Platform.
SI-"TS158 FILES NOT FOUND"
SI-"TS158 FILES VINTAGE OR INCOMPLETE DB
ERROR"
SI-"STATE FILES NOT FOUND"
SE-"STATE AND TS158 FILES NOT FOUND"
REST Web サービスガイド
133
Enterprise Tax モジュール
Response Element
Max.
Description
Field
Length
(bytes)
SE-"STATE NOT FOUND AND TS158 VINTAGE
ERROR"
SI-"STATE FILES VINTAGE OR INCOMPLETE DB
ERROR"
SE-"STATE VINTAGE ERROR AND TS158 NOT
FOUND"
SE-"STATE AND TS158 FILES VINTAGE OR
INCOMPLETE DB ERROR"
GI-"STREET FILES NOT FOUND"
XI-"STREET AND TS158 FILES NOT FOUND"
XI-"STREET NOT FOUND AND TS158 FILES VINTAGE
ERROR"
XI-"STREET AND STATE FILES NOT FOUND"
XE-"STREET STATE AND TS158 FILES NOT FOUND"
XE-"STREET AND STATE NOT FOUND AND TS158
VINTAGE ERROR"
XI-"STREET NOT FOUND AND STATE VINTAGE
ERROR"
XE-"STREET AND TS158 NOT FOUND AND STATE
VINTAGE ERROR"
XE-"STREET NOT FOUND AND STATE AND TS158
VINTAGE ERROR"
GI-"STREET FILES VINTAGE OR INCOMPLETE DB
ERROR"
XI-"STREET VINTAGE ERROR AND TS158 NOT
FOUND"
XI-"STREET AND TS158 FILES VINTAGE OR
INCOMPLETE DB ERROR"
XI-"STREET VINTAGE ERROR AND STATE NOT
FOUND"
XE-"STREET VINTAGE ERROR AND STATE AND
TS158 NOT FOUND"
XE-"STREET AND TS158 VINTAGE ERROR AND
STATE NOT FOUND"
XI-"STREET AND STATE FILES VINTAGE OR
INCOMPLETE DB ERROR"
XE-"STREET AND STATE VINTAGE ERROR AND
TS158 NOT FOUND"
XE-"STREET STATE AND TS158 VINTAGE ERROR"
LF-"INVALID FUNCTION PASSED TO GTDBLIO : "
AI-"GENIO ERROR: FILE = G1GTAUX , FUNC = , ST
="
UI-"GENIO ERROR: FILE = G1GTAX2 , FUNC = , ST
="
XF-"The (DB Vintage) database has expired!"
XF-"The (SPD file Vintage) SPD File has expired!"
DI- "UNABLE TO VALIDATE BOUNDARY LICENSE"
DI- "UNABLE TO OPEN BOUNDARY FILE"
DI- "BOUNDARY FILE NOT FOUND"
FI- "UNABLE TO VALIDATE USER BOUNDARY
LICENSE"
134
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
Response Element
Max.
Description
Field
Length
(bytes)
FI- "UNABLE TO OPEN USER BND FILE"
FI- "USER BND FILE NOT FOUND"
GTX.WarnCode
3
This field contains warning codes returned by the
GeoTAX engine. It is blank if no warnings were issued.
A value of WN indicates a database will expire next
month.
注 : This field contains the same set of codes returned
by the standalone GeoTAX software and is
intended for users who have migrated from
GeoTAX to Spectrum™ Technology Platform.
GTX.WarnDescription
81
A text description of any warnings returned by the
GeoTAX engine.
注 : This field contains the same set of descriptions
returned by the standalone GeoTAX software and
is intended for users who have migrated from
GeoTAX to Spectrum™ Technology Platform.
マッチコードとロケーションコード
Match Codes
The following table lists the Match Codes. The Match Codes indicate the portions of the address that
matched or did not match to the reference file. If a match could not be made, the Match Code begins
with E and the remaining digits indicate why the address did not match. The digits do not specifically
refer to which address elements did not match, but rather why the address did not match. These fields
are always included in the output from AssignGeoTAXInfo.
表 60 : Match Codes
Response Element
Description
Ahh
Same as Shh, but indicates match to an alias name record or an
alternate record.
Chh
Street address did not match, but located a street segment based on
the input ZIP Code or city.
D00
Matched to a small town with P.O. Box or General Delivery only.
Ghh
Matched to an auxiliary file.
Hhh
House number was changed.
Qhh
Matched to USPS range records with unique ZIP Codes. CASS rules
prohibit altering an input ZIP if it matches a unique ZIP Code value.
Rhh
Matched to a ranged address.
REST Web サービスガイド
135
Enterprise Tax モジュール
Response Element
Description
Shh
Matched to USPS data. This is considered the best address match,
because it matched directly against the USPS list of addresses. S is
returned for a small number of addresses when the matched address
has a blank ZIP + 4.
Thh
Matched to a street segment record. Street segment records do not
contain ZIP Code information. If you enter a ZIP Code, the application
returns the ZIP Code you entered. If the input city and state has only
one ZIP Code, the application returns that ZIP Code.
Uhh
Matched to USPS data but cannot resolve the ZIP + 4 code without the
firm name or other information.
Xhhh
Matched to an intersection of two streets, for example, “Clay St &
Michigan Ave.” The first hex digit refers to the last line information, the
second hex digit refers to the first street in the intersection, and the third
hex digit refers to the second street in the intersection.
注 : The USPS does not allow intersections as a valid deliverable
address
Yhhh
Z
Same as Xhhh, but an alias name record was used for one or both
streets.
No address given, but verified the provided ZIP Code.
Hex digit decoding
The following table contains the description of the hex digits for the Match Code values.
Code
136
In first hex position means:
In second and third hex position means:
0
No change in last line.
No change in address line.
1
ZIP Code changed.
Street type changed.
2
City changed.
Pre-directional changed.
3
City and ZIP Code changed.
Street type and pre-directional changed.
4
State changed.
Post-directional changed.
5
State and ZIP Code changed.
Street type and post-directional changed.
6
State and City changed.
Pre-directional and post-directional changed.
7
State, City, and ZIP Code changed.
Street type, pre-directional, and postdirectional
changed.
8
ZIP + 4 changed.
Street name changed.
9
ZIP and ZIP + 4 changed.
Street name and street type changed.
A
City and ZIP + 4 changed.
Street name and pre-directional changed.
B
City, ZIP, and ZIP + 4 changed.
Street name, street type, and pre-directional
changed.
C
State and ZIP + 4 changed.
Street name and post-directional changed.
D
State, ZIP, and ZIP + 4 changed.
Street name, street type, and post-directional
changed.
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
Code
In first hex position means:
In second and third hex position means:
E
State, City, and ZIP + 4 changed.
Street name, pre-directional, and
postdirectional changed.
F
State, City, ZIP, and ZIP + 4 changed.
Street name, street type, pre-directional, and
post-directional changed.
Match Error Codes
The following table describes the values returned when an error occurs or the application cannot find a
match.
表 61 : Result Indicator Match Error Codes
Response Element
Ennn, where nnn =
Description
Indicates an error, or no match. This can occur when the address entered
does not exist in the database, or the address is badly formed and
cannot be parsed correctly. The last three digits of an error code indicate
which parts of an address the application could not match to the
database.
000
No match made.
001
Low level error.
002
Could not find data file.
003
Incorrect GSD file signature or version ID.
010
No city and state or ZIP Code found.
011
Input ZIP not in the directory.
012
Input city not in the directory.
013
Input city not unique in the directory.
014
Out of licensed area. Only occurs if using Group 1 licensing technology.
015
Record count is depleted and license has expired.
020
No matching streets found in directory.
021
No matching cross streets for an intersection match.
022
No matching segments.
023
Unresolved match.
024
No matching segments. (Same as 022.)
025
Too many possible cross streets for intersection matching.
026
No address found when attempting a multiline match.
027
Invalid directional attempted.
028
Record also matched EWS data, therefore the application denied the
match.
029
No matching range, single street segment found.
030
No matching range, multiple street segments found.
REST Web サービスガイド
137
Enterprise Tax モジュール
Location Codes
The Location Codes indicate the methodology used to compute the geocode and may also provide some
information about the quality of the geocode.
A Location Code of 'E' indicates a location code is not available. This usually occurs when you have
requested ZIP Code centroids of a high quality, and one is not available for that match. It can occur
infrequently when the does not have a 5-digit centroid location. An 'E' location code type may also be
returned when the input address cannot be standardized and there is no input ZIP Code. In this case,
do not assume the ZIP Code returned with the nonstandardized address is the correct ZIP Code because
the did not standardize the address; therefore, the does not return geocoding or Census Block
information.
Address Location Codes
Address location codes detail the known qualities about the geocode. An address location code has the
following characters.
**Characters
Description
1st character
Always an 'A' indicating an address location.
2nd character
May be one of the following:
3rd and 4th characters
C
Interpolated address point
location.
G
GeoTAX Auxiliary fiel or
Landmark Auxiliary file data
location.
I
Application infers the correct
segment from the candidate
records.
P
Point-level data location.
R
Location represents a ranged
address.
S
Location on a street range.
X
Location on an intersection of two
streets.
Digit indicating other qualities about the location.
表 62 : Location Codes
**Response Element Description
ACn - Interpolated address point location
AIn - The correct segment is inferred from the candidate records at match time.
ASn - House range address geocode. This is the most accurate street interpolated geocode available.
where n =
0
138
Best location.
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
**Response Element Description
1
Street side is unknown. The Census FIPS Block ID is assigned from the left
side; however, there is no assigned offset and the point is placed directly on
the street.
2
Indicates one or both of the following:
• The address is interpolated onto a TIGER segment that did not initially contain
address ranges.
• The original segment name changed to match the USPS spelling. This
specifically refers to street type, predirectional, and postdirectional.
注 : Only the second case is valid for non-TIGER data because segment
range interpolation is only completed for TIGER data.
3
Both 1 and 2.
7
Placeholder. Used when starting and ending points of segments contain the
same value and shape data is not available.
AGn - Indicates a geocode match to a GeoTAX Auxiliary or Landmark Auxiliary file,
where n =
0
The geocode represents the center of a parcel or building.
1
The geocode is an interpolated address along a segment.
2
The geocode is an interpolated address along a segment, and the side of the
street cannot be determined from the data provided in the auxiliary file record.
3
The geocode is the midpoint of the street segment.
APnn - Indicates a point-level geocode match representing the center of a parcel or building,
where nn =
02
Parcel centroid
Indicates the center of an assessor’s parcel (tract or lot) polygon. When the
center of an irregularly shaped parcel falls outside of its polygon, the centroid
is manually repositioned to fall inside the polygon as closely as possible to the
actual center.
04
Address point
Represents field-collected GPS points with field-collected address data.
05
Structure centroid
Indicates the center of a building footprint polygon, where the building receives
mail or has telephone service.
Usually a residential address consists of a single building. For houses with
outbuildings (detached garages, shed, barns, etc.), only the residences have
a structure point. Condominiums and duplexes have multiple points for each
building. Larger buildings, such as apartment complexes, typically receive mail
at one address for each building and therefore individual apartments are not
represented as discrete structure points.
Shopping malls, industrial complexes, and academic or medical center
campuses where one building accepts mail for the entire complex are
REST Web サービスガイド
139
Enterprise Tax モジュール
**Response Element Description
represented as one point. When addresses are assigned to multiple buildings
within one complex, each addressed structure is represented by a point.
If the center of a structure falls outside of its polygon, the center is manually
repositioned to fall inside the polygon.
07
Manually placed
Address points are manually placed to coincide with the midpoint of an
assessor’s parcel’s street frontage at a distance from the center line.
08
Front door point
Represents the designated primary entrance to a building. If a building has
multiple entrances and there is no designated primary entrance or the primary
entrance cannot readily be determined, the primary entrance is chosen based
on proximity to the main access street and availability of parking.
09
Driveway offset point
Represents a point located on the primary access road (most commonly a
driveway) at a perpendicular distance of between 33- 98 feet (10-30 meters)
from the main roadway.
10
Street access point
Represents the primary point of access from the street network. This address
point type is located where the driveway or other access road intersects the
main roadway.
21
Base parcel point
The Centrus point data includes individual parcels that may be "stacked". These
stacked parcels are individually identified by their unit or suite number, and
the is able to match to this unit number and return the correct APN. If an input
address is for a building or complex, without a unit number, the "base" parcel
information returns and will not standardize to a unit number or return additional
information such as an APN.
3
The geocode is the midpoint of the street segment.
ARn - Ranged address geocode,
where n =
1
The geocode is placed along a single street segment, midway between the
interpolated location of the first and second input house numbers in the range.
2
The geocode is placed along a single street segment, midway between the
interpolated location of the first and second input house numbers in the range,
and the side of the street is unknown. The Census FIPS Block ID is assigned
from the left side; however, there is no assigned offset and the point is placed
directly on the street.
4
The input range spans multiple USPS segments. The geocode is placed on
the endpoint of the segment which corresponds to the first input house number,
closest to the end nearest the second input house number.
7
Placeholder. Used when the starting and ending points of the matched segment
contain the same value and shape data is not available.
AXn - Intersection geocode,
140
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
**Response Element Description
where n =
3
Standard single-point intersection computed from the center lines of street
segments.
8
Interpolated (divided-road) intersection geocode. Attempts to return a centroid
for the intersection.
Street centroid location codes
Street centroid location codes indicate the Census ID accuracy and the position of the geocode on the
returned street segment. A street centroid location code has the following characters.
Character
Description
1st character
Always 'C' indicating a location derived from a street segment.
2nd character
Census ID accuracy based on the search area used to obtain matching street
segment.
3rd character
Location of geocode on the returned street segment.
The following table contains the values and descriptions for the street centroid location codes.
Character position
Code
Description
2nd Character
B
Block Group accuracy (most accurate). Based on
input ZIP Code.
T
Census Tract accuracy. Based on input ZIP Code.
C
Unclassified Census accuracy. Normally accurate to
at least the County level. Based on input ZIP Code.
F
Unknown Census accuracy. Based on Finance area.
P
Unknown Census accuracy. Based on input City.
C
Segment centroid.
L
Segment low-range endpoint.
H
Segment high-range endpoint.
3rd Character
ZIP + 4 Location Codes
®
ZIP + 4 centroid location codes indicate the quality of two location attributes: Census ID accuracy and
positional accuracy. A ZIP + 4 centroid location code has the following characters.
Character
Description
1st character
Always a 'Z' indicating a location derived from a ZIP centroid..
2nd character
Census ID accuracy.
REST Web サービスガイド
141
Enterprise Tax モジュール
Character
Description
3rd character
Location type.
4th character
How the location and Census ID was defined. Provided for completeness, but
may not be useful for most applications.
The following table contains the values and descriptions for the ZIP + 4 location codes.
Character position
Code
Description
2nd Character
B
Block Group accuracy (most accurate).
T
Census Tract accuracy.
C
Unclassified Census accuracy. Normally accurate to
at least the County level. Based on input ZIP Code.
5
Location of the Post Office that delivers mail to the
address, a 5-digit ZIP Code centroid, or a location
based upon locale (city). See the 4th character for a
precise indication of locational accuracy.
7
Location based upon a ZIP + 2 centroid. These
locations can represent a multiple block area in urban
locations, or a slightly larger area in rural settings.
9
Location based upon a ZIP + 4 centroid. These are
the most accurate centroids and normally place the
location on the correct block face. For a small number
of records, the location may be the middle of the entire
street on which the ZIP + 4 falls. See the 4th character
for a precise indication of locational accuracy.
A
Address matched to a single segment. Location
assigned in the middle of the matched street segment,
offset to the proper side of the street.
a
Address matched to a single segment, but the correct
side of the street is unknown. Location assigned in
the middle of the matched street segment, offset to
the left side of the street, as address ranges increase.
B
Address matched to multiple segments, all segments
have the same Block Group. Location assigned to
the middle of the matched street segment with the
most house number ranges within this ZIP + 4.
Location offset to the proper side of the street.
b
Same as methodology B except the correct side of
the street is unknown. Location assigned in the middle
of the matched street segment, offset to the left side
of the street, as address ranges increase.
C
Address matched to multiple segments, with all
segments having the same Census Tract. Returns
the Block Group representing the most households
3rd Character
4th Character
142
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
Character position
Code
Description
in this ZIP + 4. Location assigned to t he middle of
the matched street segment with the most house
number ranges within this ZIP + 4. Location offset to
the proper side of the street.
REST Web サービスガイド
c
Same as methodology C except the correct side of
the street is unknown. Location assigned in the middle
of the matched street segment, offset to the left side
of the street, as address ranges increase.
D
Address matched to multiple segments, with all
segments having the same County. Returns the Block
Group representing the most households in this ZIP
+ 4. Location assigned to the middle of the matched
street segment with the most house number ranges
within this ZIP + 4. Location offset to the proper side
of the street.
d
Same as methodology D except the correct side of
the street is unknown. Location assigned in the middle
of the matched street segment, offset to the left side
of the street, as address ranges increase.
E
Street name matched; no house ranges available. All
matched segments have the same Block Group.
Location placed on the segment closest to the center
of the matched segments. In most cases, this is on
the mid-point of the entire street.
F
Street name matched; no house ranges available. All
matched segments have the same Census Tract.
Location placed on the segment closest to the center
of the matched segments. In most cases, this is on
the mid-point of the entire street.
G
Street name matched (no house ranges available).
All matched segments have the same County.
Location placed on the segment closest to the center
of the matched segments. In most cases, this is on
the mid-point of the entire street.
H
Same as methodology G, but some segments are not
in the same County. Used for less than .05% of the
centroids.
I
Created ZIP + 2 cluster centroid as defined by
methodologies A, a, B, and b. All centroids in this ZIP
+ 2 cluster have the same Block Group. Location
assigned to the ZIP + 2 centroid.
J
Created ZIP + 2 cluster centroid as defined by
methodologies A, a, B, b, C, and c. All centroids in
this ZIP + 2 cluster have the same Census Tract.
Location assigned to the ZIP + 2 centroid.
K
Created ZIP + 2 cluster centroid as defined by
methodologies A, a, B, b, C, c, D, and d. Location
assigned to the ZIP + 2 centroid.
143
Enterprise Tax モジュール
Character position
Code
Description
L
Created ZIP + 2 cluster centroid as defined by
methodology E. All centroids in this ZIP + 2 cluster
have the same Block Group. Location assigned to
the ZIP + 2 centroid.
M
Created ZIP+2 cluster centroid as defined by
methodology E and F. All centroids in this ZIP + 2
cluster have the same Census Tract. Location
assigned to the ZIP + 2 centroid.
N
Created ZIP + 2 cluster centroid as defined by
methodology E, F, G, and H. Location assigned to
the ZIP + 2 centroid.
O
ZIP Code is obsolete and not currently used by the
USPS. Historic location assigned.
V
Over 95% of addresses in this ZIP Code are in a
single Census Tract. Location assigned to the ZIP
Code centroid.
W
Over 80% of addresses in this ZIP Code are in a
single Census Tract. Reasonable Census Tract
accuracy. Location assigned to the ZIP Code centroid.
X
Less than 80% of addresses in this ZIP Code are in
a single Census Tract. Census ID is uncertain.
Location assigned to the ZIP Code centroid.
Y
Rural or sparsely populated area. Census code is
uncertain. Location based upon the USGS places file.
Z
P.O. Box or General Delivery addresses. Census
code is uncertain. Location based upon the Post
Office location that delivers the mail to that address.
Geographic Centroid Location Codes
Geographic centroid location codes indicate the quality of two location attributes: the geographic location
and area type.
Character
Description
1st character
Always 'G' indicating a location derived from a geographic centroid.
2nd character
Geographic area type.
The following table contains the values and descriptions for the geographic centroid location codes.
Character position
Code
Description
2nd Character
144
M
Municipality (city).
C
County.
S
State.
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
GeoConfidence モジュール
GeoConfidence Surface
GeoConfidenceSurface は、Enterprise Geocoding モジュールによって生成されるジオコード情報の品
質に基づいて地理信頼性ポリゴン（等高線とも呼ばれます）を返します。地理信頼性ポリゴンが生成
されたら、そのポリゴンに他の空間データを重ねてリスクや確率を明らかにできます。
このサービスは、GeoConfidence モジュールの FloodZoneAnalysis データフローテンプレートによっ
て使用されます。
注 : GeoConfidence では、Enterprise Geocoding モジュールおよび Location Intelligence モジュール
から提供されるサービスが利用されます。
リソース URL
JSON エンドポイント:
http://サーバー:ポート/rest/GeoConfidenceSurface/results.json
XML エンドポイント:
http://サーバー:ポート/rest/GeoConfidenceSurface/results.xml
リクエスト
GeoConfidence Surface の入力フィールドは、Enterprise Geocoding モジュールの GeoConfidence 出
力カテゴリから返された出力フィールドです。これらのフィールドについて、以下に詳しく説明しま
す。
Response Element
GeoConfidenceCode
Max. Description
Field
Length
(bytes)
13
The value returned in this field indicates which
geoconfidence surface type has been returned.
Possible values are:
INTERSECTION A geocode point for the intersection
of two streets.
REST Web サービスガイド
ADDRESS
An array of street segment points
representing the street segment
where the address is located.
POINT
If the geocoder was able to match the
address using point data, the point
geometry where the address is
located.
POSTAL1
A geocode point for the ZIP centroid.
145
Global Sentry モジュール
Response Element
Max. Description
Field
Length
(bytes)
StreetSegmentPoints
1024
POSTAL2
An array of points for all street
segments in the ZIP + 2 in which the
address is located.
POSTAL3
An array of points for street segments
in the ZIP + 4 in which the address is
located.
ERROR
An error has occurred.
An array of latitude/longitude values that represent the
street segment points.
注 : This field contains values only if the
GeoConfidenceCode field returns a value of
ADDRESS, POSTAL2, or POSTAL3.
GeoConfidenceCentroidLatitude
11
The latitude of the centroid of the geoconfidence
polygon.
GeoConfidenceCentroidLongitude
12
The longitude of the centroid of the geoconfidence
polygon.
応答
[GeoConfidenceSurface] 出力フィールドには、Geoconfidence ポリゴンが格納されます。
応答要素
説明
Geometry
返されたジオメトリを表す Geoconfidence ポリゴン。
Global Sentry モジュール
GlobalSentry
GlobalSentry サービスは、各国から得られたデータによる政府提供のブラックリストと照合してトラ
ンザクション (取引) のマッチングを試みます。GlobalSentry サービスは、Universal Name、Data
Normalization、Advanced Matching の各モジュールを利用します。Global Sentry サービスは、正規化
された統合ブラックリストと照合して、最適化された定義済みのルールを生成します。次のようなリ
ストがあります。
• Denied Persons List (米国)
• Unverified List (BIS Red Flag) (米国)
• Consolidated Financial Sanction Targets (Individuals and Entities) (英国/欧州連合)
• Consolidated lists of persons, groups, and entities subject to EU financial sanctions (欧州連合)
146
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
• DFAT Consolidated List (オーストラリア)
• OSFI Consolidated List (Individuals and Entities) (カナダ)
• Specially Designated Nationals, Terrorists, Narcotic Traffickers and other Blocked Persons List (米国)
• Statutorily Debarred Parties List (米国)
認可国、名前、住所、ID 番号、その他、誕生日などの情報と照合してマッチングを実行することによ
り、"総合的なリスク水準のスコア" が生成され、この情報に基づいて組織は特定の取引 (トランザク
ション) を阻止すべきかどうかを的確に判断し、誤検出を回避できます。
Global Sentry がデータをどのように処理するかを以下のステップで説明します。
1. Global Sentry サービス (以下、単に "サービス") は、最初にトランザクション内のすべての必須デー
タをスキャンして制裁対象国を特定します。制裁対象国の一致が見つかったトランザクションにつ
いては、他のすべての検索条件がバイパスされ、最大級のリスクスコアが設定されます。
2. 制裁対象国の一致が見つからなかった場合、サービスは Global Sentry Name Check、Global Sentry
Address Check、または Global Sentry ID Number Check サブフローを使用して Global Sentry デー
タベースとの照合によるトランザクションのマッチングを試みます。
3. Global Sentry Name Check は、個人、団体、および船舶に対してマッチングを試みます。これで
名前の一致が見つかった場合、サービスから名前スコアが返されます。
4. Global Sentry Address Check は、特定国内の住所に対してマッチングを試みます。これで住所の
一致が見つかった場合、サービスから住所スコアが返されます。
5. Global Sentry ID Number Check は、パスポート、国民背番号、社会保障番号 (SSN)、納税者番号
などの識別番号に対してマッチングを試みます。識別番号の一致が見つかった場合、サービスから
識別番号スコアが返されます。
6. 名前、住所、および識別番号の一致が見つからなかったトランザクションについては、トランザク
ションレコードが出力に書き出され、総合リスク水準スコアがゼロに設定されます。
7. 名前、住所、または識別番号の一致が見つかったトランザクションに対して、サービスは Global
Sentry Other Data Check サブフローを使用して Global Sentry データベースとの照合によるマッチ
ングを試みます。
8. Global Sentry Other Data Check は、出生地、出生日、国籍または市民権に対してマッチングを試
みます。ここで一致が見つかった場合は、サービスから出生地スコア、出生日スコア、国籍スコ
ア、または市民権スコアが返されます。
9. Global Sentry は、各トランザクションに総合リスク水準スコアを設定します。このスコアは、0
～ 16 の間の値を取り、OverallRiskLevel フィールドに返されます。リスク水準を計算するとき、
Global Sentry は入力レコードに含まれているデータの種類を考慮し、さらに Global Sentry データ
ベースに一致するエントリがある場合には、それがどの入力に対応するかも考慮します。一般に、
値が大きいほど、そのトランザクションに関係するリスクが高いことを示します。
リソース URL
JSON エンドポイント:
http://server:port/rest/GlobalSentry/results.json
XML エンドポイント:
http://server:port/rest/GlobalSentry/results.xml
JSON 応答の例
次の例では、JSON 応答を要求します。
http://myserver:8080/rest/GlobalSentry/results.json?
Data.FirstName=Miguel&Data.LastName=Batista
この要求から次のような JSON が返されます。
REST Web サービスガイド
147
Global Sentry モジュール
注 : この例では、空の応答要素を削除しています。最初の応答レコードのみを示しています。
{"Output": [
{
"OverallRiskLevel": "10",
"SanctionedCountryIdentified": "No",
"Status": "S",
"FirstName": "Miguel",
"LastName": "Batista",
"PlaceOfBirth": "San Sebastian (Guipuzcoa)
"EntryID": "315",
"InputFilteredFirstName": "Miguel",
"InputFilteredLastName": "Batista",
"InputFirstName": "Miguel",
"InputLastName": "Batista",
"ListType": "DFAT Consolidated List",
"MatchKey1": "MGL",
"MatchKey2": "BTST",
"NameMatchIdentified": "Yes",
"NameProvided": "Yes",
"AddressProvided": "No",
"IDNumberProvided": "No",
"AddressMatchIdentified": "No",
"IDNumberMatchIdentified": "No",
"CitizenshipScore": "0",
"CitizenshipMatchIdentified": "No",
"CitizenshipUID": "",
"DOBScore": "0",
"DOBMatchIdentified": "No",
"NationalityScore": "0",
"NationalityMatchIdentified": "No",
"PlaceOfBirthScore": "0",
"PlaceOfBirthMatchIdentified": "No",
"CitizenshipProvided": "No",
"DOBProvided": "No",
"NationalityProvided": "No",
"PlaceOfBirthProvided": "No",
"WatchListFirstName": "Miguel",
"WatchListLastName": "ALBISU IRIARTE",
"NameScore": "100",
"user_fields": []
}
]}
Spain",
XML 応答の例
次の例では、XML 応答を要求します。
http://myserver:8080/rest/GlobalSentry/results.xml?
Data.FirstName=Miguel&Data.LastName=Batista
この要求から次のような XML が返されます。
注 : この例では、空の応答要素を削除しています。最初の応答レコードのみを示しています。
<xml.GlobalSentryResponse
xmlns="http://www.pb.com/spectrum/services/GlobalSentry">
<Output>
<Row>
<OverallRiskLevel>10</OverallRiskLevel>
<SanctionedCountryIdentified>No</SanctionedCountryIdentified>
<Status>S</Status>
<FirstName>Miguel</FirstName>
<LastName>Batista</LastName>
<PlaceOfBirth>San Sebastian (Guipuzcoa) Spain</PlaceOfBirth>
<EntryID>315</EntryID>
<InputFilteredFirstName>Miguel</InputFilteredFirstName>
148
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
<InputFilteredLastName>Batista</InputFilteredLastName>
<InputFirstName>Miguel</InputFirstName>
<InputLastName>Batista</InputLastName>
<ListType>DFAT Consolidated List</ListType>
<MatchKey1>MGL</MatchKey1>
<MatchKey2>BTST</MatchKey2>
<NameMatchIdentified>Yes</NameMatchIdentified>
<NameProvided>Yes</NameProvided>
<AddressProvided>No</AddressProvided>
<IDNumberProvided>No</IDNumberProvided>
<AddressMatchIdentified>No</AddressMatchIdentified>
<IDNumberMatchIdentified>No</IDNumberMatchIdentified>
<CitizenshipScore>0</CitizenshipScore>
<CitizenshipMatchIdentified>No</CitizenshipMatchIdentified>
<DOBScore>0</DOBScore>
<DOBMatchIdentified>No</DOBMatchIdentified>
<NationalityScore>0</NationalityScore>
<NationalityMatchIdentified>No</NationalityMatchIdentified>
<PlaceOfBirthScore>0</PlaceOfBirthScore>
<PlaceOfBirthMatchIdentified>No</PlaceOfBirthMatchIdentified>
<CitizenshipProvided>No</CitizenshipProvided>
<DOBProvided>No</DOBProvided>
<NationalityProvided>No</NationalityProvided>
<PlaceOfBirthProvided>No</PlaceOfBirthProvided>
<WatchListFirstName>Miguel</WatchListFirstName>
<WatchListLastName>ALBISU IRIARTE</WatchListLastName>
<NameScore>100</NameScore>
<user_fields/>
</Row>
</Output>
</xml.GlobalSentryResponse>
要求
入力データのパラメータ
表 63 : Global Sentry の入力フィールド
パラメータ
説明
Data.Name
省略なしの完全な名前。
FirstName と LastName を使用しない場合は必須です。
Data.FirstName
ファーストネーム (姓名の名)、またはラストネーム (姓) 以外のすべ
ての名前要素。
Name を使用しない場合は必須です。
Data.LastName
ラストネーム (姓) のみ。
Name を使用しない場合は必須です。
Data.AddressLine1
最初の住所行。
データありの場合は推奨項目です。
Data.AddressLine2
2 行目の住所行。
データありの場合は推奨項目です。
Data.AddressLine3
3 行目の住所行。
データありの場合は推奨項目です。
REST Web サービスガイド
149
Global Sentry モジュール
パラメータ
説明
Data.Country
省略なしの完全な国名。
住所行を使用する場合は必須です。
Data.IDNumber
SSN、パスポート、Visa などの識別番号。
データありの場合は推奨項目です。
Data.PlaceOfBirth
任意の出生地データ。
データありの場合は推奨項目です。
Data.DOB
出生日 (Year, Month, Day の形式)。
データありの場合は推奨項目です。
Data.Citizenship
省略なしの完全な国名。
データありの場合は推奨項目です。
Data.Nationality
省略なしの完全な国名。
データありの場合は推奨項目です。
応答
表 64 : Global Sentry Service の出力
応答要素
説明
名前
150
InputName
元のデータソースからの入力名。
InputFilteredName
元のデータソースから肩書き、接尾語、および特殊文字を取り除いた
入力名。
Name
データベースから返された名前。
InputFirstName
元のデータソースからの入力ファーストネーム。
InputFilteredFirstName
元のデータソースから肩書き、接尾語、および特殊文字を取り除いた
入力ファーストネーム。
FirstName
データベースから返されたファーストネーム。
InputLastName
元のデータソースからの入力ラストネーム。
InputFilteredLastName
元のデータソースから肩書き、接尾語、および特殊文字を取り除いた
入力ラストネーム。
LastName
データベースから返されたラストネーム。
NameScore
名前一致スコア。0 ～ 100。
NameMatchIdentified
名前が一致したかどうかを示します。「はい」または「いいえ」
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
応答要素
説明
NameProvided
名前が一致したかどうかを示します。「はい」または「いいえ」
住所
InputAddressLine1
元のデータソースからの入力住所行。
AddressLine1
データベースから返された住所行。
InputAddressLine2
元のデータソースからの入力住所行。
AddressLine2
データベースから返された住所行。
InputAddressLine3
元のデータソースからの入力住所行。
AddressLine3
データベースから返された住所行。
AddressScore
住所一致スコア。0 ～ 100。
AddressMatchIdentified
住所が一致したかどうかを示します。「はい」または「いいえ」。
AddressProvided
入力データに住所があるかどうかを示します。「はい」または「いい
え」。
InputCountry
元のデータソースからの入力国名。
Country
データベースからの国名。
識別番号
InputIDNumber
元のデータソースからの入力識別番号。
IDNumber
データベースからの識別番号。
IDNumberScore
識別番号一致スコア。0 ～ 100。
IDMatchNumberIdentified
識別番号が一致したかどうかを示します。「はい」または「いいえ」。
IDNumberProvided
入力データに識別番号があるかどうかを示します。「はい」または
「いいえ」。
出生地
InputPlaceOfBirth
元のデータソースからの入力出生地。
PlaceOfBirth
データベースから返された出生地。
PlaceOfBirthScore
出生地一致スコア。0 ～ 100。
PlaceOfBirthMatchIdentified
出生地が一致したかどうかを示します。「はい」または「いいえ」。
PlaceOfBirthProvided
入力データに出生地があるかどうかを示します。「はい」または「い
いえ」。
出生日
InputDOB
元のデータソースからの入力出生日。
DOB
データベースから返された出生日。
REST Web サービスガイド
151
Global Sentry モジュール
応答要素
説明
DOBScore
出生日一致スコア。0 ～ 100。
DOBMatchIdentified
出生日が一致したかどうかを示します。「はい」または「いいえ」。
DOBProvided
入力データに出生日があるかどうかを示します。「はい」または「い
いえ」。
市民権
InputCitizenship
元のデータソースからの入力市民権。
Citizenship
データベースから返された市民権。
CitizenshipScore
市民権一致スコア。0 ～ 100。
CitizenshipMatchIdentified
市民権が一致したかどうかを示します。「はい」または「いいえ」。
CitizenshipProvided
入力データに市民権があるかどうかを示します。「はい」または「い
いえ」。
国籍
InputNationality
元のデータソースからの入力国籍。
Nationality
データベースから返された国籍。
NationalityScore
国籍一致スコア。0 ～ 100。
NationalityMatchIdentified
国籍が一致したかどうかを示します。「はい」または「いいえ」。
NationalityProvided
入力データに国籍があるかどうかを示します。「はい」または「いい
え」。
政府リスト情報
EntryID
名前、団体、船舶、住所、識別番号、出生地、出生日、市民権、また
は国籍を示すエントリ ID。これは各政府機関から提供されます。
ListType
政府機関から提供されるリストの名前。SDN、EU、イングランド銀
行、カナダ金融機関監督庁。
リスク解析
OverAllRiskLevel
一致ごとのリスクソース。0 ～ 16。詳細については、リスク解析ス
コアについて（152ページ）を参照してください。
SanctionCountryIdentified
制裁対象国の一致が見つかったかどうかを示します。「はい」または
「いいえ」。
リスク解析スコアについて
これらの各入力に対しては、入力の有無と Global Sentry データベース内に一致するレコードがあるか
どうかに応じて、リスク解析処理が一定のポイント値を割り当てます。リスク解析スコアは、これら
のポイント値の合計です。ポイントがどのように割り当てられるかを次の表に示します。
152
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
表 65 : リスク解析のスコアリング方法
入力
入力データなし
一致あり
一致なし
名前
0
4
0
住所
1
2
0
ID
1
2
0
出生日
1
2
0
出生地
1
2
0
市民権
1
2
0
国籍
1
2
0
一般に、データベースと一致した各入力には 2 ポイントが割り当てられます。ただし、名前は例外で
す。名前の一致は 4 ポイントとカウントされます。名前スコアの加重が高いのは、OFAC などの情報
源から得られる指針に従っているからで、そこでは名前の一致はその他の種類の一致よりもより重要
であるとされています。
一方、入力があっても、データベースのどのエントリとも一致しない場合、割り当てられるポイント
は 0 で、総合リスク水準には影響しません。これは、名前の一致があっても、その他の相当量のデー
タがデータベース内のエントリと一致しなければ、その一致を特定リストとの照合による "ヒット" と
は見なすべきでないという指針に従うものです。
データのない入力に 1 ポイントが設定されています。これには、1 つ以上の入力がデータベースと一
致する一方で、マッチングに使用できる入力が一部欠けているようなトランザクションを、よりリス
クが高いトランザクションであると見なす効果があります。このタイプのトランザクションについて
は、データが欠けているが故に真のリスク水準を正確に計算できません。OFAC などの機関から得ら
れる指針によれば、こうしたケースではトランザクションに関係するリスクのより正確な評価を与え
るために、欠けているデータの入手に努力することになっています。
スコアが高ければそれだけトランザクションのリスクも大きくなりますが、リスク水準だけで必ずし
も適切なアクションを決定できるわけではありません。これはスコアが同じでも、一致あり、一致な
し、データなしの入力について、さまざまな組み合わせが考えられるからです。禁止措置の妥当性を
判断する補足的な情報を提供するために、Global Sentry サービスはマッチングで使われる 7 つの入力
のそれぞれについて、さらに 2 つの指標を返します。これらは入力のデータの有無と、データベース
の一致の有無を示します。これで、リスク範囲の中程にあるトランザクションに対して追加的な解析
を行うことにより、ブラックリストの管理当局にトランザクションを報告する、正確なリスク評価の
ために追加的な入力データが必要とのマークをトランザクションに付ける、トランザクションを承認
する、または、その他の何らかのアクションを行うなど、どの対処が妥当かを判断できます。
Global Sentry サービスのカスタマイズ
Global Sentry は、Enterprise Designer で部分的に修正できる 5 つのデータフローテンプレートを展
開しています。個々のデータフローは、Spectrum™ Technology Platform、Universal Name、Data
Normalization、Advanced Matching の各モジュールからインストールされた各種のコンポーネントに
よって構成されます。
以下のデータフローが使用可能です。
•
•
•
•
Global Sentry
Global Sentry Name Check
Global Sentry Address Check
Global Sentry ID Number Check
REST Web サービスガイド
153
Location Intelligence モジュール
•
•
•
•
•
•
Global Sentry Other Data Check
Global Sentry Batch
Global Sentry Name Check Batch
Global Sentry Address Check Batch
Global Sentry ID Number Check Batch
Global Sentry Other Data Check Batch
Location Intelligence モジュール
ドキュメントの場所
Location Intelligence モジュールは、任意の位置、対象領域、または対象地点やその他のビジネスデー
タ間の関連性を決定し、そうした関連性をマップ上に視覚的に示すことができる空間サービスを提供
します。これらのサービスには次のものが含まれます。
•
•
•
•
•
•
•
•
Geometry
Feature
Mapping
MapTiling
Named Resource
Web Feature Service
Web Map Service
Catalog Service for the Web (CSW)
Location Intelligence モジュールサービスの詳細については、『Spectrum Spatial ガイド』
(support.pb.com にあります) を参照してください。
Universal Addressing モジュール
AutoCompleteLoqate
AutoCompleteLoqate は、住所データのリアルタイム入力に対して高速で正確な結果を返します。
フォームに入力された各文字に基づいて瞬時に結果が返され、正確なデータのみがデータベースに入
力されることを保証します。
リソース URL
JSON エンドポイント:
http://server:port/rest/AutoCompleteLoqate/results.json
XML エンドポイント:
http://server:port/rest/AutoCompleteLoqate/results.xml
154
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
JSON 応答の例
次の例では、JSON 応答を要求します。
http://myserver:8080/rest/AutoCompleteLoqate/results.json?Data.AddressLine1=1+Global
この要求から次のような JSON が返されます。
注 : この例では、内容を理解しやすいように空の応答要素を削除し、最初の 3 つの住所マッチのみを
示しています。
{"output_port": [
{
"ProcessedBy": "LOQATE",
"HouseNumber": "1",
"AddressLine1": "1 Global Vw",
"FirmName": "Map Info",
"City": "Troy",
"StateProvince": "NY",
"PostalCode": "12180-8399",
"Country": "United States",
"PostalCode.AddOn": "8399",
"user_fields": []
},
{
"ProcessedBy": "LOQATE",
"HouseNumber": "1",
"AddressLine1": "1 Global Pl",
"City": "Glendale",
"StateProvince": "AZ",
"PostalCode": "85306-3216",
"Country": "United States",
"PostalCode.AddOn": "3216",
"user_fields": []
},
{
"ProcessedBy": "LOQATE",
"HouseNumber": "1",
"AddressLine1": "1 Global Dr",
"City": "Olive Hill",
"StateProvince": "KY",
"PostalCode": "41164-6739",
"Country": "United States",
"PostalCode.AddOn": "6739",
"user_fields": []
}
]}
XML 応答の例
次の例では、XML 応答を要求します。
http://myserver:8080/rest/AutoCompleteLoqate/results.xml?Data.AddressLine1=1+Global
この要求から次のような XML が返されます。
注 : この例では、内容を理解しやすいように空の応答要素を削除し、最初の 3 つの住所マッチのみを
示しています。
<ns2:xml.AutoCompleteLoqateResponse
xmlns:ns2="http://www.pb.com/spectrum/services/AutoCompleteLoqate">
<ns2:output_port>
<ns2:Address>
<ns2:ProcessedBy>LOQATE</ns2:ProcessedBy>
<ns2:HouseNumber>1</ns2:HouseNumber>
<ns2:AddressLine1>1 Global Vw</ns2:AddressLine1>
REST Web サービスガイド
155
Universal Addressing モジュール
<ns2:FirmName>Map Info</ns2:FirmName>
<ns2:City>Troy</ns2:City>
<ns2:StateProvince>NY</ns2:StateProvince>
<ns2:PostalCode>12180-8399</ns2:PostalCode>
<ns2:PostalCode.AddOn>8399</ns2:PostalCode.AddOn>
<ns2:Country>United States</ns2:Country>
</ns2:Address>
<ns2:Address>
<ns2:ProcessedBy>LOQATE</ns2:ProcessedBy>
<ns2:HouseNumber>1</ns2:HouseNumber>
<ns2:AddressLine1>1 Global Pl</ns2:AddressLine1>
<ns2:City>Glendale</ns2:City>
<ns2:StateProvince>AZ</ns2:StateProvince>
<ns2:PostalCode>85306-3216</ns2:PostalCode>
<ns2:PostalCode.AddOn>3216</ns2:PostalCode.AddOn>
<ns2:Country>United States</ns2:Country>
</ns2:Address>
<ns2:Address>
<ns2:ProcessedBy>LOQATE</ns2:ProcessedBy>
<ns2:HouseNumber>1</ns2:HouseNumber>
<ns2:AddressLine1>1 Global Dr</ns2:AddressLine1>
<ns2:City>Olive Hill</ns2:City>
<ns2:StateProvince>KY</ns2:StateProvince>
<ns2:PostalCode>41164-6739</ns2:PostalCode>
<ns2:PostalCode.AddOn>6739</ns2:PostalCode.AddOn>
<ns2:Country>United States</ns2:Country>
</ns2:Address>
</ns2:output_port>
</ns2:xml.AutoCompleteLoqateResponse>
要求
入力データのパラメータ
AutoCompleteLoqate の入力の一覧を以下の表に示します。
表 66 : 入力フォーマット
パラメータ
説明
Data.AddressLine1
最初の住所行。
Data.AddressLine2
2 行目の住所行。
Data.AddressLine3
3 行目の住所行。
Data.AddressLine4
4 行目の住所行。
Data.City
都市名。
Data.Country
国コードまたは名前を、以下のいずれかのフォーマットで入力しま
す。
• 2 桁の ISO 国コード
• 3 桁の UPU 国コード
• 英語の国名
ISO コードの一覧は、各国の ISO コードとモジュールサポート
（306ページ）を参照してください。
Data.FirmName
156
会社名または企業名。
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
パラメータ
説明
Data.PostalCode
住所の郵便番号。
Data.StateProvince
州または省。
オプションのパラメータ
表 67 : AutoCompleteLoqate のオプション
パラメータ
説明
Option.Database.Loqate
住所処理に使用するデータベースを指定します。 Management Console
の [データベースリソース] パネルで定義されたデータベースのみが
使用可能です。
Option.OutputCasing
出力データの大文字と小文字の区別を指定します。次のいずれかで
す。
M
出力には、大文字と小文字が混在します (デフォルト)。例:
123 Main St
Mytown FL 12345
U
出力に大文字を使用します。例:
123 MAIN ST
MYTOWN FL 12345
Option.HomeCountry
デフォルト国を指定します。大部分の住所が存在する国を指定してく
ださい。例えば、処理する住所の大部分がカナダにある場合は、カナ
ダを指定します。有効な国名には次のものがあります。
Afghanistan, Albania, Algeria, American Somoa, Andorra, Angola,
Anguilla, Antigua And Barbuda, Argentina, Armenia, Aruba, Australia,
Austria, Azerbaijan, Bahamas, Bahrain, Bangladesh, Barbados, Belarus,
Belgium, Belize, Benin, Bermuda, Bhutan, Bolivia, Bosnia And
Herzegovina, Botswana, Brazil, British Virgin Islands, Brunei
Darussalam, Bulgaria, Burkina Faso, Burundi, Cambodia, Cameroon,
Canada, Cape Verde, Cayman Islands, Central African Republic, Chad,
Chile, China, Colombia, Comoros Islands, Congo, Cook Islands, Costa
Rica, Cote D'Ivoire, Croatia, Cuba, Cyprus, Czech Republic, Democratic
Republic Of Congo, Denmark, Djibouti, Dominica, Dominican Republic,
East Timor, Ecuador, Egypt, El Salvador, Equitorial Guinea, Eritrea,
Estonia, Ethiopia, Falkland Islands, Faroe Islands, Federated States Of
Micronesia, Fiji, Finland, France, French Guiana, Gabon, Gambia,
Germany, Ghana, Gibraltar, Greece, Greenland, Grenada, Guadeloupe,
Guam, Guatemala, Guinea, Guinea Bissau, Guyana, Haiti, Holy See,
Honduras, Hong Kong, Hungary, Iceland, India, Indonesia, Iran, Iraq,
Ireland, Israel, Italy, Jamaica, Japan, Jordan, Kazakhstan, Kenya,
Kiribati, Korea, Kuwait, Kyrgyzstan, Laos, Latvia, Lebanon, Lesotho,
Liberia, Libya, Liechtenstein, Lithuania, Luxembourg, Macau, Macedonia,
Madagascar, Malawi, Malaysia, Maldives, Mali, Malta, Marshall Islands,
Martinique, Mauritania, Mauritius, Mayotte, Mexico, Moldova, Monaco,
REST Web サービスガイド
157
Universal Addressing モジュール
パラメータ
説明
Mongolia, Monserrat, Morocco, Mozambique, Myanmar, Namibia, Nauru,
Nepal, Netherlands Antilles, New Caledonia, New Zealand, Nicaragua,
Niger, Nigeria, Niue, Norway, Oman, Pakistan, Palau, Panama, Papua
New Guinea, Paraguay, Peru, Philippines, Pitcairn Islands, Poland,
Portugal, Puerto Rico, Qatar, Republic Of Georgia, Republic Of Korea,
Republic Of Singapore, Reunion, Romania, Russia, Rwanda, Saint
Helena, Saint Kitts And Nevis, Saint Lucia, Saint Pierre And Miquelon,
Saint Vincent And The Grenadines, Samoa, San Marino, Sao Tome
And Principe, Saudi Arabia, Senegal, Seychelles, Sierra Leone, Slovakia,
Slovenia, Solomon Islands, Somalia, South Africa, Spain, Sri Lanka,
Sudan, Surivalue, Swaziland, Sweden, Switzerland, Syria, Tahiti, Taiwan,
Tajikistan, Tanzania, Thailand, The Netherlands, Togo, Tonga, Trinidad
And Tobago, Tristan Da Cunha, Tunisia, Turkey, Turkmenistan, Turks
And Caicos Islands, Tuvalu, Uganda, Ukraine, United Arab Emirates,
United Kingdom, United States, Uruguay, Uzbekistan, Vanuatu,
Venezuela, Vietnam, Virgin Islands (US), Wallis And Futuna, Yemen,
Yugoslavia, Zambia, Zimbabwe
Option.OutputCountryFormat Country 出力フィールドに返される国名に使用するフォーマットを指
定します。例えば、英語を選択した場合、"Deutschland" という国名
は "Germany" として返されます。
Option.OutputScript
E
英語の国名を使用します (デフォルト)。
I
国名の代わりにその国の 2 文字の ISO の略語を使用します。
U
国名の代わりにその国の万国郵便連合 (Universal Postal Union:
UPU) の略語を使用します。
出力がどのアルファベットまたはスクリプトで返されるかを指定しま
す。このオプションは双方向で、通常はネイティブからラテン文字
へ、およびラテン文字からネイティブへ実行されます。
Input
書き直しを実行せず、入力と同じスクリプトで出力し
ます (デフォルト)。
Native
使用可能な場合は、選択した国のネイティブスクリプ
トで出力します。
Latn
英語の値を使用します。
Option.isPowersearchEnable インデックスファイル形式のデータを使用することによって、240 カ
国に対して入力時間を最大 80% 短縮します。検索を実行すると、
Loqate エンジンはまず、該当するインデックスを検索します。イン
デックスが存在する場合は、候補住所のリストを直ちに返そうと試み
ます。インデックスが存在しないか、インデックスによって結果が 1
つも返されない場合は、元の検索処理を開始します。
注 : 高度な検索は、入力ファイルにフィールドがちょうど 2 つだけ
が存在する場合に実行可能です。1 つは Country フィールドで、
もう 1 つはいずれかの AddressLine フィールドです。このオプ
ションを選択し、入力ファイルにそれ以外のフィールドが含ま
れる場合は、元の検索処理が自動的に開始されます。
158
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
パラメータ
説明
検索を行うために、Auto Complete インデックスは米国内の検索に対
しては最初の 10 文字まで、その他すべての対象国内の検索に対して
は最初の 15 文字までを使用します。空白と句読文字は、この文字数
にカウントされません。
高度な検索は、ボツワナ、エチオピア、インド、カザフスタン、マ
レーシア、モンゴル、セントクリストファー・ネイビス、およびサン
マリノでは使用できません。
注 : 高度な検索を使用するには、有効なライセンスが必要です。高
度な検索のライセンスを取得していないか、ライセンスの期限
が切れている状態でこのオプションを選択すると、エラーとな
ります。
Option.MaximumResults
AutoCompleteLoqate が返す住所の最大数。デフォルトは 10 です。
Option.FailJobOnDataLicenseError データライセンスエラーの発生時に Spectrum Technology Platform
がどのように応答するかを指定します。
ジョブのエラー
データライセンスエラーが発生した場合、ジョ
ブ全体をエラーにします。
レコードのエラーデータライセンスエラーの発生原因となったレ
コードをエラーにし、処理を続行します。
応答
AutoCompleteLoqate の出力はオプションであり、[AutoCompleteLoqate オプション] ダイアログボッ
クスの [出力フィールド] セクションで選択したフィールドに直接対応します。
表 68 : AutoCompleteLoqate の出力
応答要素
説明
AddressLine1
最初の住所行。
AddressLine2
2 行目の住所行。
AddressLine3
3 行目の住所行。
AddressLine4
4 行目の住所行。
City
都市名。
Country
3 文字の ISO 3116-1 Alpha-3 国コード。 ISO コードの一覧は、各国
の ISO コードとモジュールサポート（306ページ）を参照してくださ
い。
FirmName
企業名。
HouseNumber
候補住所の家番号が含まれる範囲の終了家番号。
PostalCode
郵便番号。
REST Web サービスガイド
159
Universal Addressing モジュール
応答要素
説明
PostalCode.AddOn
ZIP + 4 Code の末尾 4 桁。
ProcessedBy
住所を処理した住所コーダーを示します。
®
LOQATE
Loqate コーダーが住所を処理しています。
StateProvince
州または省の省略形。
Status
マッチの成功または失敗を報告します。
Status.Code
NULL
成功
F
失敗
失敗の原因 (ある場合)。
• DisabledCoder
• RequestFailed
• NoLookupAddressFound
Status.Description
問題の説明 (ある場合)。
Did not return
multiples
入力住所はデータベース内の 1 つの住所とのみ
マッチしました。 AutoCompleteLoqate は、一
致する可能性のある住所が複数見つかった場合
のみデータを返します。
Not able to look up AutoCompleteLoqate は、部分的な住所を処理
the address
できません。
pattern
AutoCompleteLoqate のサンプル Web アプリケーション
Auto Complete Loqate 機能を示すサンプル Web アプリケーションにアクセスできます。部分的な住
所を入力すると、このアプリケーションは Auto Complete Loqate REST Web サービスを呼び出しま
す。この Web サービスは提案される住所を返します。
注 : この機能を使用する前に、Management Console で Auto Complete Loqate データベースリソー
スを追加し、そのデータベースリソースを Auto Complete Loqate Service に保存する必要があ
ります。
1. Spectrum™ Technology Platform サーバーが実行されていることを確認します。
2. Web ブラウザを開いて、http://<servername>:<port>/autocompleteに移動します。例え
ば、サーバーの名前が "myserver" であり、既定の HTTP ポート 8080 を使う場合は、
http://myserver:8080/autocompleteに移動します。
注 : このサイトは、Internet Explorer 8.0 またはそれ以降、Chrome、Mozilla Firefox で最も適切に
表示されます。
3. ログイン画面が表示されたら、ユーザ名として "guest" を入力し、パスワードフィールドは空白
のままにします。
4. [OK] をクリックします。
5. ドロップダウンリストから国を選択します。
6. 提供されている任意のフィールドで住所の入力を開始します。
160
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
7. 提案された住所のリストから選択します。
8. 新しい呼び出しを開始するには、[リセット] をクリックして、前回の呼び出しで使用したフィール
ドをクリアします。
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",
REST Web サービスガイド
161
Universal Addressing モジュール
"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
162
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
この要求から次のような 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>
要求
入力データのパラメータ
GetCandidateAddresses の入力の一覧を以下の表に示します。
表 69 : 入力フォーマット
パラメータ
説明
Data.AddressLine1
最初の住所行。
Data.AddressLine2
2 行目の住所行。
Data.AddressLine3
3 行目の住所行。
米国およびカナダの住所には存在しません。
REST Web サービスガイド
163
Universal Addressing モジュール
パラメータ
説明
Data.AddressLine4
4 行目の住所行。
米国およびカナダの住所には存在しません。
Data.AddressLine5
5 行目の住所行。
英国住所にのみ適用されます。ストリート名、ユニット番号、ビル
ディング番号などを含めることができます。
Data.City
都市名。
Data.StateProvince
州または省。
米国の住所に限り、州を StateProvince フィールドの代わりに City
フィールドに入れることができます。
Data.PostalCode
™
住所の郵便番号。米国住所の場合は、次のいずれかの形式の ZIP Code
になります。
99999
99999-9999
A9A9A9
A9A 9A9
9999 999
注 : カナダ住所の場合は、このフィールドのみを入力すると、候補
となる住所データが返されます。その他の国の場合は、
AddressLine1 と AddressLine2 も入力する必要があります。
Data.Country
国コードまたは名前を、以下のいずれかのフォーマットで入力しま
す。
• 2 桁の ISO 国コード
• 3 桁の UPU 国コード
• 英語の国名
• フランス語の国名
• ドイツ語の国名
• スペイン語の国名
ISO コードの一覧は、各国の ISO コードとモジュールサポート
（306ページ）を参照してください。
164
Data.FirmName
会社名または企業名。
Data.USUrbanName
米国住所都市化名。主にプエルトリコの住所に使用します。
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
オプションのパラメータ
表 70 : GetCandidateAddresses オプション
パラメータ
説明
Option.PerformUSProcessing
米国住所を処理するかどうかを指定します。米国住所処理
を有効にすると、GetCandidateAddresses は、米国住所の
候補となる住所の取得を試みます。住所をサポートしてい
ません。米国住所処理を無効にすると、米国住所は失敗し
ます。つまり、Status 出力フィールドに "F" が設定されて
返されます。出力フィールド Status.Code
は、"DisabledCoder" となります。米国住所処理のライセン
スを取得していない場合は、ジョブに米国住所が含まれる
か否かにかかわらず、米国住所処理を無効にしなければ、
ジョブを正常に実行することはできません。住所をサポー
トしていません。
注 : 米国住所を正常に処理するには、米国住所処理の有
効なライセンスを取得する必要があります。住所を
サポートしていません。米国住所処理のライセンス
を取得していないか、ライセンスの期限が切れている
にもかかわらず、米国住所処理を有効にすると、エ
ラーとなります。
Y
米国住所を処理します (デフォルト)。
N
米国住所を処理しません。
Option.Database.US
米国住所処理に使用するデータベースを指定します。
Management Console の [米国データベースリソース] パネ
ルで定義されたデータベースのみが使用可能です。
Option.PerformCanadianProcessing
カナダ住所を処理するかどうかを指定します。カナダ住所
処理を有効にすると、GetCandidateAddresses は、カナダ
住所の候補となる住所の取得を試みます。カナダ住所処理
を無効にすると、カナダ住所は失敗します。つまり、Status
出力フィールドに "F" が設定されて返されます。出力フィー
ルド Status.Code は、"DisabledCoder" となります。カナダ
住所処理のライセンスを取得していない場合は、ジョブに
カナダ住所が含まれるか否かにかかわらず、カナダ住所処
理を無効にしなければ、ジョブを正常に実行することはで
きません。
注 : カナダ住所を正常に処理するには、カナダ住所処理の
有効なライセンスを取得する必要があります。カナ
ダ住所処理のライセンスを取得していないか、ライセ
ンスの期限が切れているにもかかわらず、カナダ住所
処理を有効にすると、エラーとなります。
REST Web サービスガイド
Y
カナダ住所を処理します (デフォルト)。
N
カナダ住所を処理しません。
165
Universal Addressing モジュール
パラメータ
説明
Option.Database.Canada
カナダ住所処理に使用するデータベースを指定します。
Management Console の [カナダデータベースリソース] パ
ネルで定義されたデータベースのみが使用可能です。
Option.PerformInternationalProcessing 国際住所 (米国およびカナダ以外の住所) を処理するかどう
かを指定します。国際住所処理を有効にすると、
GetCandidateAddresses は、国際住所の候補となる住所の
取得を試みます。国際住所処理を無効にすると、国際住所
は失敗します。つまり、Status 出力フィールドに "F" が設
定されて返されます。出力フィールド Status.Code
は、"DisabledCoder" となります。国際住所処理のライセン
スを取得していない場合は、ジョブに国際住所が含まれる
か否かにかかわらず、国際住所処理を無効にしなければ、
ジョブを正常に実行することはできません。
注 : 国際住所を正常に処理するには、国際住所処理の有効
なライセンスを取得する必要があります。国際住所
処理のライセンスを取得していないか、ライセンスの
期限が切れているにもかかわらず、国際住所処理を有
効にすると、エラーとなります。
Y
国際住所を処理します (デフォルト)。
N
国際住所を処理しません。
Option.Database.International
国際住所処理に使用するデータベースを指定します。
Management Console の [国際データベースリソース] パネ
ルで定義されたデータベースのみが使用可能です。
Option.OutputCasing
出力データの大文字と小文字の区別を指定します。次のい
ずれかです。
M
出力には、大文字と小文字が混在します (デフォル
ト)。例:
123 Main St
Mytown FL 12345
U
出力に大文字を使用します。例:
123 MAIN ST
MYTOWN FL 12345
Option.MaximumResults
GetCandidateAddresses が返す候補住所の最大数。デフォ
ルトは 10 です。最大数は 10 になります。
Option.OutputShortCityName
米国住所に対し、USPS が承認する都市の略称がある場合
®
®
に、それを返すかどうかを指定します。 USPS は、14 文
字以上の都市名に対し、略称を定めています。都市の略称
は 13 文字以下で、宛名ラベルのサイズが限られている場合
に使用できます。短い都市名が存在しない都市に対しては、
正式な都市名が返されます。
166
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
パラメータ
Option.DualAddressLogic
説明
Y
短い都市名を返します。
N
短い都市名を返しません。
(米国例えば、20706 (米国住所のみ)。ストリート情報と
PO Box/地方配送路/Highway Contract 情報の両方が住所に
含まれる場合に、GetCandidateAddresses が、ストリート
一致を返すか、または PO Box/地方配送路/Highway Contract
一致を返すかを制御します。詳細については、二重住所ロ
ジックについて（199ページ）を参照してください。
N
®
™
(デフォルト) USPS CASS の規則では、以下の優
先順位に基づいて、返す住所を決定します。
1. PO Box
2. Firm
3.
4.
5.
6.
Option.StreetMatchingStrictness
Option.FirmMatchingStrictness
Option.DirectionalMatchingStrictness
REST Web サービスガイド
Highrise
Street
Rural Route
General Delivery
S
住所行に関係なく、ストリート一致を返します。
P
住所行に関係なく、PO Box 一致を返します。
ストリートマッチングの精度 (米国住所のみ)。
E
入力されたストリート名は、データベースに完全に
一致する必要があります。
T
マッチングアルゴリズムは "厳格" です。
M
マッチングアルゴリズムは "中" です (デフォルト)。
L
マッチングアルゴリズムは "あいまい" です。
企業名マッチングの精度 (米国住所のみ)。
E
入力された企業名は、データベースに完全に一致す
る必要があります。
T
マッチングアルゴリズムは "厳格" です。
M
マッチングアルゴリズムは "中" です (デフォルト)。
L
マッチングアルゴリズムは "あいまい" です。
道順マッチングの精度。
E
入力された道順は、データベースに完全に一致する
必要があります。
T
マッチングアルゴリズムは "厳格" です。
M
マッチングアルゴリズムは "中" です (デフォルト)。
L
マッチングアルゴリズムは "あいまい" です。
167
Universal Addressing モジュール
パラメータ
説明
Option.PerformESM
Enhanced Street Matching (ESM) を実行するかどうかを指
定します。 ESM は、通常の住所検証プロセスでマッチしな
かった任意の入力住所に対して、追加データによる別のマッ
チングロジックを適用します。 ESM は、米国住所にのみ
適用されます。
Option.AddressLineSearchOnFail
Y
ESM 処理を実行します。
N
ESM 処理を実行しません (デフォルト)。
ValidateAddress において、住所行で都市、州/省、郵便番号
の検索を行うかどうかを指定します。
このオプションにより、ValidateAddress において、City、
StateProvince、および PostalCode の各入力フィールドの値
を使用して住所にマッチする結果が得られなかった場合に、
AddressLine 入力フィールドで都市、州/省、郵便番号、お
よび国を検索することができます。
入力住所において、AddressLine フィールドに都市、州/省、
および郵便番号の情報が存在する場合は、このオプション
を有効にすることを検討してください。
入力住所において、City、State/Province、および PostalCode
フィールドが使用されている場合は、このオプションを無
効にしてください。このオプションを有効にしてこれらの
フィールドを使用すると、ValidateAddress がこれらのフィー
ルド値の修正 (例えば、スペルミスのある都市名など) に失
敗する可能性が高くなります。
Y
住所行フィールドを検索します (デフォルト)。
N
いいえ、AddressLine フィールドを検索しません。
応答
GetCandidateAddresses は、次の出力を返します。
表 71 : GetCandidateAddresses の出力
168
応答要素
説明
AddressLine1
最初の住所行。
AddressLine2
2 行目の住所行。
AddressLine3
3 行目の住所行。
AddressLine4
4 行目の住所行。
AddressLine5
英国住所専用です。住所の妥当性が確認された場合は、妥当性が確認
され、正規化された住所の 5 行目です。住所の妥当性が確認できな
かった場合は、入力住所の 5 行目がそのまま出力されます。
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
応答要素
説明
City
都市名。
Country
3 文字の ISO 3116-1 Alpha-3 国コード。 ISO コードの一覧は、各国
の ISO コードとモジュールサポート（306ページ）を参照してくださ
い。
FirmName
企業名。
HouseNumberHigh
候補住所の家番号が含まれる範囲の終了家番号。
HouseNumberLow
候補住所の家番号が含まれる範囲の開始家番号。
HouseNumberParity
HouseNumberLow と HouseNumberHigh の間の家番号の番号付けス
キームを次のように示します。
MatchLevel
E
偶数値のみ
O
奇数値のみ
B
両方
米国およびカナダ以外の住所に対し、候補住所のマッチレベルを特定
します。米国およびカナダの住所では常に "A" になります。次のいず
れかです。
A
候補はストリートレベルで入力住所にマッチします。
B
候補は州/省レベルで入力住所にマッチします。
™
PostalCode
郵便番号。米国では、ZIP Code と呼びます。
PostalCode.AddOn
ZIP + 4 Code の末尾 4 桁。米国住所のみ。
RecordType
米国およびカナダの郵政当局によって定義されている住所レコードの
タイプ (米国およびカナダの住所のみサポート):
®
•
•
•
•
•
•
RecordType.Default
FirmRecord
GeneralDelivery
HighRise
PostOfficeBox
RRHighwayContract
Normal
"デフォルト" マッチを示すコード
Y
住所はデフォルトレコードにマッチしています。
NULL
住所はデフォルトレコードにマッチしていません。
StateProvince
州または省の省略形。
Status
マッチの成功または失敗を報告します。
Status.Code
REST Web サービスガイド
NULL
成功
F
失敗
失敗の原因 (ある場合)。次のいずれかの値になります。
169
Universal Addressing モジュール
応答要素
説明
• DisabledCoder
• RequestFailed
Status.Description
問題の説明 (ある場合)。
Did not return multiples
入力住所はデータベース内の 1 つ
の住所とのみマッチしました。
GetCandidateAddresses は、一致
する可能性のある住所が複数見つ
かった場合にデータを返します。
Number of candidates is not
greater than 1
入力住所はデータベース内の複数
の住所にマッチしましたが、住所
が返されませんでした。
PerformUSProcessing disabled Status.Code=DisabledCoder の場
合にこの値が表示されます。
PerformCanadianProcessing
disabled
Status.Code=DisabledCoder の場
合にこの値が表示されます。
PerformInternationalProcessing Status.Code=DisabledCoder の場
disabled
合にこの値が表示されます。
UnitNumberHigh
候補住所のユニット番号が含まれる範囲の終了ユニット番号。
UnitNumberLow
候補住所のユニット番号が含まれる範囲の開始ユニット番号。
UnitNumberParity
UnitNumberLow と UnitNumberHigh の間のユニット番号の番号付けス
キームを次のように示します。
USUrbanName
E
偶数値のみ
O
奇数値のみ
B
両方
妥当性が確認された都市の都市化名。都市化名は、主にプエルトリコ
住所に使用されます。
GetCandidateAddressesLoqate
GetCandidateAddressesLoqate は、与えられた入力住所に一致するとみなされる住所のリストを返し
ます。 GetCandidateAddressesLoqate は、入力住所が郵便データベースの複数の住所にマッチする場
合のみ、候補の住所を返します。入力住所が、郵便データベースの 1 つの住所のみにマッチする場合
は、住所データを返しません。 [Country] 入力フィールドは必須です。このフィールドが空白の場合、
出力は返されません。
注 : デフォルトでは、GetCandidateAddressesLoqate は個々の家番号との一致は確認しません。各
ストリートの家番号の範囲とのマッチングを行います。 GetCandidateAddressesLoqate はスト
リート名、都市名、州/省名、および郵便番号を特定した後、入力された家番号が、マッチしたス
トリート名の家番号の範囲に含まれるかどうかを確認します。ユニット番号についても同様の処
理が行われます。
170
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
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>
REST Web サービスガイド
171
Universal Addressing モジュール
<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>
要求
入力データのパラメータ
GetCandidateAddressesLoqate の入力の一覧を以下の表に示します。
表 72 : 入力フォーマット
パラメータ
説明
Data.AddressLine1
最初の住所行。
Data.AddressLine2
2 行目の住所行。
Data.AddressLine3
3 行目の住所行。
Data.AddressLine4
4 行目の住所行。
Data.City
都市名。
Data.Country
国コードまたは名前を、以下のいずれかのフォーマットで入力しま
す。
• 2 桁の ISO 国コード
• 3 桁の UPU 国コード
• 英語の国名
ISO コードの一覧は、各国の ISO コードとモジュールサポート
（306ページ）を参照してください。
注 : このフィールドは必須です。このフィールドが空白の場合、出
力は返されません。
Data.FirmName
会社名または企業名。
Data.PostalCode
住所の郵便番号。米国住所の場合は、次のいずれかの形式の ZIP Code
™
になります。
Data.StateProvince
172
州または省。
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
パラメータ
説明
米国の住所に限り、州を StateProvince フィールドの代わりに City
フィールドに入れることができます。
オプションのパラメータ
表 73 : GetCandidateAddressesLoqate のオプション
パラメータ
説明
Option.Database.Loqate
住所処理に使用するデータベースを指定します。 Management Console
で定義されたデータベースのみが使用可能です。
Option.OutputCasing
出力データの大文字と小文字の区別を指定します。次のいずれかで
す。
M
出力には、大文字と小文字が混在します (デフォルト)。例:
123 Main St
Mytown FL 12345
U
出力に大文字を使用します。例:
123 MAIN ST
MYTOWN FL 12345
Option.HomeCountry
デフォルト国を指定します。大部分の住所が存在する国を指定してく
ださい。例えば、処理する住所の大部分がカナダにある場合は、カナ
ダを指定します。 GetCandidateAddressLoqate は、州/省、郵便番号、
国の各住所フィールドから国を特定できなかった場合、指定された国
を使用して、住所の検証を試みます。有効な国名には次のものがあり
ます。
Afghanistan, Albania, Algeria, American Somoa, Andorra, Angola,
Anguilla, Antigua And Barbuda, Argentina, Armenia, Aruba, Australia,
Austria, Azerbaijan, Bahamas, Bahrain, Bangladesh, Barbados, Belarus,
Belgium, Belize, Benin, Bermuda, Bhutan, Bolivia, Bosnia And
Herzegovina, Botswana, Brazil, British Virgin Islands, Brunei
Darussalam, Bulgaria, Burkina Faso, Burundi, Cambodia, Cameroon,
Canada, Cape Verde, Cayman Islands, Central African Republic, Chad,
Chile, China, Colombia, Comoros Islands, Congo, Cook Islands, Costa
Rica, Cote D'Ivoire, Croatia, Cuba, Cyprus, Czech Republic, Democratic
Republic Of Congo, Denmark, Djibouti, Dominica, Dominican Republic,
East Timor, Ecuador, Egypt, El Salvador, Equitorial Guinea, Eritrea,
Estonia, Ethiopia, Falkland Islands, Faroe Islands, Federated States Of
Micronesia, Fiji, Finland, France, French Guiana, Gabon, Gambia,
Germany, Ghana, Gibraltar, Greece, Greenland, Grenada, Guadeloupe,
Guam, Guatemala, Guinea, Guinea Bissau, Guyana, Haiti, Holy See,
Honduras, Hong Kong, Hungary, Iceland, India, Indonesia, Iran, Iraq,
Ireland, Israel, Italy, Jamaica, Japan, Jordan, Kazakhstan, Kenya,
Kiribati, Korea, Kuwait, Kyrgyzstan, Laos, Latvia, Lebanon, Lesotho,
Liberia, Libya, Liechtenstein, Lithuania, Luxembourg, Macau, Macedonia,
Madagascar, Malawi, Malaysia, Maldives, Mali, Malta, Marshall Islands,
REST Web サービスガイド
173
Universal Addressing モジュール
パラメータ
説明
Martinique, Mauritania, Mauritius, Mayotte, Mexico, Moldova, Monaco,
Mongolia, Monserrat, Morocco, Mozambique, Myanmar, Namibia, Nauru,
Nepal, Netherlands Antilles, New Caledonia, New Zealand, Nicaragua,
Niger, Nigeria, Niue, Norway, Oman, Pakistan, Palau, Panama, Papua
New Guinea, Paraguay, Peru, Philippines, Pitcairn Islands, Poland,
Portugal, Puerto Rico, Qatar, Republic Of Georgia, Republic Of Korea,
Republic Of Singapore, Reunion, Romania, Russia, Rwanda, Saint
Helena, Saint Kitts And Nevis, Saint Lucia, Saint Pierre And Miquelon,
Saint Vincent And The Grenadines, Samoa, San Marino, Sao Tome
And Principe, Saudi Arabia, Senegal, Seychelles, Sierra Leone, Slovakia,
Slovenia, Solomon Islands, Somalia, South Africa, Spain, Sri Lanka,
Sudan, Surivalue, Swaziland, Sweden, Switzerland, Syria, Tahiti, Taiwan,
Tajikistan, Tanzania, Thailand, The Netherlands, Togo, Tonga, Trinidad
And Tobago, Tristan Da Cunha, Tunisia, Turkey, Turkmenistan, Turks
And Caicos Islands, Tuvalu, Uganda, Ukraine, United Arab Emirates,
United Kingdom, United States, Uruguay, Uzbekistan, Vanuatu,
Venezuela, Vietnam, Virgin Islands (US), Wallis And Futuna, Yemen,
Yugoslavia, Zambia, Zimbabwe
Option.OutputCountryFormat Country 出力フィールドに返される国名に使用するフォーマットを指
定します。例えば、英語を選択した場合、"Deutschland" という国名
は "Germany" として返されます。
Option.OutputScript
Option.MaximumResults
E
英語の国名を使用します (デフォルト)。
I
国名の代わりにその国の 2 文字の ISO の略語を使用します。
U
国名の代わりにその国の万国郵便連合 (Universal Postal Union:
UPU) の略語を使用します。
出力がどのアルファベットまたはスクリプトで返されるかを指定しま
す。このオプションは双方向で、通常はネイティブからラテン文字
へ、およびラテン文字からネイティブへ実行されます。
Input
書き直しを実行せず、入力と同じスクリプトで出力し
ます (デフォルト)。
Native
使用可能な場合は、選択した国のネイティブスクリプ
トで出力します。
Latn
英語の値を使用します。
GetCandidateAddressesLoqate が返す候補住所の最大数。デフォル
トは 10 です。最大数は 99 です。
応答
GetCandidateAddressesLoqate は、次の出力を返します。
174
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
表 74 : GetCandidateAddressesLoqate の出力
応答要素
説明
AddressLine1
最初の住所行。
AddressLine2
2 行目の住所行。
AddressLine3
3 行目の住所行。
AddressLine4
4 行目の住所行。
City
都市名。
Country
3 文字の ISO 3116-1 Alpha-3 国コード。 ISO コードの一覧は、各国
の ISO コードとモジュールサポート（306ページ）を参照してくださ
い。
FirmName
企業名。
PostalCode
郵便番号。米国では、 ZIP Code になります。
PostalCode.AddOn
ZIP + 4 Code の末尾 4 桁。米国住所にのみ適用されます。
ProcessedBy
住所を処理した住所コーダーを示します。
™
®
LOQATE
Loqate コーダーが住所を処理しています。
StateProvince
州または省の省略形。
Status
マッチの成功または失敗を報告します。
Status.Code
NULL
成功
F
失敗
失敗の原因 (ある場合)。次のいずれかの値になります。
• RequestFailed
Status.Description
問題の説明 (ある場合)。次のいずれかの値になります。
Did not return 入力住所はデータベース内の 1 つの住所とのみマッ
multiples
チしました。 GetCandidateAddressesLoqate は、一
致する可能性のある住所が複数見つかった場合のみ
データを返します。
GetCityStateProvince
GetCityStateProvince は、与えられた入力郵便番号に対する都市および州/省を返します。
注 : GetCityStateProvince は、米国およびカナダの住所のみに対応します。
GetCityStateProvince は、Universal Addressing モジュールに含まれています。
REST Web サービスガイド
175
Universal Addressing モジュール
リソース URL
JSON エンドポイント:
http://server:port/rest/GetCityStateProvince/results.json
XML エンドポイント:
http://server:port/rest/GetCityStateProvince/results.xml
JSON 応答の例
次の例では、JSON 応答を要求します。
http://myserver:8080/rest/GetCityStateProvince/results.json?
Data.PostalCode=12180
この要求から次のような JSON が返されます。
{"output_port": [{
"ProcessedBy": "USA",
"PostalCode": "12180",
"City": "TROY",
"StateProvince": "NY",
"Country": "USA",
"City.Type": "P",
"user_fields": []
}]}
XML 応答の例
次の例では、XML 応答を要求します。
http://myserver:8080/rest/GetCityStateProvince/results.xml?
Data.PostalCode=12180
この要求から次のような XML が返されます。
<ns2:xml.GetCityStateProvinceResponse
xmlns:ns2="http://www.pb.com/spectrum/services/GetCityStateProvince">
<ns2:output_port>
<ns2:Result>
<ns2:ProcessedBy>USA</ns2:ProcessedBy>
<ns2:PostalCode>12180</ns2:PostalCode>
<ns2:City>TROY</ns2:City>
<ns2:City.Type>P</ns2:City.Type>
<ns2:StateProvince>NY</ns2:StateProvince>
<ns2:Country>USA</ns2:Country>
<ns2:user_fields/>
</ns2:Result>
</ns2:output_port>
</ns2:xml.GetCityStateProvinceResponse>
要求
入力データのパラメータ
入力フィールドを以下の表に示します。
176
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
表 75 : GetCityStateProvince の入力
パラメータ
説明
Data.PostalCode
米国企業の ZIP Code またはカナダの郵便番号を次のいずれかのフォー
™
マットで示します。
99999
99999-9999
A9A9A9
A9A 9A9
オプションのパラメータ
表 76 : Get City State Province Loqate
パラメータ名
説明
Option.PerformUSProcessing 米国住所を処理するかどうかを指定します。米国住所処理を有効に
した場合、GetCityStateProvince は米国住所の州を返します。住所を
サポートしていません。米国住所処理を無効にすると、米国住所は
失敗します。つまり、Status 出力フィールドに "F" が設定されて返さ
れます。出力フィールド Status.Code は、"DisabledCoder" となりま
す。米国住所処理のライセンスを取得していない場合は、ジョブに
米国住所が含まれるか否かにかかわらず、米国住所処理を無効にしな
ければ、ジョブを正常に実行することはできません。住所をサポート
していません。
注 : 米国住所を正常に処理するには、米国住所処理の有効なライセ
ンスを取得する必要があります。住所をサポートしていませ
ん。米国住所処理のライセンスを取得していないか、ライセン
スの期限が切れているにもかかわらず、米国住所処理を有効に
すると、エラーとなります。
Option.Database.US
Y
米国住所を処理します (デフォルト)。
N
米国住所を処理しません。
米国住所処理に使用するデータベースを指定します。 Management
Console の [米国データベースリソース] パネルで定義されたデータ
ベースのみが使用可能です。
Option.PerformCanadianProcessing カナダ住所を処理するかどうかを指定します。カナダ住所処理を有効
にした場合、GetCityStateProvince はカナダ住所の州を返します。カ
ナダ住所処理を無効にすると、カナダ住所は失敗します。つまり、
Status 出力フィールドに "F" が設定されて返されます。出力フィール
ド Status.Code は、"DisabledCoder" となります。カナダ住所処理の
ライセンスを取得していない場合は、ジョブにカナダ住所が含まれる
か否かにかかわらず、カナダ住所処理を無効にしなければ、ジョブを
正常に実行することはできません。
REST Web サービスガイド
177
Universal Addressing モジュール
パラメータ名
説明
注 : カナダ住所を正常に処理するには、カナダ住所処理の有効なラ
イセンスを取得する必要があります。カナダ住所処理のライセ
ンスを取得していないか、ライセンスの期限が切れているにも
かかわらず、カナダ住所処理を有効にすると、エラーとなりま
す。
Y
カナダ住所を処理します (デフォルト)。
N
カナダ住所を処理しません。
Option.Database.Canada
カナダ住所処理に使用するデータベースを指定します。 Management
Console の [カナダデータベースリソース] パネルで定義されたデー
タベースのみが使用可能です。
Option.OutputVanityCity
非正式な都市名を出力に含めるかどうかを指定します。非正式な都市
名は、主要都市名の代替名です。例えば、Hollywood は Los Angeles
の非正式な都市名です。
Option.MaximumResults
Y
非正式な都市名を含めます。
N
非正式な都市名を含めません (デフォルト)。
返される都市と州/省のペアの最大数を指定します。デフォルト値は
10 です。
応答
GetCityStateProvince は、入力郵便番号に一致する都市と州/省、およびマッチングの成功または失敗
を示すコードを返します。複数の都市/州または都市/省が入力郵便番号にマッチする場合、複数の出
力レコードが返されます。
表 77 : GetCityStateProvince の出力
応答要素
説明
City
一致した都市名。
City.Type
USPS によって正規化された都市名のタイプ (米国住所のみ)。例え
®
ば、20706 (米国住所のみ)。
178
V
非正式 (Non-Mailing) 都市名。
P
主要都市名。都市名は、主要な郵送都市名です。
S
補助的な都市名。都市名は、代替都市名ですが、許容されま
す。都市は複数の補助的な都市名を持つことができます。
PostalCode
入力郵便番号。
ProcessedBy
住所を処理した住所コーダーを示します。次のいずれかです。
USA
米国住所コーダーが住所を処理しました。
CAN
カナダ住所コーダーが住所を処理しました。
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
応答要素
説明
StateProvince
州または省の省略形。
Status
マッチの成功または失敗を報告します。
Status.Code
NULL
成功
F
失敗
失敗の原因 (ある場合)。次の値のみが有効です。
• DisabledCoder
• UnrecognizedPostalCode
Status.Description
失敗の説明。有効な値は次のとおりです。
Postal code not found
Status.Code=UnrecognizedPostalCode
の場合にこの値が表示されます。
PerformUSProcessing
disabled
Status.Code=DisabledCoder の場合に
この値が表示されます。
PerformCanadianProcessing Status.Code=DisabledCoder の場合に
disabled
この値が表示されます。
GetCityStateProvinceLoqate
GetCityStateProvinceLoqate は、与えられた入力郵便番号に対する都市および州/省を返します。
このステージは、Universal Addressing モジュールに含まれています。
リソース URL
JSON エンドポイント:
http://server:port/rest/GetCityStateProvinceLoqate/results.json
XML エンドポイント:
http://server:port/rest/GetCityStateProvinceLoqate/results.xml
JSON 応答の例
次の例では、JSON 応答を要求します。
http://myserver:8080/rest/GetCityStateProvinceLoqate/results.json?
Data.Country=USA&Data.PostalCode=60510
この要求から次のような JSON が返されます。
{"output_port": [{
"ProcessedBy": "LOQATE",
"PostalCode": "60510",
"City": "Batavia",
"StateProvince": "IL",
"Country": "United States",
"Status": "",
REST Web サービスガイド
179
Universal Addressing モジュール
"Status.Code": "",
"Status.Description": "",
"user_fields": []
}]}
XML 応答の例
次の例では、XML 応答を要求します。
http://myserver:8080/rest/GetCityStateProvinceLoqate/results.xml?Data.Country=USA&
Data.PostalCode=60510
この要求から次のような XML が返されます。
<ns2:xml.GetCityStateProvinceLoqateResponse
xmlns:ns2="http://www.pb.com/spectrum/services/GetCityStateProvinceLoqate">
<ns2:output_port>
<ns2:Result>
<ns2:ProcessedBy>LOQATE</ns2:ProcessedBy>
<ns2:PostalCode>60510</ns2:PostalCode>
<ns2:City>Batavia</ns2:City>
<ns2:StateProvince>IL</ns2:StateProvince>
<ns2:Country>United States</ns2:Country>
<ns2:Status/>
<ns2:Status.Code/>
<ns2:Status.Description/>
<ns2:user_fields/>
</ns2:Result>
</ns2:output_port>
</ns2:xml.GetCityStateProvinceLoqateResponse>
要求
入力データのパラメータ
入力フィールドを以下の表に示します。
表 78 : GetCityStateProvinceLoqate の入力
パラメータ
説明
Data.Country
国コードまたは名前を、以下のいずれかのフォーマットで入力しま
す。
• 2 桁の ISO 国コード
• 3 桁の UPU 国コード
• 英語の国名
ISO コードの一覧は、各国の ISO コードとモジュールサポート
（306ページ）を参照してください。
Data.PostalCode
180
住所の郵便番号。
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
オプション
表 79 : GetCityStateProvinceLoqate のオプション
説明/有効値
住所処理に使用するデータベースを指定します。 Management Console
の [データベースリソース] パネルで定義されたデータベースのみが
使用可能です。
GetCityStateProvinceLoqate が返す必要がある住所の最大数。デフォ
ルトは 10 です。
出力がどのアルファベットまたはスクリプトで返されるかを指定しま
す。このオプションは双方向で、通常はネイティブからラテン文字
へ、およびラテン文字からネイティブへ実行されます。
書き直しを実行せず、入力と同じスクリプトで出力します (デフォル
ト)。
使用可能な場合は、選択した国のネイティブスクリプトで出力しま
す。
英語の値を使用します。
データライセンスエラーの発生時に Spectrum Technology Platform
がどのように応答するかを指定します。
ジョブのエラー
データライセンスエラーが発生した場合、ジョ
ブ全体をエラーにします。
レコードのエラーデータライセンスエラーの発生原因となったレ
コードをエラーにし、処理を続行します。
応答
GetCityStateProvinceLoqate は、入力郵便番号に一致する都市と州/省、およびマッチングの成功また
は失敗を示すコードを返します。複数の都市/州または都市/省が入力郵便番号にマッチする場合、複
数の出力レコードが返されます。
表 80 : GetCityStateProvinceLoqate の出力
応答要素
説明
City
一致した都市名。
Country
で選択した、以下のいずれかのフォーマットで示された国。
• ISO コード
• UPU コード
• 英語
PostalCode
REST Web サービスガイド
入力郵便番号。
181
Universal Addressing モジュール
応答要素
説明
ProcessedBy
住所を処理した住所コーダーを示します。
LOQATE
Loqate コーダーが住所を処理しています。
StateProvince
州または省の省略形。
Status
マッチの成功または失敗を報告します。
Status.Code
NULL
成功
F
失敗
失敗の原因 (ある場合)。次の値のみが有効です。
• UnrecognizedPostalCode
Status.Description
失敗の説明。次の値のみが有効です。
Postal code not
found
Status.Code=UnrecognizedPostalCode の場
合にこの値が表示されます。
GetPostalCodes
GetPostalCodes では、特定の都市の郵便番号の検索が可能です。このサービスは、都市、州、およ
び国を入力として受け取り、その都市の郵便番号を返します。入力を正しい順序で指定しなければ、
郵便番号は返されません。
注 : GetPostalCodes は、米国住所にのみ対応します。住所をサポートしていません。
GetPostalCodes は、Universal Addressing モジュールに含まれています。
リソース URL
JSON エンドポイント:
http://server:port/rest/GetPostalCodes/results.json
XML エンドポイント:
http://server:port/rest/GetPostalCodes/results.xml
JSON 応答の例
次の例では、JSON 応答を要求します。
http://myserver:8080/rest/GetPostalCodes/results.json?
Data.City=Holland&Data.StateProvince=MI
この要求から次のような JSON が返されます。
{"output_port": [
{
"ProcessedBy": "USA",
"PostalCode": "49422",
"Status": "",
"City.Type": " ",
182
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
"Status.Code": "",
"Status.Description": "",
"user_fields": []
},
{
"ProcessedBy": "USA",
"PostalCode": "49423",
"Status": "",
"City.Type": " ",
"Status.Code": "",
"Status.Description": "",
"user_fields": []
},
{
"ProcessedBy": "USA",
"PostalCode": "49424",
"Status": "",
"City.Type": " ",
"Status.Code": "",
"Status.Description": "",
"user_fields": []
}
]}
XML 応答の例
次の例では、XML 応答を要求します。
http://myserver:8080/rest/GetPostalCodes/results.xml?Data.City=Holland&
Data.StateProvince=MI
この要求から次のような XML が返されます。
<ns2:xml.GetPostalCodesResponse
xmlns:ns2="http://www.pb.com/spectrum/services/GetPostalCodes">
<ns2:output_port>
<ns2:Result>
<ns2:ProcessedBy>USA</ns2:ProcessedBy>
<ns2:PostalCode>49422</ns2:PostalCode>
<ns2:City.Type></ns2:City.Type>
<ns2:Status/>
<ns2:Status.Code/>
<ns2:Status.Description/>
<ns2:user_fields/>
</ns2:Result>
<ns2:Result>
<ns2:ProcessedBy>USA</ns2:ProcessedBy>
<ns2:PostalCode>49423</ns2:PostalCode>
<ns2:City.Type></ns2:City.Type>
<ns2:Status/>
<ns2:Status.Code/>
<ns2:Status.Description/>
<ns2:user_fields/>
</ns2:Result>
<ns2:Result>
<ns2:ProcessedBy>USA</ns2:ProcessedBy>
<ns2:PostalCode>49424</ns2:PostalCode>
<ns2:City.Type></ns2:City.Type>
<ns2:Status/>
<ns2:Status.Code/>
<ns2:Status.Description/>
<ns2:user_fields/>
</ns2:Result>
</ns2:output_port>
</ns2:xml.GetPostalCodesResponse>
REST Web サービスガイド
183
Universal Addressing モジュール
要求
入力データのパラメータ
GetPostalCodes は、都市、州/省、および国を入力として受け取ります。
表 81 : GetPostalCodes の入力
パラメータ
説明
Data.City
郵便番号を検索する都市。
City フィールドに都市と州を入力できます。これを行う場合は、
StateProvince フィールドを空白のままにする必要があります。
City および StateProvince フィールドの文字数が 100 文字を超えては
なりません。
Data.StateProvince
郵便番号を検索する都市の州または省。
州は、StateProvince フィールドではなく、City フィールドに入力す
ることもできます。
City および StateProvince フィールドの文字数が 100 文字を超えては
なりません。
Data.Country
郵便番号を検索する都市の国コードまたは名前。有効な値は US のみ
です。
オプションのパラメータ
表 82 : GetPostalCodes のオプション
パラメータ
説明
Option.Database.US
郵便番号検索に使用するデータベースを指定します。 Management
Console の [米国データベースリソース] パネルで定義されたデータ
ベースのみが使用可能です。
Option.IncludeVanityCity
都市の非正式な都市名の郵便番号を含めるかどうかを指定します。非
正式な都市名は、主要都市名の代替名です。例えば、Hollywood は
Los Angeles の非正式な都市名です。
Option.OutputCityType
184
Y
非正式な都市名の郵便番号を含めます。
N
非正式な都市名の郵便番号を含めません (デフォルト)。
都市タイプを出力で返すかどうかを指定します。有効にすると、都市
タイプが City.Type フィールドに返されます。
Y
都市タイプを出力に含めます。
N
都市タイプを出力に含めません (デフォルト)。
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
応答
GetPostalCodes は、指定された都市の郵便番号を返します。各郵便番号は、以下の表に列挙された
データとともにそれぞれ個別のレコードで返されます。
表 83 : GetPostalCodes の出力
応答要素
説明
City.Type
USPS の都市タイプ (米国住所のみ)。例えば、20706 (米国住所の
®
み)。都市タイプを判別するには、ZIP Code と都市名を調べます。例
えば、メリーランド州ランハムの郵便番号は、20703、20706、およ
び 20784 です。ランハムは、20703 と 20706 では主要都市ですが、
20784 では非正式都市です。
このフィールド列に値が設定されるのは、場合のみです。有効な値を
次に示します。
V
非正式 (Non-Mailing) 都市名。
P
主要都市名。都市名は、主要な郵送都市名です。
S
補助的な都市名。都市名は、代替都市名ですが、許容されま
す。都市は複数の補助的な都市名を持つことができます。
PostalCode
指定された都市の郵便番号。
ProcessedBy
このサービスは米国住所に対してのみ機能するため、 ProcessedBy に
は常に USA という 1 つの値が含まれます。
Status
マッチの成功または失敗を報告します。
Status.Code
NULL
成功
F
失敗
失敗の原因 (ある場合)。次のいずれかです。
• CountryNotSupported
• UnableToLookup
Status.Description
失敗の説明。
• 入力された国がサポートされていません
• 入力された都市が空白でした
• 入力された都市と州 / 省が空白であったか、一致が見つかりません
でした
• 都市と州の不一致 (スペルの相違が見つかるか、都市/州が非正式都
市であるが、非正式マッチングが許可されていないか、都市/州が
ZIP Code と一致しない)
REST Web サービスガイド
185
Universal Addressing モジュール
ValidateAddress
ValidateAddress は、郵便当局の住所データを使用して、住所を正規化し、妥当性を確認します。
ValidateAddress は、情報を修正し、管轄の郵便当局が推奨する書式で住所の書式を整えることができ
ます。また、郵便番号、都市名、州/省名など、欠落している郵便情報を追加します。
ValidateAddress は、ValidateAddress が住所の妥当性を確認したかどうか、返した住所の確信レベル、
住所の妥当性が確認できなかった場合はその理由など、バリデーション処理に関する結果インジケー
タも返します。
ValidateAddress は、住所のマッチングと正規化において、住所行をコンポーネントに分割し、それら
を Universal Addressing モジュールの各種データベースの内容と比較します。マッチを検出した場
合、入力住所をデータベース情報に合わせて正規化します。データベースにマッチしなかった場合、
ValidateAddress は、オプションで入力住所の書式を整えます。書式設定プロセスでは、該当する郵
便当局の規則に従って住所行の構成を試みます。
ValidateAddress は、Universal Addressing モジュールに含まれています。
リソース URL
JSON エンドポイント:
http://server:port/rest/ValidateAddress/results.json
XML エンドポイント:
http://server:port/rest/ValidateAddress/results.xml
JSON 応答の例
次の例では、JSON 応答を要求します。
http://myserver:8080/rest/ValidateAddress/results.json?Data.AddressLine1=
1825+Kramer+Ln&Data.PostalCode=78758
この要求から次のような JSON が返されます。
{"output_port": [{
"Confidence": "100",
"RecordType": "Normal",
"CountryLevel": "A",
"ProcessedBy": "USA",
"MatchScore": "0",
"AddressLine1": "1825 Kramer Ln",
"City": "Austin",
"StateProvince": "TX",
"PostalCode": "78758-4260",
"Country": "United States Of America",
"PostalCode.Base": "78758",
"PostalCode.AddOn": "4260",
"user_fields": []
}]}
XML 応答の例
次の例では、XML 応答を要求します。
http://myserver:8080/rest/ValidateAddress/results.xml?Data.AddressLine1=
1825+Kramer+Ln&Data.PostalCode=78758
186
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
この要求から次のような XML が返されます。
<ns2:xml.ValidateAddressResponse
xmlns:ns2="http://www.pb.com/spectrum/services/ValidateAddress">
<ns2:output_port>
<ns2:Address>
<ns2:Confidence>93</ns2:Confidence>
<ns2:RecordType>Normal</ns2:RecordType>
<ns2:CountryLevel>A</ns2:CountryLevel>
<ns2:ProcessedBy>USA</ns2:ProcessedBy>
<ns2:MatchScore>0</ns2:MatchScore>
<ns2:AddressLine1>1825 Kramer Ln</ns2:AddressLine1>
<ns2:City>Austin</ns2:City>
<ns2:StateProvince>TX</ns2:StateProvince>
<ns2:PostalCode>78758-4260</ns2:PostalCode>
<ns2:PostalCode.Base>78758</ns2:PostalCode.Base>
<ns2:PostalCode.AddOn>4260</ns2:PostalCode.AddOn>
<ns2:Country>United States Of America</ns2:Country>
<ns2:user_fields/>
</ns2:Address>
</ns2:output_port>
</ns2:xml.ValidateAddressResponse>
要求
入力データのパラメータ
ValidateAddress は、入力として住所を受け取ります。住所がある国にかかわらず、すべての国がこ
のフォーマットを使用します。米国住所に対する住所行データの処理方法に関する重要な情報につい
ては、「米国住所に対する住所行処理（189ページ）」を参照してください。住所をサポートしてい
ません。
表 84 : 入力フォーマット
パラメータ
フォー
マット
説明
Data.AddressLine1
文字列
[50]
最初の住所行。
Data.AddressLine2
文字列
[50]
2 行目の住所行。
Data.AddressLine3
文字列
[50]
3 行目の住所行。
文字列
[50]
4 行目の住所行。
文字列
[50]
5 行目の住所行。
文字列
[50]
都市名。
Data.AddressLine5
Data.AddressLine5
Data.City
REST Web サービスガイド
カナダの住所には適用されません。
カナダの住所には適用されません。
英国住所にのみ適用されます。ストリート名、ユニット番
号、ビルディング番号などを含めることができます。
米国住所に対しては、米国の住所に限り、都市、州、およ
™
び ZIP Code を City フィールドに入力することができま
187
Universal Addressing モジュール
パラメータ
フォー
マット
説明
す。これを行う場合は、StateProvince フィールドと
PostalCode フィールドを空白のままにする必要があります。
Data.StateProvince
Data.PostalCode
文字列
[50]
州または省。
文字列
[10]
住所に対する郵便番号を次のいずれかのフォーマットで示
します。
米国の住所に限り、州を StateProvince フィールドの代わり
に City フィールドに入れることができます。
99999
99999-9999
A9A9A9
A9A 9A9
9999 999
™
米国住所に対しては、米国の住所に限り、 ZIP Code を
City フィールドに入力することができます。
™
米国住所に対しては、米国の住所に限り、都市/州/ZIP Code
が PostalCode フィールドにある場合に、ValidateAddress
がデータをパーシングして、住所を正しく処理することが
できます。最適な結果を得るため、このデータを適切な
フィールド (City、StateProvince、PostalCode) に入力して
ください。
Data.Country
文字列
[50]
国コードまたは名前を、以下のいずれかのフォーマットで
入力します。
• 2 文字の ISO 3116-1 Alpha-2 国コード
• 3 文字の ISO 3116-1 Alpha-3 国コード
• 英語の国名
• フランス語の国名
• ドイツ語の国名
• スペイン語の国名
ISO コードの一覧は、各国の ISO コードとモジュールサ
ポート（306ページ）を参照してください。
Data.FirmName
文字列
[50]
会社名または企業名。
Data.USUrbanName
文字列
[50]
米国住所都市化名。主にプエルトリコの住所で使用されま
す。
Data.CustomerID
文字列
[9]
この郵便物が汎用バーコードを使用している場合、USPS
®
が割り当てた顧客 ID をこのフィールドに指定します。
®
ValidateAddress の汎用バーコードは、OneCode ACS サー
ビスを使用する郵便物に使用されます。
188
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
パラメータ
フォー
マット
説明
Data.CanLanguage
文字列
カナダの住所に限り、Option.CanFrenchFormat=T オプショ
ンが使用されている場合に、住所が英語かフランス語かを
示します。
このフィールドが空白の場合、アドレスは英語でフォーマッ
トされています。このフィールドに空白以外の値が含まれ
る場合、住所はフランス語でフォーマットされています。
ケベックの住所は、このフィールドの値に関係なく常にフ
ランス語でフォーマットされます。
米国住所に対する住所行処理
米国住所の場合、AddressLine1 から AddressLine4 の入力フィールドの処理方法は、企業名抽出また
は都市化コード抽出のオプションが有効になっているかどうかによって異なります。 2 つのオプショ
ンのいずれかが有効になっている場合は、ValidateAddress は、4 つすべてのフィールドのデータを参
照して、住所の妥当性を確認し、要求されたデータ (企業名または都市化コード) を抽出します。どち
らのオプションも有効でない場合は、ValidateAddress は、空白でない最初の 2 つの住所行フィールド
のみを使用して、妥当性を確認します。他の住所行フィールドのデータは、AdditionalInputData 出力
フィールドに返されます。例を次に示します。
AddressLine1: A1 Calle A
AddressLine2:
AddressLine3: URB Alamar
AddressLine4: Pitney Bowes Software
この住所において、企業名抽出または都市化コード抽出が有効である場合は、ValidateAddress は、4
つすべての住所行を確認します。企業名抽出と都市化コード抽出がどちらも有効でない場合は、
ValidateAddress は、AddressLine1 と AddressLine3 (空白でない最初の 2 つの住所行) を参照して、そ
のデータを使用して住所の妥当性を確認します。AddressLine4 のデータは、AdditionalInputData 出力
フィールドに返されます。
オプションのパラメータ
出力データオプション
以下の表に、ValidateAddress が返す情報の種類を制御するオプションの一覧を示します。これらの
オプションのうちの一部は、カナダ住所に対してオーバーライドすることができます。詳細について
は、カナダ住所のオプション（210ページ）を参照してください。
表 85 : 出力データオプション
パラメータ
説明
Option.OutputRecordType
出力レコードのタイプ。 1 つ以上の場合はリストで提供さ
れます。
A 住所データの 1 ～ 4 行に加えて、都市、州、郵便番号、
企業名、および都市化名情報を返します。各住所行
は、封筒に記載される住所の実際の行に対応していま
す。詳細については、応答（219ページ）を参照してく
ださい。 ValidateAddress が住所の妥当性を確認でき
た場合は、住所行には正規化済み住所が含まれます。
正規化済み住所では、句読文字が取り除かれ、方向指
REST Web サービスガイド
189
Universal Addressing モジュール
パラメータ
説明
示とストリート接尾語には省略形が使用され、住所要
素が修正されています。 ValidateAddress が住所の妥
当性を確認できなかった場合は、住所行には入力住所
がそのまま含まれます ("パススルー" データ)。
OutputRecordType=A を指定しなかった場合でも、妥
当性が確認されなかった住所は必ず、パススルーデー
タとして住所行フィールドに含まれます。
E パース済み住所要素。家番号、ストリート名、スト
リート接尾語、方向指示などの住所の各要素が、個別
のフィールドに返されます。詳細については、パース
済み住所要素出力（221ページ）を参照してください。
"E" を指定し、OutputFormattedOnFail=Y を指定した
場合は、パース済み住所要素に、妥当性が確認できな
かった住所の入力住所が含まれることになります。
I
パース済み入力。このオプションでは、
ValidateAddress が住所の妥当性を確認できたかどうか
にかかわらず、入力住所をパース済み形式で返します。
家番号、ストリート名、ストリート接尾語、方向指示
などの入力住所の各要素が、個別のフィールドに返さ
れます。パース済み入力 (値 "I") は、妥当性を確認でき
なかった入力だけでなく、すべての入力住所をパース
済み形式で返す点で、OutputRecordType=E と
OutputFormattedOnFail=Y の組み合わせとは異なり
ます。詳細については、パース済み入力（222ページ）
を参照してください。
P 郵便データ。出力住所には、妥当性が確認された各住
所の追加データが含まれます。詳細については、郵便
データ出力（224ページ）を参照してください。
空住所データまたは郵便データを返しません。
白
Option.OutputFieldLevelReturnCodes
Option.OutputFormattedOnFail
190
フィールドレベルの結果インジケータを含めるかどうかを
指定します。フィールドレベルの結果インジケータは、
ValidateAddress が各住所要素をどのように処理したかを示
します。フィールドレベルの結果インジケータは、修飾子
"Result" で返されます。例えば、HouseNumber のフィール
ドレベルの結果インジケータは HouseNumber.Result に格
納されます。結果インジケータの出力フィールドの完全な
一覧は、フィールドレベルの結果インジケータ（229ページ）
を参照してください。
N
フィールドレベルのリターンコードを出力しません
(デフォルト)。
Y
フィールドレベルのリターンコードを出力します。
住所の妥当性を確認できない場合に書式を整えた住所を返
すかどうかを指定します。住所には、その国の標準住所書
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
パラメータ
説明
式が設定されます。このオプションを選択しない場合、
ValidateAddress が住所の妥当性を確認できないと、出力住
所フィールドは空白になります。
注 : このオプションは、米国およびカナダの住所のみに適
用されます。その他の住所に対して書式を整えたデー
タは返されません。
N
失敗した住所の書式を整えません (デフォルト)。
Y
失敗した住所の書式を整えます。
OutputRecordType オプションで指定されたフォーマットを
使用して、書式を整えた住所が返されます。
OutputRecordType=E を指定した場合は、妥当性が確認で
きた住所に対しては、パース済みで妥当性を確認済みの住
所が、パース済み住所要素に含まれることに注意してくだ
さい。住所の妥当性が確認できなかった場合には、パース
済み住所要素には、入力住所がパース済み形式で含まれる
ことになります。 ValidateAddress が住所の妥当性を確認で
きたかどうかにかかわらず、必ず入力住所をパース済み形
式で出力したい場合は、OutputRecordType=I を指定しま
す。
Option.OutputRecordType オプションで指定されたフォー
マットを使用して、書式を整えた住所が返されます。
Option.OutputRecordType=E を指定した場合は、妥当性が
確認できた住所に対しては、パース済みで妥当性を確認済
みの住所が、パース済み住所要素に含まれることに注意し
てください。住所の妥当性が確認できなかった場合には、
パース済み住所要素には、入力住所がパース済み形式で含
まれることになります。 ValidateAddress が住所の妥当性を
確認できたかどうかにかかわらず、必ず入力住所をパース
済み形式で出力したい場合は、Option.OutputRecordType=I
を指定します。
[標準住所を含める]、[住所行の要素を含める]、および [郵便
情報を含める] の各チェックボックスで指定されたフォー
マットを使用して、書式を整えた住所が返されます。 [住所
行の要素を含める] を選択した場合は、妥当性が確認できた
住所に対しては、パース済みで妥当性を確認済みの住所が、
パース済み住所要素に含まれることに注意してください。
住所の妥当性が確認できなかった場合には、パース済み住
所要素には、入力住所がパース済み形式で含まれることに
なります。 ValidateAddress が住所の妥当性を確認できたか
どうかにかかわらず、必ず入力住所をパース済み形式で出
力したい場合は、[正規化された入力住所要素を含める] を選
択します。
Y を指定する場合は、OutputRecordType に対して "A" と
"E" またはそのいずれかを指定する必要があります。
REST Web サービスガイド
191
Universal Addressing モジュール
パラメータ
説明
Y を指定する場合は、Option.OutputRecordType に対して
"A" と "E" またはそのいずれかを指定する必要があります。
このオプションをオンにする場合は、[標準住所を含める] と
[住所行の要素を含める] またはそのいずれかを選択する必要
があります。
Option.OutputStreetNameAlias
Option.OutputStreetNameAlias
米国住所に対してのみ、ストリート名のエイリアスを出力
に使用するかどうかを指定します。ストリート名のエイリ
アスとは、ストリートに対する別名で、通常は、ストリー
ト上の特定の範囲の住所のみに対して使用されます。スト
リート名のエイリアスを出力に使用しないと指定した場合
は、ストリートにエイリアス名があるかどうかにかかわら
ず、出力ではストリートの "基本" 名が使用されます。基本
名とは、ストリート全体に適用される名称です。
N
出力において、ストリート名のエイリアスを返しま
せん。
Y
ストリート名のエイリアスが存在する場合は、出力
において、ストリート名のエイリアスを返します (デ
フォルト)。
米国住所に対してのみ、入力に使用されているストリート
名のエイリアスの処理方法を指定します。ストリート名の
エイリアスとは、ストリートに対する別名で、通常は、ス
トリート上の特定の範囲の住所のみに対して使用されます。
このオプションを有効にすると、入力に使用されているス
トリート名のエイリアスが、出力にも使用されます。この
オプションを有効にしない場合は、入力に使用されている
ストリート名のエイリアスが、出力では基本ストリート名
に変換されますが、次の例外があります。
• 入力において、よく使用されるエイリアスが使用されてい
る場合は、そのエイリアスが必ず出力で使用されます。
• 入力で使用されている変更名のエイリアスは、出力では必
ず基本ストリート名に変換されます。
これは、ValidateAddress でストリート名のエイリアスを処
理する方法を制御する 3 つのオプションのうちの 1 つです。
他の 2 つは Option.OutputPreferredAlias と
Option.OutputAbbreviatedAlias です。
注 : Option.OutputAbbreviatedAlias を有効にした場合は、
Option.OutputStreetNameAlias を無効にした場合で
も、必ず省略形エイリアスが出力に使用されます。
N
192
出力において、ストリート名のエイリアスを返しま
せん。
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
パラメータ
説明
Y
Option.OutputAddressBlocks
入力されたストリート名がエイリアスである場合は、
出力において、ストリート名のエイリアスを返しま
す (デフォルト)。
実際の郵便物に印字される、書式を整えた住所を返すかど
うかを指定します。住所の各行が、別々の住所ブロック
フィールドに入れて返されます。 AddressBlock1 から
AddressBlock9 まで、最大 9 つの住所ブロック出力フィー
ルドが使用されます。
例えば、以下の住所入力の場合、
AddressLine1: 4200 Parliament Place
AddressLine2: Suite 600
City: Lanham
StateProvince: MD
PostalCode: 20706
以下の住所ブロックが出力されます。
AddressBlock1: 4200 PARLIAMENT PL STE 600
AddressBlock2: LANHAM MD 20706-1882
AddressBlock3: UNITED STATES OF AMERICA
ValidateAddress は、郵便当局の規格に従って、住所の書式
を整えて、住所ブロックの形式にします。国名は、万国郵
便連合 (UPU) の国名で返されます。
Option.OutputCountryFormat オプションは、住所ブロック
の国名には影響を与えないことに注意してください。この
オプションは、Country 出力フィールドに返される名前の
みに影響を与えます。
米国およびカナダ以外の住所に対しては、ValidateAddress
で住所の妥当性が確認できなかった場合、住所ブロックは
返されません。米国およびカナダの住所に対しては、妥当
性が確認できなかった場合も住所ブロックが返されます。
N
住所ブロックを返しません。こちらがデフォルト
です。
Y
住所ブロックを返します。
下院選挙区の取得
ValidateAddress は、住所に対する米下院選挙区を特定できます。
下院選挙区を取得するには、Option.OutputRecordType に P を含める必要があります。
Option.OutputRecordType の詳細については、出力データオプション（189ページ）を参照して
ください。
REST Web サービスガイド
193
Universal Addressing モジュール
表 86 : 下院選挙区出力
応答要素
説明
USCongressionalDistrict
下院選挙区番号。住所が州以外の住所 (プエルトリコやワシントン
D.C. など) である場合は、このフィールドは空白になります。
郡名の取得
ValidateAddress は、ある住所が所在する郡を特定し、その郡名を返すことができます。
注 : 郡名は、米国住所に対してのみ存在します。
郡名を取得するには、Option.OutputRecordType に P を含める必要があります。
Option.OutputRecordType の詳細については、出力データオプション（189ページ）を参照して
ください。
表 87 : 郡名出力
応答要素
説明
USCountyName
郡名
FIPS 郡番号の取得
連邦情報処理標準 (FIPS) 郡番号は、州の中の各郡を識別する番号です。これらの番号は、州レベルに
おいてのみ一意であり、国レベルでは一意ではないことに注意してください。詳細については、
http://www.census.gov を参照してください。
注 : FIPS 郡番号は、米国住所に対してのみ存在します。
FIPS 郡番号を取得するには、Option.OutputRecordType に P を含める必要があります。
Option.OutputRecordType の詳細については、出力データオプション（189ページ）を参照して
ください。
表 88 : FIPS 郡番号出力
応答要素
説明
USFIPSCountyNumber
FIPS (連邦情報処理標準) 郡番号
配達ルートコードの取得
配達ルートコードとは、個々の郵便配達者に割り当てられた一意の識別子で、これによって米国の各
配達ルートを一意に識別することができます。 ValidateAddress は、宛先の配達ルートを表すコード
を返すことができます。
注 : 配達ルートコードは、米国住所に対してのみ存在します。
配達ルートコードを取得するには、Option.OutputRecordType に P を含める必要があります。
Option.OutputRecordType の詳細については、出力データオプション（189ページ）を参照して
ください。
194
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
表 89 : 配達ルートコード出力
応答要素
説明
USCarrierRouteCode
配達ルートコード
配達ポイントバーコードの作成
™
配達ポイントバーコード (DPBC) は、住所を POSTNET バーコードで表記したものです。開始およ
®
び終了フレームバーと、ZIP + 4 Code、ストリートの住所の番号に基づいて計算された値、および修
正ディジットの 1 桁ごとに 5 本のバーがあり、合計 62 本のバーで構成されます。 DPBC により、配
達業者の徒歩経路のレベルにまで手紙を自動仕分けすることができます。 ValidateAddress は、DPBC
の作成に必要なデータを生成します。
注 : 配達ポイントバーコードは、米国住所に対してのみ存在します。配達ポイントバーコードの詳
細については、http://www.usps.com を参照してください。
DPBC の作成に必要なデータを生成するには、Option.OutputRecordType に P を含める必要があ
ります。 Option.OutputRecordType の詳細については、出力データオプション（189ページ）を
参照してください。
表 90 : 配達ポイントバーコード出力
応答要素
説明
PostalBarCode
配達ポイントバーコードの配達ポイント部分
USBCCheckDigit
11 桁の配達ポイントバーコードのチェックディジット部分
DPBC を作成するには、ValidateAddress 出力の値を次のように結合します。
PostalCode.Base + PostalCode.Addon + PostalBarcode + USBCCheckDigit
例えば、次のデータがあるとします。
•
•
•
•
PostalCode.Base = 49423
PostalCode.Addon = 4506
PostalBarcode = 29
USBCCheckDigit = 2
このデータから作成されるバーコードは、次のようになります。
494234506292
デフォルトオプション
以下の表に、住所のフォーマットと処理を制御するオプションの一覧を示します。これらのオプショ
ンはデフォルトですべての住所に適用されるので、"デフォルトオプション" と言います。これらのオ
プションのうちの一部は、カナダ住所に対してオーバーライドすることができます。詳細について
は、カナダ住所のオプション（210ページ）を参照してください。
REST Web サービスガイド
195
Universal Addressing モジュール
表 91 : デフォルトオプション
パラメータ
説明
Option.OutputCasing
出力データの大文字と小文字の区別を指定します。次のい
ずれかです。
M
出力には、大文字と小文字が混在します (デフォル
ト)。例:
123 Main St
Mytown FL 12345
U
出力に大文字を使用します。例:
123 MAIN ST
MYTOWN FL 12345
Option.OutputPostalCodeSeparator
™
ZIP Code またはカナダの郵便番号に区切り文字 (スペース
またはハイフン) を使用するかどうかを指定します。
®
例えば、区切り文字ありの ZIP + 4 Code は 20706-1844、
区切り文字なしは 207061844 になります。区切り文字あり
のカナダの郵便番号は P5E"1S7、区切り文字なしは P5E1S7
になります。
Y
区切り文字を使用します (デフォルト)。
N
区切り文字を使用しません。
®
注 : カナダの郵便番号ではスペースが、米国の ZIP + 4
コードではハイフンが使用されます。
Option.OutputMultinationalCharacters
Option.KeepMultimatch
ウムラウト記号やアクセント記号などの付加記号を含む多
国籍文字を返すかどうかを指定します (米国住所ではサポー
トされていません)。
N
出力に多国籍文字を使用しません (デフォルト)。標
準の ASCII 文字のみが返されます。
Y
出力に多国籍文字を使用します。
一致する可能性のある住所を複数持つ入力住所に対して複
数の住所を返すかどうかを示します。
Y
複数のマッチを返します (デフォルト)。
N
複数のマッチを返しません。
詳細については、複数マッチを返す（200ページ）を参照し
てください。
Option.StandardAddressFormat
196
米国住所の補助的な住所情報を配置する場所を指定します。
補助的な住所情報とは、部屋番号やアパート番号などの指
定子のことです。例えば、次の住所の補助的な住所情報は
"Apt 10E" で、主要な住所情報は "424 Washington Blvd" で
す。
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
パラメータ
説明
Apt 10E
424 Washington Blvd
Springfield MI 49423
Option.OutputShortCityName
C
主要な住所情報と補助的な住所情報の両方を
AddressLine1に配置します (デフォルト)。
S
主要な住所情報を AddressLine1に、補助的な住所情報
を AddressLine2 に配置します。
D
主要な住所情報と補助的な住所情報の両方を
AddressLine1に配置し、二重住所からドロップされた
情報を AddressLine2 に配置します。二重住所とは、
ストリート情報と、PO Box/地方配送路/Highway
Contract 情報の両方を含む住所のことです。詳細につ
いては、二重住所ロジックについて（199ページ）を参
照してください。
短い都市名または非正式な都市名を代替名として持つ都市
名を書式設定する方法を指定します。米国およびカナダの
住所に適用されます。
Y USPS® が承認した都市の略称が 1 つある場合、それを
®
返します。 USPS は、14 文字以上の都市名に対し、
略称を定めています。都市の略称は 13 文字以下で、
宛名ラベルのサイズが限られている場合に使用できま
す。短い都市名が存在しない都市に対しては、正式な
都市名が返されます。
N 長い都市名を返します (デフォルト)。
S 入力住所に省略された都市名が使用されている場合に
のみ、省略された都市名を返します。入力住所に短い
都市名が使用されていない場合は、その都市に対する
®
USPS の規則によって、長い都市名または短い都市名
™
が返されます。 CASS テストを実行する場合は、こ
のオプションを選択します。
V 入力都市名が非正式な都市名の場合、非正式な都市名
(非正式名) を出力します。例えば、"Hollywood" は "Los
Angeles" の非正式な都市名です。このオプションを選
択せず、入力都市名が非正式な都市名の場合、長いバー
ジョンの郵送都市名が返されます。
Option.OutputCountryFormat
REST Web サービスガイド
Country 出力フィールドに返される国名に使用するフォー
マットを指定します。例えば、英語を選択した場
合、"Deutschland" という国名は "Germany" として返されま
す。
E
英語の国名を使用します (デフォルト)。
S
スペイン語の国名を使用します。
F
フランス語の国名を使用します。
197
Universal Addressing モジュール
パラメータ
Option.HomeCountry
説明
G
ドイツ語の国名を使用します。
I
国名の代わりにその国の 2 文字の ISO の略語を使
用します。
U
国名の代わりにその国の万国郵便連合 (Universal
Postal Union: UPU) の略語を使用します。
デフォルト国を指定します。大部分の住所が存在する国を
指定してください。例えば、処理する住所の大部分がカナ
ダにある場合は、カナダを指定します。 ValidateAddress
は、[StateProvince]、[PostalCode]、および [Country] の各
住所フィールドから国を特定できなかった場合、指定され
た国を使用して、住所の検証を試みます。有効な国名には
次のものがあります。
Afghanistan, Albania, Algeria, American Somoa, Andorra,
Angola, Anguilla, Antigua And Barbuda, Argentina, Armenia,
Aruba, Australia, Austria, Azerbaijan, Bahamas, Bahrain,
Bangladesh, Barbados, Belarus, Belgium, Belize, Benin,
Bermuda, Bhutan, Bolivia, Bosnia And Herzegovina,
Botswana, Brazil, British Virgin Islands, Brunei Darussalam,
Bulgaria, Burkina Faso, Burundi, Cambodia, Cameroon,
Canada, Cape Verde, Cayman Islands, Central African
Republic, Chad, Chile, China, Colombia, Comoros Islands,
Congo, Cook Islands, Costa Rica, Cote D'Ivoire, Croatia,
Cuba, Cyprus, Czech Republic, Democratic Republic Of
Congo, Denmark, Djibouti, Dominica, Dominican Republic,
East Timor, Ecuador, Egypt, El Salvador, Equitorial Guinea,
Eritrea, Estonia, Ethiopia, Falkland Islands, Faroe Islands,
Federated States Of Micronesia, Fiji, Finland, France, French
Guiana, Gabon, Gambia, Germany, Ghana, Gibraltar, Greece,
Greenland, Grenada, Guadeloupe, Guam, Guatemala,
Guinea, Guinea Bissau, Guyana, Haiti, Holy See, Honduras,
Hong Kong, Hungary, Iceland, India, Indonesia, Iran, Iraq,
Ireland, Israel, Italy, Jamaica, Japan, Jordan, Kazakhstan,
Kenya, Kiribati, Korea, Kuwait, Kyrgyzstan, Laos, Latvia,
Lebanon, Lesotho, Liberia, Libya, Liechtenstein, Lithuania,
Luxembourg, Macau, Macedonia, Madagascar, Malawi,
Malaysia, Maldives, Mali, Malta, Marshall Islands, Martinique,
Mauritania, Mauritius, Mayotte, Mexico, Moldova, Monaco,
Mongolia, Monserrat, Morocco, Mozambique, Myanmar,
Namibia, Nauru, Nepal, Netherlands Antilles, New Caledonia,
New Zealand, Nicaragua, Niger, Nigeria, Niue, Norway, Oman,
Pakistan, Palau, Panama, Papua New Guinea, Paraguay,
Peru, Philippines, Pitcairn Islands, Poland, Portugal, Puerto
Rico, Qatar, Republic Of Georgia, Republic Of Korea,
Republic Of Singapore, Reunion, Romania, Russia, Rwanda,
Saint Helena, Saint Kitts And Nevis, Saint Lucia, Saint Pierre
And Miquelon, Saint Vincent And The Grenadines, Samoa,
San Marino, Sao Tome And Principe, Saudi Arabia, Senegal,
Seychelles, Sierra Leone, Slovakia, Slovenia, Solomon
Islands, Somalia, South Africa, Spain, Sri Lanka, Sudan,
Surivalue, Swaziland, Sweden, Switzerland, Syria, Tahiti,
198
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
パラメータ
説明
Taiwan, Tajikistan, Tanzania, Thailand, The Netherlands,
Togo, Tonga, Trinidad And Tobago, Tristan Da Cunha,
Tunisia, Turkey, Turkmenistan, Turks And Caicos Islands,
Tuvalu, Uganda, Ukraine, United Arab Emirates, United
Kingdom, United States, Uruguay, Uzbekistan, Vanuatu,
Venezuela, Vietnam, Virgin Islands (US), Wallis And Futuna,
Yemen, Yugoslavia, Zambia, Zimbabwe
Option.DualAddressLogic
複数の空白以外の住所行が存在する、または複数の住所タ
イプが同じ住所行に存在する場合、ValidateAddress はマッ
チを返します (米国住所のみ)。
N
®
™
(デフォルト) USPS CASS の規則では、以下の優
先順位に基づいて、返す住所を決定します。
1.
2.
3.
4.
5.
6.
PO Box
Firm
Highrise
Street
Rural Route
General Delivery
S
住所行に関係なく、ストリート一致を返します。
P
住所行に関係なく、PO Box 一致を返します。
詳細については、二重住所ロジックについて（199ページ）
を参照してください。
二重住所ロジックについて
Option.DualAddressLogic オプションは、米国住所に対してのみ、ストリート情報と PO Box/地方配送
路/Highway Contract 情報の両方が同じ住所行に含まれる場合に、ValidateAddress が、ストリート一
致を返すか、または PO Box/地方配送路/Highway Contract 一致を返すかを制御します。
注 : ストリート情報が PO Box/地方配送路/Highway Contract 情報と別の住所行入力フィールドに含
まれている場合、Option.DualAddressLogic オプションは、効果を持ちません。
例えば、次の入力住所が与えられたとします。
AddressLine1: 401 N Main St Apt 1 POB 1
City: Kemp
StateProvince: TX
PostalCode: 75143
ValidateAddress は、次のいずれかを返します。
• Option.DualAddressLogic が N または P のいずれかに設定されている場合、ValidateAddress は次を
返します。
AddressLine1: PO Box 1
City: Kemp
StateProvince: TX
PostalCode: 75143-0001
• Option.DualAddressLogic が S に設定されている場合、ValidateAddress は次を返します。
AddressLine1: 401 N Main St Apt 1
City: Kemp
REST Web サービスガイド
199
Universal Addressing モジュール
StateProvince: TX
PostalCode: 75143-4806
住所の正規化に使用されない住所データは、次の 2 カ所のいずれかに返すことができます。
• AddressLine2 — Option.StandardAddressFormat=D を指定した場合、住所の正規化に使用されな
い住所情報は、AddressLine2 フィールドに返されます。このオプションの詳細については、デフォ
ルトオプション（195ページ）を参照してください。例えば、二重住所に対してストリート一致を返
すと選択すると、次のようになります。
AddressLine1: 401 N Main St Apt 1
AddressLine2: PO Box 1
City: Kemp
StateProvince: TX
PostalCode: 75143-0001
• AdditionalInputData — Option.StandardAddressFormat=D を指定しない場合、住所の正規化に使用
されない住所情報は、AdditionalInputData フィールドに返されます。このオプションの詳細につ
いては、デフォルトオプション（195ページ）を参照してください。例えば、二重住所に対してスト
リート一致を返すと選択すると、次のようになります。
AddressLine1: 401 N Main St Apt 1
City: Kemp
StateProvince: TX
PostalCode: 75143-0001
AdditionalInputData: PO Box 1
ドロップされた住所情報は、Option.StandardAddressFormat オプションで D に設定することによって
取得することができます。詳細については、を参照してください。
複数マッチを返す
ValidateAddress が、入力住所に一致する可能性のある複数の住所を郵便データベース内で検出した場
合、一致する可能性のある住所を ValidateAddress が返すよう設定できます。例えば、次の住所は米
国郵便データベース内の複数の住所にマッチします。
PO BOX 1
New York, NY
オプション
複数マッチを返すには、次の表に示すオプションを使用します。
表 92 : 複数マッチのオプション
パラメータ
説明
Option.KeepMultimatch
一致する可能性のある住所を複数持つ入力住所に対して複数の住所を
返すかどうかを示します。
Option.MaximumResults
Y
複数のマッチを返します (デフォルト)。
N
複数のマッチを返しません。
返す住所の最大数を示す 1 ～ 10 の数字を入力します。
デフォルト値は 1 です。
注 : Option.Keepmultimatch=N と
Option.KeepMultimatch=Y/Option.MaximumResults=1 の違い
200
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
パラメータ
説明
は、Option.KeepMultimatch=N は複数マッチによって失敗が返
され、Option.KeepMultimatch=Y かつ Option.MaximumResults=1
は複数マッチによって 1 つのレコードが返される点です。
Option.OutputFieldLevelReturnCodes どの出力住所が候補住所かを特定するには、
Option.OutputFieldLevelReturnCodes に対して値 Y を指定する必要が
あります。このように設定すると、候補住所のレコードのフィールド
レベルの結果インジケータに 1 つ以上の値 "M" が格納されます。
出力
複数マッチを返すよう選択した場合、住所は指定した住所フォーマットで返されます。住所フォー
マットの指定については、出力データオプション（189ページ）を参照してください。どのレコード
が候補住所であるかを特定するには、フィールドレベルの結果インジケータに複数の値 "M" があるか
どうかを調べます。詳細については、フィールドレベルの結果インジケータ（229ページ）を参照して
ください。
米国住所のオプション
パラメータ
説明
Option.PerformUSProcessing 米国住所を処理するかどうかを指定します。米国住所処理を有効に
すると、ValidateAddress は米国住所の検証を試みます。住所をサポー
トしていません。米国住所処理を無効にすると、米国住所は失敗し
ます。つまり、Status 出力フィールドに "F" が設定されて返されます。
出力フィールド Status.Code は、"DisabledCoder" となります。米国
住所処理のライセンスを取得していない場合は、ジョブに米国住所
が含まれるか否かにかかわらず、米国住所処理を無効にしなければ、
ジョブを正常に実行することはできません。住所をサポートしていま
せん。
注 : 米国住所を正常に処理するには、米国住所処理の有効なライセ
ンスを取得する必要があります。住所をサポートしていませ
ん。米国住所処理のライセンスを取得していないか、ライセン
スの期限が切れているにもかかわらず、米国住所処理を有効に
すると、エラーとなります。
N
米国住所を処理しません。
Y
米国住所を処理します。こちらがデフォルトです。
Option.Database.US
米国住所の妥当性の確認に使用するデータベースを指定します。
Management Console の [米国データベースリソース] パネルで定義さ
れたデータベースのみが使用可能です。
Option.PerformLOT
Enhanced Line of Travel (eLOT) 処理は、Line of Travel シーケンス
コードを住所に割り当てます。 ValidateAddress は eLOT 順へのソー
トを行いませんが、住所を eLOT 順にソートできるデータ (Line of
Travel シーケンスコード) を提供します。
REST Web サービスガイド
201
Universal Addressing モジュール
パラメータ
説明
eLOT 処理を実行するには、eLOT データベースをインストールして
おく必要があります。
N
Line of Travel 処理を実行しません。こちらがデフォルトで
す。
Y
Line of Travel 処理を実行します。
このオプションで返される出力フィールドの一覧については、
Enhanced Line of Travel 出力（241ページ）を参照してください。
Option.PerformRDI
™
Residential Delivery Indicator (RDI ) 処理は、住所が (企業住所ではな
™
™
く) 個人住所であることを調べます。 RDI 処理を実行するには、RDI
データベースをインストールしておく必要があります。
®
™
™
DPV と RDI の両方の処理を有効にしている場合は、RDI 情報は、
®
住所が有効な配達ポイントである場合のみ返されます。 DPV で住所
™
の妥当性が確認されなかった場合は、RDI データは返されません。
Option.PerformESM
Option.PerformASM
Option.PerformDPV
N
Residential Delivery Indicator 処理を実行しません。こちら
がデフォルトです。
Y
Residential Delivery Indicator 処理を実行します。
Enhanced Street Matching (ESM) は、追加のマッチングロジックを適
用することにより、綴りに誤りがあるストリート名や複雑なストリー
ト名を修正し、マッチ結果を得ます。 ESM により、ValidateAddress
はより多くの住所の妥当性を確認できるようになりますが、パフォー
マンスは低下します。 ASM が有効な場合は、ESM を実行することは
できません。
N
Enhanced Street Matching を実行しません。こちらがデフォ
ルトです。
Y
Enhanced Street Matching を実行します。
All Street Matching (ASM) は、ESM 処理に加えて追加のマッチング
ロジックを適用することにより、ストリート名の誤りを修正し、マッ
チ結果を得ます。ストリートの最初の文字が誤っている場合のスト
リートのマッチングに有効です。 ASM は、最良の住所検証結果を提
供しますが、パフォーマンスは低下します。
N
All Street Matching を実行しません。
Y
All Street Matching を実行します。こちらがデフォルトで
す。
®
Delivery Point Validation (DPV ) は、特定の住所が有効な住所の範囲
内にあるかどうかを確認するのではなく、特定の住所が存在するかど
うかを確認します。 CMRA 処理は、住所が、Commercial Mail
Receiving Agency (CMRA: 民間私書箱) と呼ばれる民間企業が貸し出
す私書箱であるかどうかを確認します。
202
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
パラメータ
説明
DPV および CMRA 処理を実行するには、DPV データベースをインス
トールしておく必要があります。 DPV データベースには、DPV と
CMRA の両方のデータが含まれます。
N
Delivery Point Validation または CMRA 処理を実行しません。
こちらがデフォルトです。
Y
Delivery Point Validation または CMRA 処理を実行します。
このオプションで返される出力フィールドの一覧については、DPV お
よび CMRA 出力（242ページ）を参照してください。
Option.PerformLACSLink
®
USPS Locatable Address Conversion System (LACS) は、地方配送
路の住所をストリート名に沿った住所に変換した場合、PO Box 番号
の再割り当てがあった場合、またはストリート名に沿った住所が変更
Link
した場合に、それに伴って変更した住所を修正します。 LACS
処
理を有効にした場合、妥当性が確認できなかった住所、または妥当性
Link
が確認され、LACS
変換のフラグが付けられた住所に対し、その処
理が実行されます。
Link
LACS
Link
処理を実行するには、LACS
データベースをインストー
ルしておく必要があります。
Link
変換を行いません。こちらがデフォルトです。
Link
変換を行います。
N
LACS
Y
LACS
このオプションで返される出力フィールドの一覧については、を参照
してください。 LACSLink 出力（241ページ）
Option.PerformEWS
®
Early Warning System (EWS) は、USPS EWS ファイルを使用して、
®
ZIP + 4 データベースには存在しない住所の妥当性を確認します。
EWS 処理を実行するには、EWS データベースをインストールしてお
く必要があります。
入力住所が、EWS ファイルの住所に一致する場合、ValidateAddress
は次のレコードレベルの結果インジケータを返します。
• Status="F"
• Status.Code="EWSFailure"
• Status.Description="Address found in EWS table"
Option.ExtractFirm
REST Web サービスガイド
N
EWS 処理を実行しません。こちらがデフォルトです。
Y
EWS 処理を実行します。
AddressLine1 ～ AddressLine4 から企業名を抽出し、FirmName 出力
フィールドに入れるかどうかを指定します。このオプションは、入力
レコードの FirmName フィールドが空白で、住所行が複数存在する場
合に適用されます。
Y
企業名を抽出します。
N
企業名を抽出しません。こちらがデフォルトです。
203
Universal Addressing モジュール
パラメータ
説明
住所行の中の企業名を特定するために、ValidateAddress は、住所行
をスキャンし、どのフィールドが住所行で、どのフィールドが企業名
の行であるかを特定するためのキーワードおよびパターンを検索しま
す。この処理はパターンに基づいて行われるため、ValidateAddress
はフィールドを誤って認識する場合があります。最適な企業名抽出を
行うためのヒントを、以下に示します。
• 可能ならば、主要な住所要素を AddressLine1、補助的な要素を
AddressLine2、都市化名を AddressLine3、企業名を AddressLine4
に配置します。住所に都市化コードが存在しない場合は、企業名を
AddressLine3 に配置し、AddressLine4 を空白にします。例を次に
示します。
AddressLine1: 4200 Parliament Place
AddressLine2: Suite 600
AddressLine3:Pitney Bowes Software
AddressLine4: <空白>
• 住所行を 2 行だけ定義する場合は、ほとんどの場合 AddressLine2
には補助的な住所が入ります。 ValidateAddress が AddressLine2 を
企業名として処理する確率を上げるには、企業名を AddressLine3
に配置し、AddressLine2 は空白にします。
• 企業名に数字が含まれていると ("1 Stop Software" の "1" など)、
ValidateAddress がそのフィールドを住所行として処理する確率が
高くなります。
以下に、企業名抽出の例をいくつか示します。
• 次の例では、AddressLine2 が FirmName 出力フィールドに抽出さ
れます。
FirmName: <空白>
AddressLine1: 4200 Parliament Place Suite 600
AddressLine2: International Goose Feathers inc.
• 次の例では、AddressLine3 が FirmName 出力フィールドに抽出さ
れます。
FirmName: <空白>
AddressLine1: 4200 Parliament Place
AddressLine2: Suite 600
AddressLine3: Pitney Bowes Software
• 次の例では、AddressLine3 は AdditionalInputData 出力フィールド
に配置されます。 FirmName 入力フィールドが空白ではないため、
企業名は抽出されません。
FirmName: International Goose Feathers Inc.
AddressLine1: 4200 Parliament Place
AddressLine2: Suite 600
AddressLine3: Pitney Bowes Software
• 次の例では、空白でない住所行が 1 行しかなく、その行は必ず主要
な住所要素として処理されるため、企業名は抽出されません。
204
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
パラメータ
説明
FirmName: <空白>
AddressLine1: 4200 Parliament Place Suite 600
• 次の例では、AddressLine2 は補助的な住所要素として処理されま
す。数字の "1" が含まれているために、ValidateAddress がそのフィー
ルドを補助的な住所要素とみなすためです。
FirmName: <空白>
AddressLine1: 4200 Parliament Place Suite 600
AddressLine2: Pitney Bowes Software
Option.ExtractUrb
AddressLine1 ～ AddressLine4 から都市化名を抽出し、USUrbanName
出力フィールドに入れるかどうかを指定します。このオプションは、
入力レコードの USUrbanName フィールドが空白で、住所行が複数存
在する場合に適用されます。
Y
都市化名を抽出します。
N
都市化名を抽出しません。こちらがデフォルトです。
都市化名を特定するために、ValidateAddress は、住所行をスキャン
し、どのフィールドが住所行で、どのフィールドが都市化名の行であ
るかを特定するためのキーワードおよびパターンを検索します。この
処理はパターンに基づいて行われるため、ValidateAddress はフィー
ルドを誤って認識する場合があります。最適な都市化名抽出を行うに
は、できる限り、主要な住所要素を AddressLine1、補助的な要素を
AddressLine2、都市化名を AddressLine3、企業名を AddressLine4 に
配置します。例を次に示します。
AddressLine1: A1 Calle A
AddressLine2:
AddressLine3: URB Alamar
AddressLine4: Pitney Bowes Software
Option.PerformSuiteLink
Link™
Suite
Link
Suite
処理を実行するかどうかを指定します。
は、補助的な住所情報の妥当性が確認できなかった米国の企
Link
業住所に対し、その補助的な住所情報を修正します。 Suite
処理が
有効になっている場合、既知の企業名とその補助的な住所情報からな
るデータベースに対して、企業名のマッチングが行われます。
例を次に示します。
企業名: Pitney Bowes Software
Address Line 1: 4200 Parliament Place
Address Line 2: STE 1
郵便番号: 20706
Link
この場合、Suite
は、Suite 番号を以下の正しい Suite番号に変更し
ます。
企業名: Pitney Bowes Software
Address Line 1: 4200 Parliament Place
Address Line 2: STE 600
Postal Code: 20706-1844
REST Web サービスガイド
205
Universal Addressing モジュール
パラメータ
説明
Link™
Suite
Link™
処理を実行するには、Suite
データベースをインストー
ルしておく必要があります。
このオプションは、次の値のいずれかを取ります。
Link™
を使用しません。こちらがデフォルトです。
Link™
を使用します。
N
Suite
Y
Suite
このオプションで返されるフィールドの一覧については、SuiteLink
出力（244ページ）を参照してください。
Option.OutputPreferredAlias
ストリート名に対してよく使用されるエイリアスを出力に使用するか
どうかを指定します。
米国におけるストリート名のエイリアスとは、ストリートの一部に付
けられた別名のことです。ストリート名のエイリアスには、次の 4 種
類があります。
• よく使用される名前 — その地域でよく使用されるストリート名で
す。通常は、ストリート上の特定の範囲の住所のみに対して使用さ
れます。
• 省略形 — ストリート名の省略形です。AddressLine1 の長さが 31
文字以上になる場合に使用することができます。例えば、1234
BERKSHIRE VALLEY RD APT 312A というストリート名は、1234
BERKSHIRE VLLY RD APT 312A と省略することができます。
• 変更名 — ストリート名が正式に変更された場合に、新しい名前を
表すエイリアスです。例えば、SHINGLE BROOK RD というスト
リート名が CANNING DR に変更された場合、CANNING DR が変更
済みのエイリアスタイプとなります。
• その他の名前 — このストリート名エイリアスには、ストリートの
他の名前や、ストリートの一般的な省略形などがあります。
エイリアスではないストリート名のことを、基本ストリート名と呼び
ます。
入力において、よく使用されるエイリアスが使用されている場合は、
このオプションを選択しているかどうかにかかわらず、そのエイリア
スが出力のストリート名になります。
これは、ValidateAddress でストリート名のエイリアスを処理する方
法を制御する 3 つのオプションのうちの 1 つです。他の 2 つは
Option.OutputStreetNameAlias と Option.OutputAbbreviatedAlias で
す。
多くの場合、Option.OutputPreferredAlias と
Option.OutputAbbreviatedAlias の両方が選択されており、
ValidateAddress が、郵便データベース内でよく使用されるエイリア
スと省略形エイリアスの両方を検出した場合は、省略形エイリアスが
出力に使用されます。入力のストリート名がよく使用されるエイリア
スである場合は、例外になります。この場合は、よく使用されるエイ
リアスが出力に使用されます。
206
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
パラメータ
説明
Y
ストリート名に対してよく使用されるエイリアスの処理を実
行します。
N
ストリート名に対してよく使用されるエイリアスの処理を実
行しません。こちらがデフォルトです。
注 : 入力住所に、"変更名"であるストリート名のエイリアスが含まれ
ている場合は、指定したオプションにかかわらず、出力住所に
は必ず、基本ストリート名が使用されます。
Option.OutputAbbreviatedAlias 出力住所行の長さが 31 文字以上になる場合に、ストリート名に対す
る省略形エイリアスを出力に使用するかどうかを指定します。
これは、ValidateAddress でストリート名のエイリアスを処理する方
法を制御する 3 つのオプションのうちの 1 つです。他の 2 つは
Option.OutputStreetNameAlias と Option.OutputPreferredAlias です。
注 : 入力において、よく使用されるエイリアスが指定されている場
合は、ストリート名に対する省略形エイリアスの処理を有効に
していても、出力のストリート名は必ず、よく使用されるエイ
リアスになります。
Y
省略形エイリアスの処理を実行します。
N
省略形エイリアスの処理を実行しません。こちらがデフォル
トです。
注 : 入力住所に、"変更名"であるストリート名のエイリアスが含まれ
ている場合は、指定したオプションにかかわらず、出力住所に
は必ず、基本ストリート名が使用されます。
Option.DPVDetermineNoStat 住所の "no stat" ステータスを調べます。住所が存在するが、郵便物
を受け取れない場合、その住所は "no stat" とみなされるため、配達
ルートに関する配達統計としてカウントされません (そのため "no stat"
という用語が使用されます)。例としては、建設中の建物や、郵便物
を受け取る可能性が低いと郵便配達業者が識別した建物などがありま
す。
N
"no stat" ステータスを調べません。こちらがデフォルトで
す。
Y
"no stat" ステータスを調べます。
注 : このオプションを使用するには DPV 処理を有効にする必要があ
ります。
結果は DPVNoStat フィールドに返されます。詳細については、を参
照してください。 LACSLink 出力（241ページ）
Option.DPVDetermineVacancy そのロケーションがすくなとも 90 日間使用されていないかどうかを
調べます。
REST Web サービスガイド
N
空家かどうかを調べません。こちらがデフォルトです。
Y
空家かどうかを調べます。
207
Universal Addressing モジュール
パラメータ
説明
注 : このオプションを使用するには DPV 処理を有効にする必要があ
ります。
結果は DPVVacant フィールドに返されます。詳細については、を参
照してください。 LACSLink 出力（241ページ）
Option.ReturnVerimove
出力に VeriMove 詳細データを返します。
N
VeriMove 詳細データを返しません。こちらがデフォルトで
す。
Y
VeriMove 詳細データを返します。
Option.StreetMatchingStrictness 入力住所が郵便データベース内の住所にマッチするかどうかを調べる
際に使用するアルゴリズムを指定します。次のいずれかです。
E
入力されたストリート名は、データベースに完全に一致する
必要があります。
T
マッチングアルゴリズムは "厳格" です。
M
マッチングアルゴリズムは "中" です (デフォルト)。
L
マッチングアルゴリズムは "あいまい" です。
Option.FirmMatchingStrictness 入力住所が郵便データベース内の住所にマッチするかどうかを調べる
際に使用するアルゴリズムを指定します。次のいずれかです。
E
入力された企業名は、データベースに完全に一致する必要が
あります。
T
マッチングアルゴリズムは "厳格" です。
M
マッチングアルゴリズムは "中" です (デフォルト)。
L
マッチングアルゴリズムは "あいまい" です。
Option.DirectionalMatchingStrictness 入力住所が郵便データベース内の住所にマッチするかどうかを調べる
際に使用するアルゴリズムを指定します。次のいずれかです。
E
123 N Main St. における "N" など、入力された道順がデータ
ベースに完全に一致する必要があります。
T
マッチングアルゴリズムは "厳格" です。
M
マッチングアルゴリズムは "中" です。こちらがデフォルト
です。
L
マッチングアルゴリズムは "あいまい" です。
Option.DPVSuccessfulStatusCondition DPV 結果がレコードの失敗の原因とならない一致条件を選択します。
F
全体一致
P
部分一致
A
常に一致こちらがデフォルトです。
注 : このオプションを使用するには DPV 処理を有効にする必要があ
ります。
208
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
パラメータ
説明
Option.FailOnCMRAMatch
民間私書箱（CMRA）との一致をマッチとみなしませんか。
N
いいえ、CMRA との一致をマッチとみなします。こちらが
デフォルトです。
Y
はい、CMRA との一致をマッチとみなしません。
注 : このオプションを使用するには DPV 処理を有効にする必要があ
ります。
Option.StandardAddressPMBLine ValidateAddress が私書箱 (PMB) の情報をどこに配置するかを指定し
ます。
N
標準住所出力に PMB 情報を含めません (デフォルト)。
1
PMB 情報を AddressLine1 に配置します。 1 を指定した場合、
Option.StandardAddressFormat に C または D をセットする
必要があります。
2
PMB 情報を AddressLine2 に配置します。
CASS 認定処理
™
また、CASS 認定処理では USPS CASS 詳細レポートも生成されます。このレポートに含まれる情
報は 3553 レポートと同じものですが、DPV、LACS、および SuiteLink に関する大幅に詳しい統計情
報が含まれます。 USPS CASS 詳細レポートは、郵便料金の値引きを受けるために必ずしも必要では
なく、郵便物と一緒に提出する必要はありません。
1. Validate Address を CASS 認定™モードにする必要があります。ウィンドウの一番上に (CASS 認
定でないもの) と表示される場合は、[CASS 有効] ボタンをクリックしてください。 [CASS ルー
ルを強制] チェックボックスが表示されます。
2. [CASS 3553 を設定] をクリックします。 [CASS レポートフィールド] ダイアログボックスが表
示されます。
3. [リスト処理元] の会社名、[リスト名または ID 番号]、およびこのジョブで処理する [リスト数] を
入力します。
4. [差出人名]、[住所]、および[都市]、[州]、[ZIP] を入力します。
5. [OK] をクリックします。
生成された USPS® CASS Form 3553 のセクション B にリストの情報が、セクション D に差出人
の情報が表示されます。
REST Web サービスガイド
209
Universal Addressing モジュール
6. Enterprise Designer で、CASS3553 レポートをレポートのパレットからキャンバスにドラッグし
ます。
7. キャンバスの [CASS3553] アイコンをダブルクリックします。
8. [ステージ] タブで、[Validate Address] チェックボックスをオンにします。 Validate Address ス
テージを何か別の名前に変更している場合は、住所検証ステージに指定した名前のチェックボッ
クスをオンにする必要があります。
9. [パラメータ] タブで、レポートのフォーマットを選択します。 PDF、 HTML、またはプレーンテ
キストのフォーマットでレポートを作成できます。
10. [OK] をクリックします。
11. CASS 詳細レポートを生成する場合は、CASSDetail に対して手順 6 ～ 10 を繰り返します。
カナダ住所のオプション
パラメータ
説明
Option.PerformCanadianProcessing
カナダ住所を処理するかどうかを指定します。カ
ナダ住所処理を有効にした場合、ValidateAddress
はカナダ住所の検証を試みます。カナダ住所処理
を無効にすると、カナダ住所は失敗します。つま
り、Status 出力フィールドに "F" が設定されて返
されます。出力フィールド Status.Code
は、"DisabledCoder" となります。カナダ住所処
理のライセンスを取得していない場合は、ジョブ
にカナダ住所が含まれるか否かにかかわらず、カ
ナダ住所処理を無効にしなければ、ジョブを正常
に実行することはできません。
注: カナダ住所を正常に処理するには、カナダ
住所処理の有効なライセンスを取得する必
要があります。カナダ住所処理のライセン
スを取得していないか、ライセンスの期限
210
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
パラメータ
説明
が切れているにもかかわらず、カナダ住所
処理を有効にすると、エラーとなります。
N
カナダ住所を処理しません。
Y
カナダ住所を処理します (デフォルト)。
Option.Database.Canada
カナダ住所の検証に使用するデータベースを指定
します。カナダ住所検証用のデータベースを指定
するには、[データベース] ドロップダウンリスト
からデータベースを選択します。 Management
Console の [カナダデータベースリソース] パネ
ルで定義されたデータベースのみが使用可能で
す。
Option.CanFrenchFormat
住所及び方向指示の書式設定に使用する言語 (英
語またはフランス語) の判断方法を指定します。
以下に、英語およびフランス語で書式設定された
住所の例を示します。
英語: 123 Main St W
フランス語: 123 Rue Main O
このパラメータは、住所の書式設定を制御しま
す。また、方向指示の綴りにも影響を与えます
が、接尾語の綴りには影響を与えません。
C マッチング処理によって返されるストリート
接尾語によって、言語を判断します。マッチ
ング処理によって返されるストリート接尾語
は、ValidateAddress が処理において内部で使
用するもので、入力住所のものとは異なる場
合があります。あいまいなレコードは、入力
と同様に書式設定されます。こちらがデフォ
ルトです。ケベック州の住所はすべて、フラ
ンス語で書式設定されます。
S カナダデータベースによって、言語を判断し
ます。カナダデータベースには、Canada
Post Corporation (CPC: カナダ郵政公社) から
のデータが含まれています。ケベック州の住
所はすべて、フランス語で書式設定されます。
T CanLanguage 入力フィールドによって、言語
を判断します。このフィールドに空白以外の
値が設定されている場合は、住所はフランス
語で書式設定されます。
Option.CanFrenchFormat
REST Web サービスガイド
英語の住所に対し、入力住所にアパートメントラ
ベルが存在しない場合に、出力に使用するデフォ
ルトアパートメントラベルを指定します。
211
Universal Addressing モジュール
パラメータ
説明
Option.CanStandardAddressFormat=F と指定した
場合、この設定は無視されます。
Apt
ラベルとして "Apt" を使用します。
こちらがデフォルトです。
Apartment ラベルとして "Apartment" を使用し
ます。
Option.CanFrenchApartmentLabel
Suite
ラベルとして "Suite" を使用します。
Unit
ラベルとして "Unit" を使用します。
フランス語の住所に対し、入力住所にアパートメ
ントラベルが存在しない場合に、出力に使用する
デフォルトアパートメントラベルを指定します。
Option.CanStandardAddressFormat=F と指定した
場合、この設定は無視されます。
App
ラベルとして "App" を使用しま
す。こちらがデフォルトです。
Appartement ラベルとして "Appartement" を使
用します。
Option.ForceCorrectionLVR
Bureau
ラベルとして "Bureau" を使用しま
す。
Suite
ラベルとして "Suite" を使用しま
す。
Unite
ラベルとして "Unite" を使用しま
す。
正式情報やスイート情報を変更して、Large
Volume Receiver (LVR) または Single-Single レ
コードをマッチさせます (その郵便番号/ストリー
ト名/ストリートタイプに対して 1 つしかレコー
ドがない場合に使用します)。
N LVR または Single-Single レコードをマッチ
させるために正式情報やスイート情報を変更
しません。 LVR レコードは、有効だが修正不
可能なレコード (VN) としてマーク付けされ
ます。 Single-Single レコードは可能ならば修
正されます。または、修正不可能なレコード
として処理されます。
Y LVR または Single-Single レコードをマッチ
させるために正式情報やスイート情報を変更
します。
注 : このチェックボックスをオンにする場
合は、SERP 認定の設定ではないた
め、Statement of Address Accuracy は
印刷されません。
212
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
パラメータ
説明
Option.CanPreferHouseNum
家番号と郵便番号がともに有効であるが、競合す
る場合、Option.CanPreferHouseNum=Y と指定す
ることによって、家番号に合わせて郵便番号を強
制的に修正できます。このオプションを選択しな
い場合、郵便番号に合わせて家番号が変更されま
す。
Option.CanOutputCityAlias
Option.CanNonCivicFormat
Option.EnableSERP
Option.CanStandardAddressFormat
REST Web サービスガイド
N
郵便番号に合わせて家番号を変更します。
こちらがデフォルトです。
Y
家番号に合わせて郵便番号を変更します。
入力住所に都市名のエイリアスがある場合、その
エイリアスを返すかどうかを指定します。
Option.CanOutputCityFormat=D を指定している
場合は、このオプションは無効です。
Y
入力に都市名のエイリアスがある場合は、
都市名のエイリアスを出力します。こちら
がデフォルトです。
N
入力に都市名のエイリアスがあっても、都
市名のエイリアスを出力しません。
出力において、正式住所ではないキーワードを短
縮するかどうかを指定します。例えば、Post
Office Box と PO Box のどちらを使用するかが決
まります。
A
正式住所ではないキーワードを短縮します。
こちらがデフォルトです。
F
正式住所ではないキーワードを短縮しませ
ん。正式なキーワードを使用します。
SERP オプションを使用するかどうかを指定しま
す。
Y
SERP オプションを有効にします。
N
SERP オプションを有効にしません。こ
ちらがデフォルトです。
出力住所における、補助的な住所情報の配置場所
を指定します。補助的な住所情報とは、部屋番号
やアパート番号などの指定子のことです。
D
アパート情報を、で指定された場所に配置
します。こちらがデフォルトです。
B
アパート情報を、AddressLine1 フィールド
の末尾に配置します。
213
Universal Addressing モジュール
パラメータ
Option.CanOutputCityFormat
説明
F
アパート番号のみ (ラベルは除く) を、
AddressLine1 フィールドの先頭に配置しま
す。例えば、400-123 Rue Main とします。
E
アパート番号とラベルを、AddressLine1
フィールドの先頭に配置します。例えば、
Apt 400 123 Rue Main とします。
S
アパート情報を別の行に配置します。
S
アパート情報を入力住所と同じ場所に配置
します。
都市の名前が長い場合に、long、medium、もし
くは short のどの都市名を使用するかを指定しま
す。例を次に示します。
Long: BUFFALO HEAD PRAIRIE
Medium: BUFFALO-HEAD-PR
Short: BUFFALO-HD-PR
D
Option.OutputShortCityName パラメータで
指定されたデフォルトオプションを使用し
ます。こちらがデフォルトです。
Option.OutputShortCityName=V を指定した
場合、都市は、このオプションでを選択し
(以下を参照)、CanOutputCityAlias で Y
を選択した場合と同じように書式設定され
ます。
Option.CanRuralRouteFormat
S
短い都市名を出力します。
L
長い都市名を出力します。
M
中間の長さの都市名を出力します。
I
入力住所と同じ都市フォーマットを使用し
ます。出力は、L、M、または S です。
地方配送路の配達情報を配置する場所を指定しま
す。地方配送路の配達情報を含む住所の例を以下
に示します。
36 GRANT RD RR 3
ANTIGONISH NS
この住所において、"RR 3" は地方配送路の配達情
報です。
A
地方配送路の配達情報を、住所と同一行の
住所情報の後に配置します。こちらがデフォ
ルトです。例を次に示します。
36 GRANT RD RR 3
214
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
パラメータ
説明
S
地方配送路の配達情報を、別の住所行に配
置します。例を次に示します。
36 GRANT RD
RR 3
Option.CanDeliveryOfficeFormat
配達局情報の配置場所を指定します。配達局情報
を含む住所の例を次に示します。
PO BOX 8625 STN A
ST. JOHN'S NL
I
配達局情報を、入力住所と同じ場所に配置
します。こちらがデフォルトです。
A
配達局情報を、住所と同一行の住所情報の
後に配置します。例を次に示します。
PO BOX 8625 STN A
S
配達局情報を、別の住所行に配置します。
例を次に示します。
PO BOX 8625
STN A
Option.CanDualAddressLogic
住所に、正式情報と非正式情報の両方が含まれて
いる場合に、ValidateAddress がストリート一致
と、PO Box/非正式一致のどちらを返すかを指定
します。次のいずれかです。
D
DualAddressLogic のグローバルオプショ
ンを使用します。こちらがデフォルトで
す。
P
PO Box などストリート以外のデータとマッ
チングします。
S
ストリートとマッチングします。
例えば、次の入力住所が与えられたとします。
AddressLine1: 36 GRANT RD
AddressLine2: RR 4
City: ANTIGONISH
StateProvince: NS
ValidateAddress は、次のいずれかを返します。
• Option.CanDualAddressLogic が S に設定され
ている場合、ValidateAddress は次を返します。
AddressLine1: 36 GRANT RD
AddressLine2: RR 3
City: ANTIGONISH
StateProvince: NS
PostalCode: B2G 2L1
REST Web サービスガイド
215
Universal Addressing モジュール
パラメータ
説明
• Option.CanDualAddressLogic が P に設定され
ている場合、ValidateAddress は次を返します。
AddressLine1: RR 4
City: ANTIGONISH
StateProvince: NS
PostalCode: B2G 2L2
住所の正規化に使用されない住所データは、
AdditionalInputData フィールドに返されます。
このオプションの詳細については、出力データオ
プション（189ページ）を参照してください。
SERP の処理
1. Validate Address を SERP 認定™モードにする必要があります。ウィンドウの一番上に (SERP 認
定でないもの) と表示される場合は、[SERP 設定を有効にする] ボタンをクリックしてください。
[SERP を設定] ボックスが表示されます。
2. [SERP を設定] をクリックします。 [SERP レポートフィールド] ダイアログボックスが表示され
ます。
3. 荷主の [CPC 番号] を入力します。
4. 差出人の [名前]、[住所]、および[都市]、[州]、[ZIP] を入力します。
5. [OK] をクリックします。
6. Enterprise Designer で、SERP レポートをレポートのパレットからキャンバスにドラッグします。
7. キャンバスの [SERPReport] アイコンをダブルクリックします。
8. [ステージ] タブで、[Validate Address] チェックボックスをオンにします。 Validate Address ス
テージを何か別の名前に変更している場合は、住所検証ステージに指定した名前のチェックボッ
クスをオンにする必要があります。
216
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
9. [パラメータ] タブで、レポートのフォーマットを選択します。 PDF、 HTML、またはプレーンテ
キストのフォーマットでレポートを作成できます。デフォルトでは PDF フォーマットで作成され
ます。
10. [OK] をクリックします。
SERP リターンコードの取得
SERP リターンコードは、カナダ郵政公社の Software Evaluation and Recognition Program の規定に
よって定められる入力住所の品質を表します。
SERP リターンコードを取得するには、Option.OutputRecordType=P を指定します。
Option.OutputRecordType の詳細については、出力データオプション（189ページ）を参照してくださ
い。
SERP リターンコードは、以下の出力フィールドに返されます。
表 93 : SERP リターンコード出力
応答要素
説明
CanadianSERPCode
検証/修正リターンコード (カナダ住所のみ)。
V 入力は有効です。カナダ郵政公社は、以下のすべての条件を満た
す住所を、「有効な」住所であると定義しています。
注 : 一部例外があります。詳細については、CPC にお問い合
わせください。
• 住所は、CPC の Postal Code Data Files に示されるとおりに、
すべての必須コンポーネントを含む必要があります。
• 住所は、CPC の Postal Code Data Files の単一の住所のみに対
し、すべてのコンポーネントにおいて完全に一致する必要があ
ります。ただし、CPC Postal Code Data Files に示されてい
る、許容される別の語および名前が使用されていてもかまいま
せん。
• 住所コンポーネントは、あいまいな部分がなく、はっきりと認
識できる形式である必要があります。一部のコンポーネントに
は、それらを識別するための "修飾子" が必要な場合がありま
す。例えば、Route Service の住所には、同じ番号の "Suburban
Service" または "SS" の住所と区別するために、"Rural Route"
または "RR" のキーワードが必要です。
I
入力は無効です。「無効な」住所とは、有効な住所に対する CPC
の条件を満たさない住所のことです (上記を参照)。例としては、
住所コンポーネントが欠落している、無効である、または矛盾が
存在する場合が挙げられます。
C 入力は修正可能です。「修正可能な」住所とは、修正することに
よって、単一の住所のみに一致させることのできる住所のことで
す。
N 入力は修正不可能です。「修正不可能な」住所とは、複数の異な
る修正方法があり得るために ValidateAddress が単一の修正住所
を特定できない住所のことです。
F 入力住所は外国 (カナダ以外) の住所です。
REST Web サービスガイド
217
Universal Addressing モジュール
国際住所オプション
米国とカナダ以外の住所は "国際" 住所と呼ばれます。以下に、国際住所の処理をコントロールするオ
プションについて説明します。
パラメータ
説明
Option.PerformInternationalProcessing
国際住所 (米国およびカナダ以外の住所) を処理す
るかどうかを指定します。国際住所処理を有効に
した場合、ValidateAddress は国際住所の妥当性
を確認します。国際住所処理を無効にすると、国
際住所は失敗します。つまり、Status 出力フィー
ルドに "F" が設定されて返されます。出力フィー
ルド Status.Code は、"DisabledCoder" となりま
す。国際住所処理のライセンスを取得していない
場合は、ジョブに国際住所が含まれるか否かにか
かわらず、国際住所処理を無効にしなければ、
ジョブを正常に実行することはできません。
注: 国際住所を正常に処理するには、国際住所
処理の有効なライセンスを取得する必要が
あります。国際住所処理のライセンスを取
得していないか、ライセンスの期限が切れ
ているにもかかわらず、国際住所処理を有
効にすると、エラーとなります。
N
国際住所を処理しません。
Y
国際住所を処理します (デフォルト)。
Option.Database.International
国際住所の妥当性の確認に使用するデータベース
を指定します。国際住所検証用のデータベースを
指定するには、[データベース] ドロップダウンリ
ストからデータベースを選択します。
Management Console の [国際データベースリソー
ス] パネルで定義されたデータベースのみが使用
可能です。
Option.InternationalCityStreetSearching
デフォルトでは、ValidateAddress は、住所マッ
チングの精度とパフォーマンスのバランスをうま
くとります。マッチング精度を犠牲にしてパ
フォーマンスを向上させる場合は、
Option.InternationalCityStreetSearching パラメー
タを使用して、処理速度を上げます。これを実行
すると、精度はやや低下します。このオプション
は、米国およびカナダ以外の住所のパフォーマン
スのみを制御します。この設定が影響を与えるレ
コードの割合は少なく、大部分が英国の住所で
す。米国およびカナダ住所処理のパフォーマンス
は制御できません。
GetCandidateAddresses を使用した場合に
GetCandidateAddresses が返す候補住所は、国際
住所のパフォーマンスチューニングオプション
218
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
パラメータ
説明
を 100 以外の任意の値に設定した場合に
ValidateAddress が返す複数マッチと異なること
があります。
パフォーマンスを制御するには、0 ～ 100 の値を
指定してください。 100 を設定すると精度が最大
化し、0 を設定すると速度が最大化します。デ
フォルトは 100 です。
Option.AddressLineSearchOnFail
このオプションにより、ValidateAddress におい
て、City、StateProvince、および PostalCode の
各入力フィールドの値を使用して住所にマッチす
る結果が得られなかった場合に、AddressLine 入
力フィールドで都市、州/省、郵便番号、および国
を検索することができます。
入力住所において、AddressLine フィールドに都
市、州/省、および郵便番号の情報が存在する場合
は、このオプションを有効にすることを検討して
ください。
入力住所において、City、State/Province、および
PostalCode フィールドが使用されている場合は、
このオプションを無効にしてください。このオプ
ションを有効にしてこれらのフィールドを使用す
ると、ValidateAddress がこれらのフィールド値
の修正 (例えば、スペルミスのある都市名など) に
失敗する可能性が高くなります。
N
いいえ、AddressLine フィールドを検索し
ません。
Y
はい、住所行フィールドを検索します。こ
ちらがデフォルトです。
応答
ValidateAddress からの出力には、選択した出力カテゴリに応じて異なる情報が含まれます。
標準住所出力
標準住所出力は、実際の宛名ラベルに表記される住所に対応する 4 行の住所で構成されます。都市、
州/省、郵便番号などのデータも、標準住所出力に含まれます。 Option.OutputRecordType=A と設定
した場合、ValidateAddress は、妥当性を確認した住所に対し、標準住所出力を返します。妥当性が
確認できなかった住所に対しては、標準住所フィールドが必ず返されます。妥当性が確認されなかっ
た住所に対しては、標準住所出力フィールドには、入力住所がそのまま含まれます ("パススルー" デー
タ)。 ValidateAddress において、妥当性が確認できなかった場合に、郵便当局の規格に従って住所を
正規化するには、要求において Option.OutputFormattedOnFail=Y を指定します。
REST Web サービスガイド
219
Universal Addressing モジュール
表 94 : 標準住所出力
応答要素
説明
AdditionalInputData
ValidateAddress で使用されない入力データ。詳細については、
AdditionalInputData について（245ページ）を参照してください。
AddressLine1
住所の妥当性が確認された場合は、妥当性が確認され、正規化された
住所の 1 行目です。住所の妥当性が確認できなかった場合は、入力住
所の 1 行目がそのまま出力されます。
AddressLine2
住所の妥当性が確認された場合は、妥当性が確認され、正規化された
住所の 2 行目です。住所の妥当性が確認できなかった場合は、入力住
所の 2 行目がそのまま出力されます。
AddressLine3
住所の妥当性が確認された場合は、妥当性が確認され、正規化された
住所の 3 行目です。住所の妥当性が確認できなかった場合は、入力住
所の 3 行目がそのまま出力されます。
AddressLine4
住所の妥当性が確認された場合は、妥当性が確認され、正規化された
住所の 4 行目です。住所の妥当性が確認できなかった場合は、入力住
所の 4 行目がそのまま出力されます。
AddressLine5
英国住所専用です。住所の妥当性が確認された場合は、妥当性が確認
され、正規化された住所の 5 行目です。住所の妥当性が確認できな
かった場合は、入力住所の 5 行目がそのまま出力されます。
City
妥当性が確認された都市名。
Country
で選択した、以下のいずれかのフォーマットで示された国。
• ISO コード
• UPU コード
• 英語
• フランス語
• ドイツ語
• スペイン語
DepartmentName
企業内の下位区分 (英国住所においてのみ)。例えば、エンジニアリン
グ部門などです。
FirmName
妥当性が確認された企業名。
PostalCode
妥当性が確認された ZIP Code または郵便番号。
PostalCode.AddOn
ZIP Code の 4 桁のアドオン部分。例えば、60655-1844 という ZIP
™
™
™
Code において、4 桁のアドオン部分は 1844 になります (米国住所
のみ)。
220
™
PostalCode.Base
5 桁の ZIP Code 。例えば、20706 (米国住所のみ)。
StateProvince
妥当性が確認された州または省の略称。
USUrbanName
妥当性が確認された都市の都市化名。 (米国住所のみ)。
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
パース済み住所要素出力
Option.OutputRecordType=E を設定した場合、出力住所は、パース済み住所の形式で書式設定されま
す。 ValidateAddress で、妥当性が確認できなかった場合に、パース済み住所形式で書式設定された
データ (正規化済み住所) を返すには、Option.OutputFormattedOnFail=Y を指定します。
注 : ValidateAddress で、妥当性が確認できたかどうかにかかわらず、常にパースした入力データを
返すには、Option.OutputRecordType=I を指定します。詳細については、パース済み入力（222ペー
ジ）を参照してください。
表 95 : パース済み住所出力
応答要素
説明
AdditionalInputData
ValidateAddress で使用されない入力データ。詳
細については、AdditionalInputData について
（245ページ）を参照してください。
ApartmentLabel
アパート指定子 (STE や APT など)。例: 123 E
Main St APT 3
ApartmentLabel2
補助的なアパート指定子。例: 123 E Main St Apt
3, 4th Floor
注 : このリリースでは、このフィールドは常に
空白になります。
ApartmentNumber
アパート番号。例: 123 E Main St APT 3
ApartmentNumber2
補助的なアパート番号。例: 123 E Main St APT
3, 4th Floor
注 : このリリースでは、このフィールドは常に
空白になります。
CanadianDeliveryInstallationAreaName
配達施設名 (カナダ住所のみ)
CanadianDeliveryInstallationQualifierName
配達施設の修飾子 (カナダ住所のみ)
CanadianDeliveryInstallationType
配達施設の種類 (カナダ住所のみ)
City
妥当性が確認された都市名
Country
国。フォーマットは、で選択したものになりま
す。
• ISO コード
• UPU コード
• 英語
• フランス語
• ドイツ語
• スペイン語
DepartmentName
REST Web サービスガイド
企業内の下位区分 (英国住所においてのみ)。例え
ば、エンジニアリング部門などです。
221
Universal Addressing モジュール
応答要素
説明
FirmName
妥当性が確認された企業名
HouseNumber
家番号 1。例: 123 E Main St Apt 3
LeadingDirectional
接頭方向指示。例: 123 E Main St Apt 3
POBox
私書箱番号。住所が地方配送路住所である場合
は、地方配送路の私書箱番号がここに表示されま
す。
PostalCode
妥当性が検証された郵便番号。米国住所では、
ZIP Code と呼びます。
PrivateMailbox
私設私書箱のインジケータ。
PrivateMailbox.Type
私設私書箱の種別。次のような値があります。
• Standard
• Non-Standard
注 : PrivateMailboxType (フィールド名にピリオ
ドなし) に換わるものです。これに従って
API 呼び出しを修正してください。
RRHC
地方配送路/Highway Contract のインジケータ
StateProvince
妥当性が確認された州または省の名前
StreetName
ストリート名。例: 123 E Main St Apt 3
StreetSuffix
ストリート接尾語。例: 123 E Main St Apt 3
TrailingDirectional
接尾方向指示。例: 123 Pennsylvania Ave NW
USUrbanName
USPS 都市化名。プエルトリコ住所のみ。
®
パース済み入力
出力には、パース済み形式で入力住所を含めることができます。このようなタイプの出力は、"パース
済み入力" と呼ばれます。パース済み入力フィールドには、ValidateAddress が住所の妥当性を検証し
たかどうかにかかわらず、入力として使用される住所データが含まれます。パース済み入力は、住所
の妥当性を検証できた場合にパース済み住所要素に妥当性が検証された住所が含まれ、オプションで、
住所の妥当性が検証できなかった場合には入力データが含まれるという点で、"パース済み住所要素"
出力と異なります。パース済み入力には、ValidateAddress が住所の妥当性を検証したかどうかにか
かわらず、常に入力住所が含まれます。
パース済み入力フィールドを出力に含めるには、Option.OutputRecordType=I を設定します。
222
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
表 96 : パース済み入力
応答要素
説明
ApartmentLabel.Input
アパート指定子 (STE や APT など)。例: 123 E
Main St APT 3
ApartmentNumber.Input
アパート番号。例: 123 E Main St APT 3
CanadianDeliveryInstallationAreaName.Input
配達施設名 (カナダ住所のみ)
CanadianDeliveryInstallationQualifierName.Input
配達施設の修飾子 (カナダ住所のみ)
CanadianDeliveryInstallationType.Input
配達施設の種類 (カナダ住所のみ)
City.Input
妥当性が確認された都市名
Country.Input
国。フォーマットは、で選択したものになりま
す。
• ISO コード
• UPU コード
• 英語
• フランス語
• ドイツ語
• スペイン語
FirmName.Input
妥当性が確認された企業名
HouseNumber.Input
家番号 1。例: 123 E Main St Apt 3
LeadingDirectional.Input
接頭方向指示。例: 123 E Main St Apt 3
POBox.Input
私書箱番号。住所が地方配送路住所である場合
は、地方配送路の私書箱番号がここに表示されま
す。
PostalCode.Input
妥当性が検証された郵便番号。米国住所では、
ZIP Code と呼びます。
PrivateMailbox.Input
私設私書箱のインジケータ
PrivateMailbox.Type.Input
私設私書箱の種別。次のような値があります。
• 標準
• 非標準
RRHC.Input
地方配送路/Highway Contract のインジケータ
StateProvince.Input
妥当性が確認された州または省の名前
StreetName.Input
ストリート名。例: 123 E Main St Apt 3
StreetSuffix.Input
ストリート接尾語。例: 123 E Main St Apt 3
TrailingDirectional.Input
接尾方向指示。例: 123 Pennsylvania Ave NW
USUrbanName.Input
USPS 都市化名
REST Web サービスガイド
®
223
Universal Addressing モジュール
郵便データ出力
Option.OutputRecordType に P が含まれる場合、以下のフィールドが出力として返されます。
表 97 : 郵便データ出力
224
応答要素
説明
CanadianSERPCode
検証/修正リターンコード (カナダ住所のみ)。詳細については、SERP
リターンコードの取得（217ページ）を参照してください。
IntHexaviaCode
ストリートを表す数値コード (フランスの住所の場合のみ)。 Hexavia
コードの詳細については、www.laposte.fr を参照してください。
IntINSEECode
都市を表す数値コード (フランスの住所の場合のみ)。 INSEE コードの
一覧については、www.insee.fr を参照してください。
PostalBarCode
配達ポイントバーコードの 2 桁の配達ポイント部分 (米国住所のみ)。
詳細については、配達ポイントバーコードの作成（195ページ）を参照
してください。
USAltAddr
他の住所マッチングロジックを使用したかどうか、使用した場合はど
のロジックを使用したかを表します (米国住所のみ)。次のいずれかで
す。
NULL
他の住所スキームを使用していません。
D
別の配達ポイントロジックを使用しました。
E
別の高層マッチロジックを使用しました。
S
小都市デフォルトロジックを使用しました。
U
ユニークな ZIP Code ロジックを使用しました。
USBCCheckDigit
11 桁の配達ポイントバーコードのチェックディジット部分 (米国住所
のみ)。詳細については、配達ポイントバーコードの作成（195ページ）
を参照してください。
USCarrierRouteCode
配達ルートコード (米国住所のみ)。詳細については、配達ルートコー
ドの取得（194ページ）を参照してください。
USCongressionalDistrict
下院選挙区 (米国住所のみ)。詳細については、下院選挙区の取得
（193ページ）を参照してください。
USCountyName
郡名 (米国住所のみ)。詳細については、郡名の取得（194ページ）を参
照してください。
USFinanceNumber
住所の所在地の Finance Number (米国住所のみ)。 Finance Number と
は、複数の ZIP Code を含む地域に USPS が割り当てた番号です。
ValidateAddress は、住所の金融番号が米国データベースの候補住所の
金融番号と一致した場合にのみ、住所の妥当性確認に成功します。
USFIPSCountyNumber
FIPS (連邦情報処理標準) 郡番号 (米国住所のみ)。詳細については、
FIPS 郡番号の取得（194ページ）を参照してください。
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
応答要素
説明
USLACS
住所が、LACS
Link
変換の候補であるかどうかを表します (米国住所の
み)。次のいずれかです。
Y 住所は LACSLink 処理の候補です。 LACSLink が有効である場合は、
Link
ValidateAddress は、LACS
データベースを使用して住所を変
Link
換します。変換に成功した場合、出力住所は LACS
データベー
スから取得した新しい住所になります。変換できなかった場合
は、住所は変換されません。
N 住所は LACSLink 処理の候補ではありません。ただし、LACSLink
Link
処理が要求され、LACS
データベースがインストールされてお
Link
り、かつ、次の条件のいずれかが満たされている場合は、LACS
処理が行われる場合があります。
• 住所が地方配送路住所にマッチし、RecordType.Default フィー
ルドで Y が返された場合。
• 入力住所が、米国郵便データベースのいずれの住所にもマッチ
Link
しなかった場合 (複数にマッチしたことによる失敗は、LACS
の候補にはなりません)。
USLastLineNumber
主要都市が同一である複数の ZIP Code を同一グループにまとめる 6
文字の英数字の値。例えば、最終行が次の 2 つのいずれかである住所
は、最終行番号が同一になります。
Chantilly VA 20151 Chantilly VA 20152
結果インジケータ
結果インジケータは、住所に対して実行した処理の種類に関する情報を提供します。結果インジケー
タには、次の 2 種類があります。
• レコードレベルの結果インジケータ（225ページ）
• フィールドレベルの結果インジケータ（229ページ）
レコードレベルの結果インジケータ
レコードレベルの結果インジケータは、各レコードに対する ValidateAddress 処理の結果に関するデー
タを提供します。例えば、マッチングの成功または失敗、住所を処理したコーダーなどの詳細情報を
示します。以下の表に、ValidateAddress が返すレコードレベルの結果インジケータの一覧を示しま
す。
表 98 : レコードレベルインジケータ
応答要素
説明
AddressFormat
返された住所データのタイプ。
REST Web サービスガイド
F
フランス語フォーマット (例: 123 Rue Main)
E
英語フォーマット (例: 123 Main St)
225
Universal Addressing モジュール
応答要素
説明
Confidence
返された住所に割り当てられた確信レベル。範囲は 0 ～ 100 です。0 は失
敗を表し、100 はマッチ結果が正しいことに対する確信レベルが非常に高
いことを表します。複数のマッチ結果がある場合、確信レベルは 0 です。
この数値の計算方法については、Validate Address 確信アルゴリズムの概
要（328ページ）を参照してください。
CouldNotValidate
マッチしなかった場合の、妥当性が確認できなかった住所コンポーネント。
•
•
•
•
•
•
•
ApartmentNumber
HouseNumber
StreetName
PostalCode
City
Directional
StreetSuffix
• Firm
• POBoxNumber
• RuralRoute
注 : 複数のコンポーネントがカンマ区切りリストとして返されることが
あります。
CountryLevel
利用可能な住所マッチングのカテゴリ。 This is always "A" for U.S. 独立し
た住所行に存在する余分なデータを返します。次のいずれかです。
A
住所は非常に詳細な郵便データを利用できる国にあります。このマッ
チレベルにある住所では、以下の住所要素を検証および修正でき、
入力から欠落している場合は追加できます。
• 郵便番号
• 都市名
• 州/郡名
• ストリート住所要素
• 国名
B
住所は中程度の詳細さの郵便データを利用できる国にあります。こ
のマッチレベルにある住所では、以下の住所要素を検証および修正
でき、入力から欠落している場合は追加できます。
• 郵便番号
• 都市名
• 州/郡名
• 国名
C
住所は郵便データが詳細ではない国にあります。このマッチレベル
にある住所に対して、以下のアクションを実行することができます。
• 国名の検証および修正 (欠落している国名を補うことはできません)
• 郵便番号のフォーマットの検証 (欠落している郵便番号を補ったり、
番号を検証することはできません)
226
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
応答要素
説明
MatchScore
MatchScore は、出力住所がどの程度正しいかを示します。 MatchScore
は、マッチ結果を得るために入力住所をどれだけ変更したかを表す
Confidence とはまったく異なるものです。MatchScore の意味は米国住所
と米国以外の住所で異なります。住所をサポートしていません。
米国住所に対しては、 MatchScore は 0 ～ 9 の段階に対応する 1 桁のスコ
アで、ストリート名マッチの近さを反映します (ValidateAddress による変
換があれば実行後)。 0 は完全一致を意味し、9 は最も可能性の低い一致を
意味します。マッチしなかった場合、このフィールドは空白です。
米国とカナダ以外の住所では、MatchScore は 5 桁のスコアで、最大値は
00999 です。数字が大きいほど、より近い一致を意味します。
このフィールドは、カナダの住所には適用されません。
米国住所のマッチスコアと米国以外の住所のマッチスコアは、同等と見
なすことはできないことに注意してください。住所をサポートしていませ
ん。例えば、米国住所に対するマッチスコア 4 は、米国以外の住所に対す
る 00004 と同じマッチレベルを意味するものではありません。
注: Validate Address および Advanced Matching モジュールのコンポーネ
ントは、どちらも MatchScore フィールドを使用します。データフ
ローの出力の MatchScore フィールドの値は、出力ステージに送られ
る前に最後に値を変更したステージによって決まります。データフ
ローに Validate Address および Advanced Matching モジュールのコ
ンポーネントが含まれ、各ステージの MatchScore 出力フィールドを
確認したい場合は、Transformer ステージを使用して、MatchScore
値を他のフィールドにコピーしてください。例えば、Validate Address
によって MatchScore という出力フィールドが作成され、Transformer
ステージによって Validate Address の MatchScore フィールドが
AddressMatchScore というフィールドにコピーされます。マッチャー
ステージを実行すると、マッチャーから得た値が MatchScore フィー
ルドに設定され、Validate Address から得た AddressMatchScore の
値が引き渡されます。
MultimatchCount
複数のマッチが検出された場合、一致する可能性のあるレコードの数を示
します。
MultipleMatches
複数のマッチが検出された場合に、複数のマッチを持つ次の住所コンポー
ネントを示します。
•
•
•
•
•
•
•
Firm
LeadingDirectional
PostalCode
StreetName
StreetSuffix
TrailingDirectional
Urbanization
注 : 複数のコンポーネントがカンマ区切りリストとして返されることが
あります。
REST Web サービスガイド
227
Universal Addressing モジュール
応答要素
説明
ProcessedBy
住所を処理した住所コーダーです。
RecordType
USA
米国住所コーダー
CAN
カナダ住所コーダー
INT
国際住所コーダー
米国およびカナダの郵政当局が定義した住所レコードのタイプ (米国およ
びカナダの住所のみサポート):
•
•
•
•
•
•
RecordType.Default
Status
Status.Code
"デフォルト" マッチを示すコード
Y
住所はデフォルトレコードにマッチしています。
NULL
住所はデフォルトレコードにマッチしていません。
マッチの成功または失敗を報告します。複数のマッチがある場合、一致す
る可能性のあるすべてのものに対してこのフィールドが "F" になります。
NULL
成功
F
失敗
失敗の原因 (ある場合)。複数のマッチがある場合、一致する可能性のある
すべてのものが "MultipleMatchesFound" になります。
•
•
•
•
Status.Description
FirmRecord
GeneralDelivery
HighRise
PostOfficeBox
RRHighwayContract
Normal
DisabledCoder
InsufficientInputData
MultipleMatchesFound
UnableToValidate
問題の説明 (ある場合)。
Possible Multiple Addresses
Found
Status.Code=MultipleMatchesFound の
場合にこの値が表示されます。
Address Not Found
Status.Code=UnableToValidate の場合
にこの値が表示されます。
PerformUSProcessing disabled Status.Code=DisabledCoder の場合に
この値が表示されます。
PerformCanadianProcessing
disabled
Status.Code=DisabledCoder の場合に
この値が表示されます。
PerformInternationalProcessing Status.Code=DisabledCoder の場合に
disabled
この値が表示されます。
228
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
フィールドレベルの結果インジケータ
フィールドレベルの結果インジケータは、ValidateAddress が各住所要素をどのように処理したかを示
します。フィールドレベルの結果インジケータは、修飾子 "Result" で返されます。例えば、
HouseNumber のフィールドレベルの結果インジケータは HouseNumber.Result に格納されます。
フィールドレベルの結果インジケータを有効にするには、。このオプションの詳細については、出力
データオプション（189ページ）を参照してください。
次の表に、フィールドレベルの結果インジケータの一覧を示します。特定のフィールドが住所に適用
されない場合、結果インジケータが空白になる場合があります。
表 99 : フィールドレベルの結果インジケータ
応答要素
説明
AddressRecord.Result
これらの結果コードは国際住所のみに適用されま
す。
ApartmentLabel.Result
REST Web サービスガイド
M
複数。入力住所が郵便データベース内の複
数レコードにマッチし、マッチする各レコー
ドのこのフィールドの値が異なります。
S
正規化。このオプションには、標準の略語
が含まれます。
U
マッチしませんでした。
V
妥当性が確認されました。データは正しい
ことが確認され、入力から変更されていま
せん。
A
追加済み。フィールドが空白の入力フィー
ルドに追加されました。米国およびカナダ
の住所のみ。
C
修正済み。米国およびカナダの住所のみ。
D
ドロップ済み。入力に与えられたフィール
ドが削除されました。米国およびカナダの
住所のみ。詳細については、
AdditionalInputData について（245ページ）
を参照してください。
F
書式設定済み。郵便規格に準拠するよう、
スペースや句読文字が変更されました。米
国またはカナダの住所には適用されません。
P
パススルー。データは検証プロセスで使用
されませんでしたが、出力に保持されまし
た。米国およびカナダの住所のみ。
R
アパートラベルが必須ですが、入力住所か
ら欠落しています。米国住所のみ。
S
正規化。このオプションには、標準の略語
が含まれます。
229
Universal Addressing モジュール
応答要素
ApartmentNumber.Result
City.Result
230
説明
U
マッチしませんでした。カナダの住所には
適用されません。
V
妥当性が確認されました。データは正しい
ことが確認され、入力から変更されていま
せん。
A
追加済み。フィールドが空白の入力フィー
ルドに追加されました。米国およびカナダ
の住所のみ。
C
修正済み。カナダの住所のみ。
D
ドロップ済み。入力に与えられたフィール
ドが削除されました。米国住所にのみ適用
されます。詳細については、
AdditionalInputData について（245ページ）
を参照してください。
F
書式設定済み。郵便規格に準拠するよう、
スペースや句読文字が変更されました。米
国またはカナダの住所には適用されません。
P
パススルー。データは検証プロセスで使用
されませんでしたが、出力に保持されまし
た。 EWS にマッチする米国の住所には、P
の値が割り当てられます。米国およびカナ
ダの住所のみ。
R
アパート番号が必須ですが、入力住所から
欠落しています。米国住所のみ。
S
正規化。このオプションには、標準の略語
が含まれます。米国住所には適用されませ
ん。
U
マッチしませんでした。
V
妥当性が確認されました。データは正しい
ことが確認され、入力から変更されていま
せん。
A
追加済み。フィールドが空白の入力フィー
ルドに追加されました。米国およびカナダ
の住所のみ。
C
修正済み。米国およびカナダの住所のみ。
F
ハイフンの欠落または句読文字エラー。カ
ナダの住所のみ。
M
複数。入力住所が郵便データベース内の複
数レコードにマッチし、マッチする各レコー
ドのこのフィールドの値が異なります。米
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
応答要素
説明
国またはカナダの住所には適用されませ
ん。
Country.Result
FirmName.Result
HouseNumber.Result
REST Web サービスガイド
P
パススルー。データは検証プロセスで使用
されませんでしたが、出力に保持されまし
た。
R
都市名が必須ですが、入力住所から欠落し
ています。米国住所にのみ適用されます。
S
正規化。このオプションには、標準の略語
が含まれます。米国住所には適用されませ
ん。
U
マッチしませんでした。カナダの住所には
適用されません。
V
妥当性が確認されました。データは正しい
ことが確認され、入力から変更されていま
せん。
これらの結果コードは、米国またはカナダの住所
には適用されません。
M
複数。入力住所が郵便データベース内の複
数レコードにマッチし、マッチする各レコー
ドのこのフィールドの値が異なります。
S
正規化。このオプションには、標準の略語
が含まれます。
U
マッチしませんでした。
V
妥当性が確認されました。データは正しい
ことが確認され、入力から変更されていま
せん。
C
修正済み。米国住所にのみ適用されます。
P
パススルー。データは検証プロセスで使用
されませんでしたが、出力に保持されまし
た。米国およびカナダの住所のみ。
U
マッチしませんでした。米国およびカナダ
の住所のみ。
V
妥当性が確認されました。データは正しい
ことが確認され、入力から変更されていま
せん。米国住所にのみ適用されます。
A
追加済み。フィールドが空白の入力フィー
ルドに追加されました。カナダの住所の
み。
C
修正済み。カナダの住所のみ。
231
Universal Addressing モジュール
応答要素
LeadingDirectional.Result
説明
D
ドロップ済み。入力に与えられたフィール
ドが削除されました。米国住所にのみ適用
されます。詳細については、
AdditionalInputData について（245ページ）
を参照してください。
F
書式設定済み。郵便規格に準拠するよう、
スペースや句読文字が変更されました。米
国またはカナダの住所には適用されませ
ん。
O
範囲外。. 米国またはカナダの住所には適
用されません。
P
パススルー。データは検証プロセスで使用
されませんでしたが、出力に保持されまし
た。カナダの住所のみ。
R
家番号が必須ですが、入力住所から欠落し
ています。カナダの住所のみ。
S
正規化。このオプションには、標準の略語
が含まれます。米国またはカナダの住所に
は適用されません。
U
マッチしませんでした。
V
妥当性が確認されました。データは正しい
ことが確認され、入力から変更されていま
せん。
A
追加済み。フィールドが空白の入力フィー
ルドに追加されました。米国およびカナダ
の住所のみ。
C
修正済み。空白のない入力が、空白のない
値に修正されました。米国住所にのみ適用
されます。
D
ドロップ済み。入力に与えられたフィール
ドが削除されました。米国住所にのみ適用
されます。詳細については、
AdditionalInputData について（245ページ）
を参照してください。
F
書式設定済み。郵便規格に準拠するよう、
スペースや句読文字が変更されました。米
国またはカナダの住所には適用されません。
M 複数。入力住所が郵便データベース内の複
数レコードにマッチし、マッチする各レコー
ドのこのフィールドの値が異なります。米
国住所にのみ適用されます。
232
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
応答要素
POBox.Result
PostalCode.Result
REST Web サービスガイド
説明
P
パススルー。データは検証プロセスで使用
されませんでしたが、出力に保持されまし
た。カナダの住所のみ。
S
正規化。このオプションには、標準の略語
が含まれます。
U
マッチしませんでした。
V
妥当性が確認されました。データは正しい
ことが確認され、入力から変更されていま
せん。カナダの住所には適用されません。
A
追加済み。フィールドが空白の入力フィー
ルドに追加されました。カナダの住所のみ。
C
修正済み。カナダの住所のみ。
D
ドロップ済み。入力に与えられたフィール
ドが削除されました。米国住所にのみ適用
されます。詳細については、
AdditionalInputData について（245ページ）
を参照してください。
F
書式設定済み。郵便規格に準拠するよう、
スペースや句読文字が変更されました。米
国またはカナダの住所には適用されません。
M
複数マッチ。入力住所が郵便データベース
内の複数レコードにマッチし、マッチする
各レコードのこのフィールドの値が異なり
ます。米国住所にのみ適用されます。
P
パススルー。データは検証プロセスで使用
されませんでしたが、出力に保持されまし
た。カナダの住所のみ。
R
私書箱. 番号が必須ですが、入力住所から欠
落しています。米国住所にのみ適用されま
す。
S
正規化。このオプションには、標準の略語
が含まれます。
U
マッチしませんでした。
V
妥当性が確認されました。データは正しい
ことが確認され、入力から変更されていま
せん。
A
追加済み。フィールドが空白の入力フィー
ルドに追加されました。米国およびカナダ
の住所のみ。
C
修正済み。米国およびカナダの住所のみ。
233
Universal Addressing モジュール
応答要素
説明
F
書式設定済み。郵便規格に準拠するよう、
スペースや句読文字が変更されました。米
国またはカナダの住所には適用されません。
M 複数。入力住所が郵便データベース内の複
数レコードにマッチし、マッチする各レコー
ドのこのフィールドの値が異なります。カ
ナダの住所には適用されません。
PostalCodeCity.Result
PostalCode.Source
234
P
パススルー。データは検証プロセスで使用
されませんでしたが、出力に保持されまし
た。米国住所には適用されません。
R
郵便番号が必須ですが、入力住所から欠落
しています。米国住所にのみ適用されま
す。
S
正規化。このオプションには、標準の略語
が含まれます。米国またはカナダの住所に
は適用されません。
U
マッチしませんでした。例えば、ストリー
ト名と郵便番号が一致しない場合、
StreetName.Result と PostalCode.Result の
両方に U が割り当てられます。
V
妥当性が確認されました。データは正しい
ことが確認され、入力から変更されていま
せん。
これらの結果コードは国際住所のみに適用されま
す。
M
複数。入力住所が郵便データベース内の複
数レコードにマッチし、マッチする各レコー
ドのこのフィールドの値が異なります。
P
パススルー。データは検証プロセスで使用
されませんでしたが、出力に保持されまし
た。
S
正規化。このオプションには、標準の略語
が含まれます。
U
マッチしませんでした。
V
妥当性が確認されました。データは正しい
ことが確認され、入力から変更されていま
せん。
これらの結果コードは米国住所にのみ適用されま
す。
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
応答要素
説明
FinanceNumber 入力の ZIP Code™ は、USPS®
Finance Number グループを
使って検証されました。
ZIPMOVE
™
入力住所の ZIP Code は、
®
™
USPS が改訂した ZIP Code
境界に基づいて修正され、住所
™
に別の ZIP Code が設定され
ました。
PostalCode.Type
P
™
ZIP Code には、PO Box 住所のみが含ま
れます。米国住所にのみ適用されます。
U
™
ZIP Code は、特定の会社または場所に
™
割り当てられたユニークな ZIP Code で
す。米国住所にのみ適用されます。
M
™
ZIP Code は、軍施設の住所です。米国
住所にのみ適用されます。
NULL ZIP Code™ は、標準 ZIP Code™ です。
RRHC.Result
REST Web サービスガイド
C
修正済み。カナダの住所のみ。
D
ドロップ済み。入力に与えられたフィール
ドが削除されました。米国住所にのみ適用
されます。詳細については、
AdditionalInputData について（245ページ）
を参照してください。
M
複数マッチ。入力住所が郵便データベース
内の複数レコードにマッチし、マッチする
各レコードのこのフィールドの値が異なり
ます。米国住所にのみ適用されます。
P
パススルー。データは検証プロセスで使用
されませんでしたが、出力に保持されまし
た。カナダの住所のみ。
R
地方配送路/Highway Contract が必須です
が、入力住所から欠落しています。米国住
所にのみ適用されます。
S
正規化。このオプションには、標準の略語
が含まれます。米国およびカナダの住所の
み。
U
マッチしませんでした。米国およびカナダ
の住所のみ。
V
妥当性が確認されました。データは正しい
ことが確認され、入力から変更されていま
せん。米国およびカナダの住所のみ。
235
Universal Addressing モジュール
応答要素
説明
RRHC.Type
これらの結果コードは米国住所にのみ適用されま
す。
StateProvince.Result
Street.Result
236
HC
住所は、Highway Contract 住所です。
RR
住所は、地方配送路住所です。
A
追加済み。フィールドが空白の入力フィー
ルドに追加されました。米国およびカナダ
の住所のみ。
C
修正済み。米国住所にのみ適用されます。
M
複数。入力住所が郵便データベース内の複
数レコードにマッチし、マッチする各レコー
ドのこのフィールドの値が異なります。米
国またはカナダの住所には適用されませ
ん。
P
パススルー。データは検証プロセスで使用
されませんでしたが、出力に保持されまし
た。
R
アパートラベルが必須ですが、入力住所か
ら欠落しています。米国住所にのみ適用さ
れます。
S
正規化。このオプションには、標準の略語
が含まれます。米国住所には適用されませ
ん。
U
マッチしませんでした。カナダの住所には
適用されません。
V
妥当性が確認されました。データは正しい
ことが確認され、入力から変更されていま
せん。
これらの結果コードは国際住所のみに適用されま
す。
M
複数。入力住所が郵便データベース内の複
数レコードにマッチし、マッチする各レコー
ドのこのフィールドの値が異なります。
P
パススルー。データは検証プロセスで使用
されませんでしたが、出力に保持されまし
た。
R
ストリートが修正済みです。家番号が範囲
外にあります。英国および日本のレコード
のみに適用。
S
正規化。このオプションには、標準の略語
が含まれます。
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
応答要素
StreetName.AbbreviatedAlias.Result
説明
U
マッチしませんでした。
V
妥当性が確認されました。データは正しい
ことが確認され、入力から変更されていま
せん。
省略形エイリアス処理の結果を示します。次のい
ずれかです。
NULL 省略形エイリアス処理が実行されませんで
した。
StreetName.Alias.Type
B
StreetName フィールドに基本ストリート
名が格納されています。
L
正規化された住所長が 31 文字未満なの
で、StreetName フィールドに基本名が格
納されています。
N
省略形エイリアスが見つかりませんでし
た。
Y
省略形エイリアスが入力住所に見つかりま
した。 StreetName フィールドに省略形エ
イリアスが格納されています。
この結果コードは米国住所にのみ適用されます。
注 : 以前のリリースでは、このフィールドは
"Alias" と "Type" の間に "." がない
StreetName.AliasType という名前でした。
この古い名前は廃止されました。新しい名
前 StreetName.Alias.Type を使用するよう、
プロセスを更新してください。
Abbreviated エイリアスはストリート名の省略形
です。例えば、HARTS-NM RD は
HARTSVILLE NEW MARLBORO
RD の省略形エイリアスです。
REST Web サービスガイド
Changed
ストリート名が正式に変更された場
合に、新しい名前を表すエイリアス
です。例えば、SHINGLE BROOK
RD というストリート名が
CANNING DR に変更された場合、
CANNING DR が変更済みのエイリ
アスタイプとなります。
Other
このストリート名エイリアスには、
ストリートの他の名前や、ストリー
トの一般的な省略形などがありま
す。
237
Universal Addressing モジュール
応答要素
説明
Preferred
StreetName.PreferredAlias.Result
ストリート名エイリアスはその地域
でよく使用されるエイリアスです。
例えば、あるストリートが "South
Shore Dr." という名前なのは、湖の
南岸を通っているためで、地方自治
体の境界線の南にあるからではあり
ません。この場合、"South" は前置
方位記号ではないので、"S" と短縮
してはいけません。したがっ
て、"South Shore Dr." がよく使用
されるエイリアスになります。
よく使用されるエイリアス処理の結果を示しま
す。次のいずれかです。
NULL よく使用されるエイリアス処理が実行され
ませんでした。
StreetName.Result
238
A
入力住所がエイリアスにマッチしたため、
よく使用されるエイリアス処理が実行され
ませんでした。よく使用されるエイリア
ス処理は、基本住所に対してのみ実行され
ます。
N
よく使用されるエイリアスが見つかりませ
んでした。
Y
入力住所に対してよく使用されるエイリア
スが見つかりました。 StreetName フィー
ルドによく使用されるエイリアスが格納さ
れています。
A
追加済み。フィールドが空白の入力フィー
ルドに追加されました。カナダの住所のみ。
C
修正済み。米国およびカナダの住所のみ。
D
ドロップ済み。入力に与えられたフィール
ドが削除されました。米国住所にのみ適用
されます。詳細については、
AdditionalInputData について（245ページ）
を参照してください。
F
書式設定済み。郵便規格に準拠するよう、
スペースや句読文字が変更されました。米
国またはカナダの住所には適用されません。
M
複数。入力住所が郵便データベース内の複
数レコードにマッチし、マッチする各レコー
ドのこのフィールドの値が異なります。米
国住所にのみ適用されます。
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
応答要素
StreetSuffix.Result
TrailingDirectional.Result
REST Web サービスガイド
説明
P
パススルー。データは検証プロセスで使用
されませんでしたが、出力に保持されまし
た。米国住所には適用されません。
S
正規化。このオプションには、標準の略語
が含まれます。米国およびカナダの住所の
み。
U
マッチしませんでした。
V
妥当性が確認されました。データは正しい
ことが確認され、入力から変更されていま
せん。
A
追加済み。フィールドが空白の入力フィー
ルドに追加されました。米国およびカナダ
の住所のみ。
C
修正済み。米国およびカナダの住所のみ。
D
ドロップ済み。入力に与えられたフィール
ドが削除されました。米国およびカナダの
住所のみ。詳細については、
AdditionalInputData について（245ページ）
を参照してください。
F
書式設定済み。郵便規格に準拠するよう、
スペースや句読文字が変更されました。米
国またはカナダの住所には適用されません。
M
複数。入力住所が郵便データベース内の複
数レコードにマッチし、マッチする各レコー
ドのこのフィールドの値が異なります。米
国住所にのみ適用されます。
P
パススルー。データは検証プロセスで使用
されませんでしたが、出力に保持されまし
た。カナダの住所のみ。
S
正規化。このオプションには、標準の略語
が含まれます。
U
マッチしませんでした。米国住所には適用
されません。
V
妥当性が確認されました。データは正しい
ことが確認され、入力から変更されていま
せん。
A
追加済み。フィールドが空白の入力フィー
ルドに追加されました。米国およびカナダ
の住所のみ。
C
修正済み。米国およびカナダの住所のみ。
239
Universal Addressing モジュール
応答要素
USUrbanName.Result
説明
D
ドロップ済み。入力に与えられたフィール
ドが削除されました。米国およびカナダの
住所のみ。詳細については、
AdditionalInputData について（245ページ）
を参照してください。
F
書式設定済み。郵便規格に準拠するよう、
スペースや句読文字が変更されました。米
国またはカナダの住所には適用されません。
M
複数。入力住所が郵便データベース内の複
数レコードにマッチし、マッチする各レコー
ドのこのフィールドの値が異なります。米
国住所にのみ適用されます。
P
パススルー。データは検証プロセスで使用
されませんでしたが、出力に保持されまし
た。カナダの住所のみ。
S
正規化。このオプションには、標準の略語
が含まれます。
U
マッチしませんでした。カナダの住所には
適用されません。
V
妥当性が確認されました。データは正しい
ことが確認され、入力から変更されていま
せん。
これらの結果コードは米国住所にのみ適用されま
す。
A
追加済み。フィールドが空白の入力フィー
ルドに追加されました。
C
修正済み。
M
複数。入力住所が郵便データベース内の複
数レコードにマッチし、マッチする各レ
コードのこのフィールドの値が異なりま
す。
U
マッチしませんでした。
V
妥当性が確認されました。データは正しい
ことが確認され、入力から変更されていま
せん。
オプションによる出力
ValidateAddress は、選択したオプションに応じて、追加のデータを返します。各オプションによっ
て生成される出力については、以下のセクションのオプションの一覧を参照してください。
240
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
Enhanced Line of Travel 出力
Enhanced Line of Travel 処理では、以下の出力を生成します。
応答要素
説明
USLOTCode
Line of Travel の順序コードと、USPS LOT 順序を表すインジケー
®
タ。このフィールドは、"nnnnY" という形式で、以下の要素で構成さ
れます。
nnnn
4 桁の LOT コード。
Y
次のいずれかです。
• A — 昇順の LOT 順序
• D — 降順の LOT 順序
USLOTHex
昇順でのみファイルのソートが可能な 16 進値です。 16 進値の範囲
は、昇順で 0 ～ FF に続き、降順で FF ～ 0 です。
USLOTSequence
アドオンの DPC の代わりに最終仕分けに使用される 2 バイトの値。
大文字 1 文字の後に 0 ～ 9 の数字が 1 つ続きます。値の範囲は、A0
(99 降順) ～ J9 (00 降順)、および K0 (00 昇順) ～ T9 (99 昇順) です。
Link
LACS
出力
応答要素
説明
USLACS
住所が、LACS
Link
変換の候補であるかどうかを表します (米国住所の
み)。次のいずれかです。
Y 住所は LACSLink 処理の候補です。 LACSLink が有効である場合
Link
は、ValidateAddress は、LACS
データベースを使用して住所
Link
を変換します。変換に成功した場合、出力住所は LACS
デー
タベースから取得した新しい住所になります。変換できなかった
場合は、住所は変換されません。
N 住所は LACSLink 処理の候補ではありません。ただし、LACSLink
Link
処理が要求され、LACS
データベースがインストールされてお
Link
り、かつ、次の条件のいずれかが満たされている場合は、LACS
処理が行われる場合があります。
• 住所が地方配送路住所にマッチし、RecordType.Default フィー
ルドで Y が返された場合。
• 入力住所が、米国郵便データベースのいずれの住所にもマッチ
Link
しなかった場合 (複数にマッチしたことによる失敗は、LACS
の候補にはなりません)。
USLACS.ReturnCode
Link
LACS
A
処理の成功または失敗を表します (米国住所のみ)。
Link
LACS
Link
処理は成功しました。 LACS
処理によってレコー
ドがマッチしました。
REST Web サービスガイド
241
Universal Addressing モジュール
応答要素
説明
Link
00
LACS
Link
処理は失敗しました。 LACS
処理において、マッ
チするレコードは見つかりませんでした。
Link
09
LACS
処理において、入力住所は、古い高層のデフォルト
住所にマッチしました。住所は変換されています。不明確
Link
な住所の提供を避け、LACS
処理では、新しい住所を提供
しません。
Link
14
LACS
Link
処理は失敗しました。 LACS
処理において、マッ
®
チする結果が検出されましたが、他の USPS の規則に基づ
き、変換は行われませんでした。
Link
92
LACS
Link
処理は成功しました。 LACS
処理によってレコー
ドがマッチしました。入力のユニット番号はドロップされま
した。
NULL LACSLink はレコードを処理しなかったか、または LACSLink
処理が実行されませんでした。
RDI 出力
応答要素
説明
RDI
住所の種類を表す値を返します。
B
住所は、企業住所です。
R
住所は、個人住所です。
M
住所は、個人住所であるとともに企業住所でもあります。
NULL
住所が ZIP + 4 レベルでコード化されなかったか、または
®
™
RDI が実行されなかったため、確認されていません。
DPV および CMRA 出力
242
応答要素
説明
DPV
Delivery Point Validation (DPV) 処理の結果を表します。
Y
DPV の確認済みです。この住所に郵便物を配達できます。
N
この住所に郵便物を配達できません。
S
建物番号の妥当性は確認できましたが、ユニット番号は確認で
きませんでした。建物番号は、建物の主要な住所番号です。
ユニット番号は、建物内のアパート、スイート、階など、各ユ
ニットの郵便住所番号です。例えば、以下の住所の場合、424
は建物番号、12 はユニット番号です。
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
応答要素
説明
424 Washington Blvd. Apt. 12
Oak Park IL 60302
USA
D
建物番号の妥当性は確認できましたが、ユニット番号は入力か
ら欠落していました。建物番号は、建物の主要な住所番号で
す。ユニット番号は、建物内のアパート、スイート、階など、
各ユニットの郵便住所番号です。例えば、以下の住所の場合、
424 は建物番号、12 はユニット番号です。
424 Washington Blvd. Apt. 12
Oak Park IL 60302
USA
M
住所は複数の有効な配達ポイントにマッチします。
U
住所は、ZIP + 4 レベルでコード化されなかったため、確認で
®
きませんでした。
V
CMRA
DPVFootnote
DPVVacant
REST Web サービスガイド
住所は、誤検出違反を起こしました。
住所が Commercial Mail Receiving Agency (CMRA: 民間私書箱) であ
ることを表します。
Y
住所は CMRA です。
N
住所は CMRA ではありません。
U
確認できません。
DPV 補足コード。
®
AA
入力住所は、ZIP + 4 ファイルにマッチしました。
A1
入力住所は、ZIP + 4 ファイルにマッチしませんでした。
BB
入力住所は、DPV にマッチしました (すべてのコンポーネ
ント)。
CC
入力住所の主要な番号は DPV にマッチしましたが、補助
的な番号はマッチしませんでした (存在しましたが有効で
はありませんでした)。
N1
入力住所の主要な番号は DPV にマッチしましたが、高層
住所に補助的な番号が欠落しています。
M1
入力住所の主要な番号が欠落しています。
M3
入力住所の主要な番号が無効です。
P1
入力住所に、PO、RR、または HC Box 番号がありません。
RR
入力住所は、CMRA にマッチしました。
R1
入力住所は CMRA にマッチしましたが、補助的な番号が
存在しません。
®
建物が空家 (90 日間使用されていない) かどうかを表します。次のい
ずれかです。
243
Universal Addressing モジュール
応答要素
DPVNoStat
Link
Suite
説明
Y
建物は空家です。
N
建物は空家ではありません。
NULL
オプションが選択されていません。
建物が、郵便物を受け取ることのできない "no stat" の建物であるかど
うかを表します。次のいずれかです。
Y
建物は、郵便物を受け取ることのできない "no stat" の建
物です。
N
建物は、郵便物を受け取ることのできない "no stat" の建
物ではありません。
NULL
オプションが選択されていません。
出力
応答要素
説明
SuiteLinkReturnCode
ValidateAddress が、補助的な住所情報を修正したかどうかを表しま
す (米国住所のみ)。次のいずれかです。
A
ValidateAddress は、補助的な住所情報を修正しました。
00
ValidateAddress は、補助的な住所情報を修正しませんで
した。
NULL
Suite
XX
Suite
Link
は実行されませんでした。
Link
処理においてエラーが発生しました。例えば、
Link
データベースの有効期限が切れている場合にエ
Suite
ラーが発生します。
SuiteLinkMatchCode
Link
Suite
のマッチング処理に関する追加情報を提供します (米国 mail
stop (郵便物集配所)(米国住所のみ)
A
ValidateAddress は、補助的な住所情報を修正しました。
B
ValidateAddress は、補助的な住所情報を修正しませんでした。
マッチング処理に関するその他の詳細情報はありません。
C
FirmName フィールドの語はすべて、「ノイズ」語です。ノ
®
イズ語は、USPS によって定義されており、企業名のマッチ
ングの際には無視されます。ノイズ語の例として
は、"company" や "corporation" があります。 ValidateAddress
は、ノイズ語のみで構成される企業名に対し、補助的な住所情
報を修正できません。例えば、"Company and Corporation" と
いう表記は、ノイズ語のみで構成されています。
D
Link
住所は、高層のデフォルト住所ではありません。 Suite
マッ
チングは、高層のデフォルト住所に対してのみ行われます。
高層デフォルトとは、住所に有効な補助的情報が含まれていな
244
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
応答要素
説明
い (アパート番号やアパート種別が欠落している) 場合に使用
されるデフォルトです。
E
Link
Suite
Link
データベースの有効期限が切れているため、Suite
処理は失敗しました。
NULL SuiteLink は実行されなかったか、エラーが発生しました。
SuiteLinkFidelity
Link
ValidateAddress における、Suite
データベースの企業名に対する
マッチング精度を表します。
Link
1
企業名は、Suite
2
精度の高いマッチです。企業名に含まれる語が、1 語を除い
Link
てすべて Suite
データベースの企業名に一致しました。
3
精度の低いマッチです。企業名の中の複数の語が、Suite
データベースに完全に一致しました。
Link
データベースの企業名に一致しませんでした。
NULL SuiteLink が企業名のマッチングに失敗したか、実行されなかっ
たか、またはエラーが発生しました。
VeriMove 出力
応答要素
説明
VeriMoveDataBlock
ValidateAddress が、VeriMove Express に渡される入力データを含む
250 バイトのフィールドを返すかどうかを示します。このフィールド
には、VeriMove で必要とされる詳細結果インジケータデータが含ま
れます。このフィールドの内容については、VeriMove のユーザーガ
イドを参照してください。次のいずれかです。
Y
フィールド VeriMoveDataBlock を返します。
N
フィールド VeriMoveDataBlock を返しません。
AdditionalInputData について
ValidateAddress は、住所正規化プロセスにおいて、一部の入力データを無視します。この余分なデー
タ ("ドロップデータ" と呼ばれることもあります) は、AdditionalInputData に返されます。ドロップ
データの例としては、次のものがあります。
• 配達指示 (「勝手口に置いてください」など)
• 電話番号 ("555-135-8792" など)
• 注意書き ("Attn: John Smith" など)
このようなデータは通常、住所に混在していることはありません。混在している場合、ValidateAddress
はほとんどの場合にこの余分なデータを認識することができ、AdditionalInputData に返します。
注 : ValidateAddress は、split indicia 住所からのドロップデータを返しません。 split indicia 住所と
は、主要な住所が複数の住所行に分割されている住所のことです。例えば、主要な住所が "1
Green River Valley Rd" である場合、この住所の split indicia バージョンは 1 Green River Valley
Rd 01230 となります。
REST Web サービスガイド
245
Universal Addressing モジュール
住所に複数のドロップデータがある場合、各データは、米国住所の場合はセミコロンと空白 ("; ")、米
国外の住所の場合は空白で区切られます。 AdditionalInputData におけるドロップデータの順序は、次
のようになります。
1. care of (気付)、mail stop (郵便物集配所)(米国住所のみ)
2. 住所行に検出されたその他の余分なデータ
3. まったく未使用のデータ行
例えば、入力住所が次のとおりであるとします。
123 Main St C/O John Smith
Apt 5 Drop at back dock
[email protected]
555-123-4567
05674
この場合、AdditionalInputData には次のデータが含まれます。
C/O John Smith; Apt 5 Drop At Back Dock; 555-123-4567; [email protected]; 555-123-4567
ValidateAddress では、以下の種類の余分なデータを処理できます。
• Care Of (気付) データ（246ページ）
• 独立した住所行に存在する余分なデータ（246ページ）
• 住所行に混在する余分なデータ（247ページ）
• 二重住所（248ページ）
Care Of (気付) データ
米国住所のみに対し、"care of" データが AdditionalInputData に返されます。以下の住所には、"care
of" データの例が含まれています。
123 Main St C/O John Smith
Apt 5
05674
123 Main St
Apt 5 ATTN John Smith
05674
123 Main St Apt 5
MailStop 2
05674
独立した住所行に存在する余分なデータ
ValidateAddress は、米国およびカナダの住所に対し、独立した住所行に存在する余分なデータを返し
ます。
ValidateAddress は、米国住所に対し、住所行の空白でない最初の 2 行を使用して、住所の正規化を行
います。ただし、企業名抽出または都市化コード抽出のオプションが有効である場合を除きます (詳細
については、米国住所に対する住所行処理（189ページ）を参照してください)。他の住所行に存在す
るデータは、AdditionalInputData に返されます。以下の住所において、"John Smith" は
AdditionalInputData に返されます。"John Smith" は空白でない 3 つめの住所行に存在しており、
ValidateAddress は、米国住所に対して、空白でない最初の 2 つの住所行のみを使用するためです。
123 Main St
Apt 5
John Smith
05674
246
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
空白でない最初の 2 つの住所行に余分なデータが含まれる場合、そのデータは AdditionalInputData に
返されます。例えば、以下の住所において、"John Smith" は AdditionalAddressData に返されます。
123 Main St
John Smith
05674
John Smith
123 Main St
05674
以下の住所では、"John Smith" と "Apt 5" の両方が AdditionalAddressData に返されます。 "John Smith"
が返されるのは、これが、最初の 2 つの住所行の 1 つに存在する余分なデータであるためです。"Apt
5" が返されるのは、米国住所データは、空白でない最初の 2 行に記載しなければならないためです。
John Smith
123 Main St
Apt 5
05674
住所行に混在する余分なデータ
住所行に混在する余分なデータは、AdditionalInputData に返されます。例えば、以下の住所におい
て、"John Smith" は AdditionalInputData に返されます。
123 Main St John Smith
05674
123 Main St Apt 5 John Smith
05674
123 Main St John Smith
Apt 5
05674
123 Main St
Apt 5 John Smith
05674
米国住所に対しては、住所行の末尾に存在する余分なデータのみが AdditionalInputData に返されま
す。米国住所において、住所行の末尾以外に存在する余分なデータは返されません。例えば、以下の
住所において、"John Smith" は返されません。
John Smith 123 Main St
05674
123 Main John Smith St
05674
マッチさせるためにストリート名が変更され、ストリート名または接尾語が行の末尾にあった場合は、
AdditionalInputData には、元のストリート名や接尾語が含まれることがあります。例えば、次の住所
があるとします。
Pitney Bowes Software
4200 Parlament
Lanham MD
ValidateAddress は、ストリート名の綴りを修正し、接尾語を追加して、修正済みのストリートの住所
として "4200 Parliament Pl" を返し、"Parlament" を AdditionalInputData に返します。
REST Web サービスガイド
247
Universal Addressing モジュール
二重住所
二重住所とは、ストリート情報と、PO Box/地方配送路/Highway Contract 情報の両方を含む住所のこ
とです。選択した処理オプションに応じて、住所の正規化に使用されない二重住所の一部が、
AdditionalInputData に返される場合があります。詳細については、二重住所ロジックについて（199ペー
ジ）を参照してください。
ValidateAddressGlobal
ValidateAddressGlobal は、米国およびカナダ以外の住所に対する高度な住所の正規化および検証機能
を提供します。 ValidateAddressGlobal は、米国およびカナダの住所の妥当性も確認できますが、そ
の他の国の住所の妥当性を確認する能力に優れています。米国およびカナダ以外の住所を大量に処理
する場合は、 ValidateAddressGlobal の使用を検討してください。
ValidateAddressGlobal は Universal Addressing モジュールの一部です。
ValidateAddressGlobal は、書き直し、パーシング、バリデーション、書式設定など、いくつもの手順
を実行して、住所の品質を高めています。
文字セットのマッピングと書き直し
ValidateAddressGlobal は他国の文字列と、それらの複雑な問題を処理します。 Unicode に完全対応の
文字列処理を使用するため、アルファベット以外の文字をラテン文字セットに書き直したり、異なる
文字セット間でマッピングしたりできます。
文字セットのマッピング、および書き直しについて、以下の機能があります。
• UTF-8、 ISO 8859-1、GBK、BIG5、JIS、EBCDIC など、30 以上の文字セットをサポート
• 言語のルールに従って、付加記号を正しく "除去"
• さまざまなアルファベットをラテンスクリプトに書き直し
• ギリシャ文字 (BGN/PCGN 1962、ISO 843 - 1997)
• キリル文字 (BGN/PCGN 1947、ISO 9 - 1995)
• ヘブライ文字
• 日本語の片仮名、平仮名、漢字
• 中国語のピンイン (標準中国語、広東語)
• 韓国語のハングル文字
住所のパーシング、書式設定、および正規化
住所データのフィールド入力の誤りを再構成することは、特に他国の住所で行う場合、複雑で難しい
作業です。住所データをコンピュータのシステムに入力する際、曖昧になってしまう部分が多いから
です。特に問題なのが、(企業や個人名をストリートの住所フィールドに入力するなど) 要素を誤った
フィールドに入力したり、省略形を使用する場合に、言語固有だけでなく、国固有の省略形に変えて
しまうケースです。 ValidateAddressGlobal は住所行の住所要素を識別し、正しいフィールドに割り当
てます。これは実際の検証前に行う重要な作業です。再構成を行わなければ、"一致が見つからない"
という結果になる可能性があります。
住所要素の正しい識別は、特定のフィールド長要件に合わせて住所を切り捨てたり、短縮しなければ
ならない場合にも重要です。正しい情報が正しいフィールドに割り当てられていれば、特定の切り捨
てルールを適用することができます。
• 住所行をパースおよび解析し、個々の住所要素を識別
• 30 を越える文字セットを処理
• 宛先国の郵便ルールに従って住所の書式を整える
248
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
• 住所要素を正規化 (AVENUE を AVE に変更するなど)
Global Address 検証
住所の検証は、正しくパースされた住所データを郵便組織または他のデータプロバイダが提供する参
照データベースと比較する訂正処理です。 ValidateAddressGlobal は、洗練されたファジーマッチン
グテクノロジーを使用して個々の住所要素を検証し、正しいことを確認するとともに、郵便規格と
ユーザの優先設定に基づいて出力を正規化および書式設定します。 FastCompletion 検証タイプは、簡
易住所入力アプリケーションに使用できます。いくつかの住所フィールドには切り捨てられたデータ
を入力することができ、この入力に基づいて提案を生成します。
住所を完全に検証できない場合もあります。 ValidateAddressGlobal には、配達可能性によって住所を
分類する、ユニークな配達可能性評価機能があります。
リソース URL
JSON エンドポイント:
http://server:port/rest/ValidateAddressGlobal/results.json
XML エンドポイント:
http://server:port/rest/ValidateAddressGlobal/results.xml
JSON 応答の例
次の例では、JSON 応答を要求します。
http://myserver:8080/rest/ValidateAddressGlobal/results.json?
City.StateProvince=NY&Data.AddressLine1=1+Global+View&
Data.City=Troy&Data.Country=USA
この要求から次のような JSON が返されます。
{"output": [{
"Country.Input": "USA",
"AddressLine1.Input": "1 Global View",
"City.Input": "Troy",
"Country": "UNITED STATES",
"AddressLine1": "1 GLOBAL VW",
"HouseNumber": "1",
"StreetName": "GLOBAL",
"StreetSuffix": "VW",
"City": "TROY",
"PostalCode": "12180-8371",
"PostalCode.Base": "12180",
"PostalCode.AddOn": "8371",
"StateProvince": "NEW YORK",
"County": "RENSSELAER",
"LastLine": "TROY NY 12180-8371",
"AddressBlock1": "1 GLOBAL VW",
"AddressBlock2": "TROY NY 12180-8371",
"ProcessStatus": "C4",
"ProcessStatus.Description": "Corrected - all elements have been
checked",
"ModeUsed": "BATCH",
"CountOverflow": "NO",
"MailabilityScore": "5",
"Confidence": "82.09",
"ElementResultStatus": "88F088E0F000000000E0",
"ElementInputStatus": "00600050600000000060",
"ElementRelevance": "11101010100000000010",
"AddressType": "S",
REST Web サービスガイド
249
Universal Addressing モジュール
"AMAS.Status": "EAM0",
"user_fields": []
}]}
XML 応答の例
次の例では、XML 応答を要求します。
http://myserver:8080/rest/ValidateAddressGlobal/results.xml?
Data.AddressLine1=1+Global+View&Data.City=Troy&
Data.Country=USA&Data.StateProvince=NY
この要求から次のような XML が返されます。
<ns2:xml.ValidateAddressGlobalResponse
xmlns:ns2="http://www.pb.com/spectrum/services/ValidateAddressGlobal">
<ns2:output>
<ns2:Address>
<ns2:Country>UNITED STATES</ns2:Country>
<ns2:AddressLine1>1 GLOBAL VW</ns2:AddressLine1>
<ns2:HouseNumber>1</ns2:HouseNumber>
<ns2:StreetName>GLOBAL</ns2:StreetName>
<ns2:StreetSuffix>VW</ns2:StreetSuffix>
<ns2:City>TROY</ns2:City>
<ns2:PostalCode>12180-8371</ns2:PostalCode>
<ns2:PostalCode.Base>12180</ns2:PostalCode.Base>
<ns2:PostalCode.AddOn>8371</ns2:PostalCode.AddOn>
<ns2:StateProvince>NY</ns2:StateProvince>
<ns2:County>RENSSELAER</ns2:County>
<ns2:LastLine>TROY NY 12180-8371</ns2:LastLine>
<ns2:AddressBlock1>1 GLOBAL VW</ns2:AddressBlock1>
<ns2:AddressBlock2>TROY NY 12180-8371</ns2:AddressBlock2>
<ns2:ProcessStatus>C4</ns2:ProcessStatus>
<ns2:ProcessStatus.Description>
Corrected - all elements have been checked
</ns2:ProcessStatus.Description>
<ns2:ModeUsed>BATCH</ns2:ModeUsed>
<ns2:CountOverflow>NO</ns2:CountOverflow>
<ns2:MailabilityScore>5</ns2:MailabilityScore>
<ns2:Confidence>85.09</ns2:Confidence>
<ns2:ElementResultStatus>
88F0F8E0F000000000E0
</ns2:ElementResultStatus>
<ns2:ElementInputStatus>
00606050600000000060
</ns2:ElementInputStatus>
<ns2:ElementRelevance>
11101010100000000010
</ns2:ElementRelevance>
<ns2:AddressType>S</ns2:AddressType>
<ns2:AMAS.Status>EAM0</ns2:AMAS.Status>
<ns2:user_fields/>
</ns2:Address>
</ns2:output>
</ns2:xml.ValidateAddressGlobalResponse>
要求
入力データのパラメータ
ValidateAddressGlobal は、入力として標準住所を受け取ります。どの国の住所であるかにかかわら
ず、すべての住所がこのフォーマットを使用します。
250
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
表 100 : ValidateAddressGlobal の入力
パラメータ
フォー
マット
説明
Data.AddressLine1 から
Data.AddressLine6
文字列
これらのフィールドには住所行データが格納されます。
AddressLine1 には最初の住所行、AddressLine2 には 2 行目
の住所行が格納されます。以降もこれと同様になります。
都市、州/省、および郵便番号情報は、住所行フィールドで
はなく、それぞれのフィールドに配置する必要があります。
例:
AddressLine1: 17413 Blodgett Road
AddressLine2: PO Box 123
City: Mount Vernon
StateProvice: WA
PostalCode: 97273
Country: USA
入力住所が適切な住所行および City、StateProvice、
PostalCode フィールドにまだパースされていない場合は、
住所行フィールドの代わりに UnformattedLine フィールドを
使用してください。
Data.City
文字列
都市名
Data.StateProvince
文字列
州または省。
Data.PostalCode
文字列
住所の郵便番号。米国では、 ZIP Code になります。
®
99999
99999-9999
A9A9A9
A9A 9A9
9999
999
Data.Contact
文字列
受取人の名前。例えば、"Mr. Jones"。
Data.Country
文字列
国名。またはオプションに値が指定されていない場合、国
を指定する必要があります。
Data.FirmName
文字列
会社名または企業名
Data.Street
文字列
ストリート
Data.Number
Building Number
[79]
Data.Building
文字列
建物
Data.SubBuilding
文字列
従属する建物
Data.DeliveryService
文字列
配送サービス
Data.UnformattedLine1 から文字列
Data.UnformattedLine10
REST Web サービスガイド
入力住所が完全にパースされていない場合、かつ
ValidateAddressGlobal によって住所を適切なフィールドに
251
Universal Addressing モジュール
パラメータ
フォー
マット
説明
パースしたい場合は、このフィールドを使用してください。
例:
UnformattedLine1: 17413 Blodgett Road
UnformattedLine2: PO Box 123
UnformattedLine3: Mount Vernon WA 97273
UnformattedLine4: USA
この住所は、以下の出力フィールドにパーシングされます。
AddressLine1: 17413 Blodgett Road
AddressLine2: PO Box 123
City: Mount Vernon
StateProvice: WA
PostalCode: 97273
Country: USA
注 : フォーマットされていない行フィールドへの入力を指
定した場合は、住所全体をフォーマットされていない
行フィールドだけを使用して指定する必要がありま
す。 City や StateProvince など、その他のフィールド
を、フォーマットされていない行フィールドと合わせ
て使用することはできません。
オプションのパラメータ
入力オプション
表 101 : ValidateAddressGlobal の入力オプション
パラメータ
説明/有効値
Option.Database.AddressGlobal 住所検証で使用する郵便データを含むデータベースリソースを指定しま
す。指定できるのは、Management Console の [グローバルデータベース
リソース] パネルで定義されたデータベースに限られます。詳細について
は、『Spectrum™ Technology Platform 管理ガイド』を参照してください。
Option.Input.DefaultCountryISO3 入力レコードに明示的な国情報が含まれない場合に使用するデフォルト国
を指定します。指定する際、ISO3 の国コードを使用してください。デフォ
ルト国を指定しない場合、各入力レコードの Country 入力フィールドに国
を指定する必要があります。 ISO コードの一覧は、各国の ISO コードとモ
ジュールサポート（306ページ）を参照してください。
Option.Input.ForceCountryISO3 住所レコードが、常にここで指定された国から発送されたものとして扱わ
れるようにします。住所レコードの国やデフォルト国は上書きされます。
指定する際、ISO3 の国コードを使用してください。 ISO コードの一覧は、
各国の ISO コードとモジュールサポート（306ページ）を参照してくださ
い。
252
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
パラメータ
説明/有効値
Option.Input.FormatDelimiter 入力ファイルで複数行の住所に標準以外の書式設定を使用できます。この
フィールドで指定できる値を次に示します。
•
•
•
•
•
•
•
•
CRLF (デフォルト)
LF
CR
SEMICOLON ( 2101 MASSACHUSETTS AVE NW ; WASHINGTON DC
20008)
COMMA (2101 MASSACHUSETTS AVE NW , WASHINGTON DC 20008
)
TAB (2101 MASSACHUSETTS AVE NW WASHINGTON DC 20008 )
PIPE (2101 MASSACHUSETTS AVE NW | WASHINGTON DC 20008 )
SPACE (2101 MASSACHUSETTS AVE NW WASHINGTON DC 20008)
注 : 入力オプションと出力オプションの両方に同じ値を選択する必要が
あります。
出力オプション
表 102 : ValidateAddressGlobal の出力オプション
パラメータ
説明
Option.Result.MaximumResults このオプションには、返される候補住所の最大数を指定します。デ
フォルト値は 1 です。最大数は 20 です。 FastCompletion モードを
使用している場合は、1 よりも大きい数を入力して、フィールド入力
のための選択肢が複数返されるようにするとよいでしょう。
Option.Result.IncludeInputs
出力の中に、入力データを含めるかどうかを指定します。有効にする
と、.Input で終わるフィールド (対応する入力フィールドを含む) が出
力に含まれます。例えば、出力フィールドの AddressLine1.Input に、
入力フィールドの AddressLine1 に指定したデータが含まれます。
TRUE
入力データを出力に含めます。
FALSE
入力データを出力に含めません (デフォルト)。
Option.Result.StateProvinceType StateProvince フィールドのフォーマットを指定します。次のいずれ
かを選択します。
ABBREVIATION
州または省の省略形を返します。例えば、
North Carolina であれば "NC" が返ります。
COUNTRY_STANDARD その国の郵便当局で使用されるフォーマッ
トに応じて、省略形または完全な名前が返
ります（デフォルト）。
EXTENDED
REST Web サービスガイド
州または省の (省略形ではなく) 完全な名前
が返ります (例えば、"North Carolina" な
ど)。
253
Universal Addressing モジュール
パラメータ
説明
Option.Result.CountryType
ValidateAddressGlobal から返される国名で使用する言語またはコード
を指定します。
ISO2
その国の 2 文字の ISO コード
ISO3
その国の 3 文字の ISO コード
ISO_NUMBER
ISO 国番号
NAME_CN
中国語
NAME_DA
デンマーク語
NAME_DE
ドイツ語
NAME_EN
英語 (デフォルト)
NAME_ES
スペイン語
NAME_FI
フィンランド語
NAME_FR
フランス語
NAME_GR
ギリシャ文字
NAME_HU
ハンガリー語
NAME_IT
イタリア語
NAME_JP
日本語
NAME_KR
韓国語
NAME_NL
オランダ語
NAME_PL
ポーランド語
NAME_PT
ポルトガル語
NAME_RU
ロシア語
NAME_SA
サンスクリット語
NAME_SE
スウェーデン語
Option.Result.PreferredScript 出力がどのアルファベットで返されるかを指定します。データがどの
アルファベットで返されるかは、国によって異なります。言語の設定
で何を選択したかに関わらず、ほとんどの国で出力は Latin I になりま
す。
254
ASCII_Extended
特殊文字 (Ã– = OE など) で拡張された ASCII
文字
ASCII_Simplified
ASCII 文字
Database
(デフォルト) Latin I または ASCII 文字 (参照
データベースの標準による)
Latin
Latin I 文字
Latin_Alt
Latin I 文字 (代替の書き直し)
Postal_Admin_Alt
Latin I または ASCII 文字 (現地郵便局の代替)
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
パラメータ
説明
Postal_Admin_Pref
Latin I または ASCII 文字 (現地郵便局の選択
による)
Latin I 以外のアルファベットを使用する国の場合、返されるアルファ
ベットは国によって異なります。詳細については、「 Latin 1 以外の
アルファベットを使用する国（256ページ）」を参照してください。
Option.Result.PreferredLanguage 出力がどの言語で返されるかを指定します。データがどのアルファ
ベットで返されるかは、国によって異なりますが、ほとんどの国で、
言語の設定に何を選択したかに関わらず、出力は Latin I になります。
Option.Result.Casing
DATABASE
各住所の参照データから得られた言語で返されます。
こちらがデフォルトです。
ENGLISH
地方および州/省の名前が (可能であれば) 英語で出力
されます。
出力の大文字と小文字の区別を指定します。
NATIVE
参照データベースの標準に基づいて出力されます。
UPPER
すべての国で、大文字で出力されます。
LOWER
すべての国で、小文字で出力されます。
MIXED
国固有のルールに従って大文字と小文字が判断されま
す。
NOCHANGE パースモードの場合、データは入力された方法で返さ
れます。バリデーションモードの場合、大文字と小文
字の区別には参照データに見つかったものや、郵便の
ルールに従ったものを使用します。参照データを使用
してチェックできなかった値は、入力時の大文字と小
文字の区別を保持します。
Option.Result.FormatDelimiter 出力で複数行の住所に標準以外の書式設定を使用できます。このフィー
ルドで指定できる値を次に示します。
•
•
•
•
•
•
•
•
CRLF (デフォルト)
LF
CR
SEMICOLON ( 2101 MASSACHUSETTS AVE NW ; WASHINGTON
DC 20008)
COMMA (2101 MASSACHUSETTS AVE NW , WASHINGTON DC
20008 )
TAB (2101 MASSACHUSETTS AVE NW WASHINGTON DC 20008
)
PIPE (2101 MASSACHUSETTS AVE NW | WASHINGTON DC 20008
)
SPACE (2101 MASSACHUSETTS AVE NW WASHINGTON DC
20008)
注 : 入力オプションと出力オプションの両方に同じ値を選択する必
要があります。
REST Web サービスガイド
255
Universal Addressing モジュール
Latin 1 以外のアルファベットを使用する国
Latin I 以外のアルファベットを使用する国の場合、返されるアルファベットは国によって異なります。
それらの国々で、出力がどのように返されるかを以下の表に示します。ここに含まれないすべての国
では、フィールドオプションに指定された値が使用されます。
Country データ
ベース
256
ラテン文字
RUS
キリル文キリル文
字
字
キリル文
字
CYRILLIC_ISO CYRILLIC_BGN CYRILLIC_ISO CYRILLIC_ISO
+
+ LATIN
LATIN_SIMPLE
JPN
漢字
漢字
かな
JAPANESE
CHN
Hanzi
Hanzi
Hanzi
CHINESE_ CHINESE_ CHINESE_ CHINESE_
MANDARIN CANTONESE MANDARIN MANDARIN
+
+ LATIN
LATIN_SIMPLE
HKG
Hanzi
Hanzi
Hanzi
CHINESE_ CHINESE_ CHINESE_ CHINESE_
CANTONESE MANDARIN CANTONESE CANTONESE
+
+ LATIN
LATIN_SIMPLE
TWN
Hanzi
Hanzi
Hanzi
CHINESE_ CHINESE_ CHINESE_ CHINESE_
CANTONESE MANDARIN CANTONESE CANTONESE
+
+ LATIN
LATIN_SIMPLE
GRC
ギリシャギリシャ
文字
文字
ギリシャ
文字
GREEK_ISO GREEK_BGN GREEK_ISO GREEK_ISO
+
+ LATIN
LATIN_SIMPLE
KOR
ラテン文ハングル
字
Hanja
KOREAN
KOREAN
KOREAN + KOREAN +
LATIN_SIMPLE LATIN
ISR
ラテン文ヘブライ
字
文字
ヘブライ
文字
HEBREW
HEBREW
HEBREW + HEBREW +
LATIN_SIMPLE LATIN
ROM
Latin-3
Latin-3
Latin-3
Latin-3
Latin-3
LATIN_SIMPLE LATIN
POL
Latin-2
Latin-2
Latin-2
Latin-2
Latin-2
LATIN_SIMPLE LATIN
CZE
Latin-2
Latin-2
Latin-2
Latin-2
Latin-2
LATIN_SIMPLE LATIN
CRI
Latin-2
Latin-2
Latin-2
Latin-2
Latin-2
LATIN_SIMPLE LATIN
HUN
Latin-2
Latin-2
Latin-2
Latin-2
Latin-2
LATIN_SIMPLE LATIN
MDA
Latin-2
Latin-2
Latin-2
Latin-2
Latin-2
LATIN_SIMPLE LATIN
SVK
Latin-2
Latin-2
Latin-2
Latin-2
Latin-2
LATIN_SIMPLE LATIN
LAT
Latin-7
Latin-7
Latin-7
Latin-7
Latin-7
LATIN_SIMPLE LATIN
JAPANESE
JAPANESE JAPANESE
+
+ LATIN
LATIN_SIMPLE
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
プロセスオプション
表 103 : ValidateAddressGlobal のプロセスオプション
パラメータ
説明
Option.Process.OptimizationLevel このオプションを使用して、処理速度と品質が適切なバランスを保つよう
設定します。次のいずれかです。
NARROW パーサーは、House Number を Street の情報から分割するこ
とを除き、入力の割り当てに厳密に従います。
STANDARD パーサーは、以下に示すように住所要素をよりアクティブに
分割します。
• Province は Locality の情報から分割される
• PostalCode は Locality の情報から分割される
• House Number は Street の情報から分割される
• SubBuilding は Street の情報から分割される
• DeliveryService は Street の情報から分割される
• SubBuilding は Building の情報から分割される
• Locality は PostalCode の情報から分割される
WIDE
パーサーによる分割は Standardに似た方法で行われますが、
追加で最大 10 のパーシング候補が検証に渡されて処理され
ます。検証は検索のツリーを広げ、参照データのエントリを
対象に追加してマッチングを行います。
最適化レベルを調整しても、ここで説明したような分割で必要とされる郵
便参照データ情報が揃っていない国においては、効果が得られない場合が
あります。
分類の精度を Narrow から Standard に増やしても処理パワーはある程度消
費されますが、最適化レベルを Wideに設定し、検索ツリーを大きくして検
証を行った場合、指定された入力データから最も精密な結果を得ようとデー
タのアクセスや比較の件数が増加するため、処理速度が非常に遅くなりま
す。
Option.Process.Mode
REST Web サービスガイド
住所に対して実行する処理のタイプを指定します。次のいずれかです。
BATCH
このモードは手動でのデータの入力または選択が不
可能なバッチ処理環境で使用します。処理速度を重
視して最適化されているため、自動で修正できない
あいまいなデータが見つかった場合は、住所修正の
試行が停止します。指定の国がデータベースに見つ
からない場合、バッチ処理モードはパースモードに
変更されます。
CERTIFIED
このモードはオーストラリア郵便当局のバッチ処理
環境で使用します。 Validate Address Global はオー
ストラリア郵便公社の Address Matching Approval
System (AMAS) で認定されています。これは郵便住
所ファイルに照らして郵便の正規化と検証を行うこ
257
Universal Addressing モジュール
パラメータ
説明
とで、郵便料金の割引と不達郵便物の最小化を実現
します。
FASTCOMPLETION 高速実行モードは、切り捨て処理されたデータを住
所フィールドに入力して、Validate Address Global
による提案の生成を行いたい場合に使用します。例
えば、コールセンターや店頭などで作業をしている
場合に住所要素の一部だけを入力し、高速実行の機
能を使用して、完全な住所の候補を正しく入手する
ことができます。
INTERACTIVE
このモードは、インタラクティブな環境で処理を行
い、住所入力があいまいな場合に提案を生成する場
合に使用します。このタイプの検証は、とりわけ顧
客や潜在顧客から入手したデータを入力した環境で
使用されます。住所がほぼ完全に入力されている必
要があり、その入力データの検証や修正を試行しま
す。あいまいなデータが検出された場合、この検証
タイプでは最大で 20 の提案が生成され、それを選択
候補の一覧として使用できます。指定の国がデータ
ベースに見つからない場合、インタラクティブモー
ドはパースモードに変更されます。
PARSE
このモードは住所入力をトークンに分割し、そのあ
とに他のシステムで行われる処理に送る場合、すな
わち検証をバイパスする場合に使用します。例えば、
住所データの品質がすでに高く、単に素早くトーク
ンに分割して外部のシステムにエクスポートするか、
あるいは下流のステージで使用する場合にこのモー
ドを利用できます。
Option.Process.MatchingScope 住所が検証されるために、住所がどの程度参照データと一致する必要があ
るかを指定します。次のいずれかです。
注 : 以下の設定は、必要とされる詳細情報が郵便参照データに見つから
ない国に対しては効果がない場合があります。
ALL
すべての住所要素が一致する必要があります。
DELIVERYPOINT_LEVEL Validate Global Address で州/省、郵便番号、
都市/地方/郊外、ストリート、家番号、および
従属する建物が一致する必要があります。
258
STREET_LEVEL
Validate Global Address で州/省、郵便番号、
都市/地方/郊外、およびストリートが一致する
必要があります。
LOCALITY_LEVEL
Validate Global Address で州/省、郵便番号、
および都市/地方/郊外が一致する必要がありま
す。
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
応答
住所データ
表 104 : パース済み住所要素
応答要素
説明
AddressBlock1-9
AddressBlock 出力フィールドには、正規化済み、または標準化済みの
住所が、実際の郵便物に印刷される形式にフォーマットされて入りま
す。 Validate Address Global は住所を郵便当局の規格に従って住所ブ
ロックにフォーマットします。住所の各行が、別々の住所ブロック
フィールドに入れて返されます。 AddressBlock1 から AddressBlock9
まで、最大 9 つの住所ブロック出力フィールドが使用されます。例え
ば、以下の住所入力の場合、
AddressLine1: 4200 Parliament Place
AddressLine2: Suite 600
City: Lanham
StateProvince: MD
PostalCode: 20706
以下の住所ブロックが出力されます。
AddressBlock1: 4200 PARLIAMENT PL STE 600
AddressBlock2: LANHAM MD 20706-1882
AddressLine1-6
住所が検証された場合、住所行フィールドには検証済みで正規化済み
の住所行が入ります。住所が検証できなかった場合、住所行フィール
ドには入力された住所が変更されずに入ります。ただし、住所の最後
の行は LastLine フィールドに入ります。例:
AddressLine1: 4200 PARLIAMENT PL STE 600
LastLine: LANHAM MD 20706-1882
AdministrativeDistrict
州/省より小さいが、都市よりも大きいエリア
ApartmentLabel
フラットまたはユニットタイプ (STE や APT など)。例: 123 E Main
St Apt 3
ApartmentNumber
フラットまたはユニット番号。例: 123 E Main St Apt 3
BlockName
地所やブロックの名前。
BuildingName
建物の名前。例えば Sears Tower など。
City
都市の名前。例えば Vancouver, BC など。
City.AddInfo
都市の追加情報。
City.SortingCode
例えばプラハやダブリンなど、特定の国の広い地方で、郵便当局が配
達時間を短縮するために使用するコード。
Contact
受取人の名前。例えば Mr. Jones など。
Country
国が、言語またはオプションで指定されたコードで入ります。
County
州や省に従属する情報。州や省をさらに細かく分割します。米国の郡
はその一例です。
REST Web サービスガイド
259
Universal Addressing モジュール
応答要素
説明
FirmName
会社名。
Floor
部屋番号やアパート番号など、建物をさらに細かく分割する情報。例:
123 E Main St Apt 3, 4th Floor
HouseNumber
家番号 1。例: 298A-1B New South Head Rd
LastLine
最後の住所行を完成させます (都市、州/省、および郵便番号)。
LeadingDirectional
ストリート名の前に付けてストリートの方向を表します。例えば、
138 N Main Street の N がこれに該当します。
Locality
場所の名前に従属し、地方をさらに細かく分割します。例としては、
メキシコの Colonia や、スペインの Urbanisaciones などがあります。
POBox
郵便受けの記述子 (POBox、Postfach、Case Postale など) と番号。
PostalCode
住所の郵便番号。郵便番号のフォーマットは国によって異なります。
PostalCode.AddOn
郵便番号の 2 番目の部分。例えば、カナダの住所ではこれは LDU で
す。米国の住所では、これは ZIP + 4 アドオンです。ほとんどの国
ではこのフィールドを使用しません。
PostalCode.Base
郵便番号の基本部分。
Room
建物の部屋番号。
SecondaryStreet
補助的なストリートまたは地方集配路の名前。
StateProvince
州または省の名前。
StreetName
建物が存在するストリートの名前。例: 123 E Main St Apt 3
StreetSuffix
ストリート接尾語。例: 123 E Main St Apt 3
SubBuilding
部屋番号など建物の一部。例えば Suite 102 など。
Suburb
場所の名前に従属し、地方をさらに細かく分割します。例えばトルコ
の Mahalle など。
Territory
地域の名前。地域は州/省より大きいものです。
TrailingDirectional
接尾方向指示。例: 123 Pennsylvania Ave NW
元の入力データ
このオプションは、元の入力データを <フィールド名>.Input フィールドに出力します。
表 105 : 元の入力データ
260
応答要素
フォー
マット
説明
AddressLine1.Input
文字列
最初の住所行。
AddressLine2.Input
文字列
2 行目の住所行。
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
応答要素
フォー
マット
説明
AddressLine3.Input
文字列
3 行目の住所行。
AddressLine4.Input
文字列
4 行目の住所行。
AddressLine5.Input
文字列
5 行目の住所行。
AddressLine6.Input
文字列
6 行目の住所行。
City.Input
文字列
都市名
StateProvince.Input
文字列
州または省
PostalCode.Input
文字列
住所の郵便番号。米国では、これは ZIP Code です。次の
いずれかのフォーマットです。
99999
99999-9999
A9A9A9
A9A 9A9
9999 999
Contact.Input
文字列
受取人の名前。例えば、"Mr. Jones"。
Country.Input
文字列
入力の国フォーマットに選択したフォーマットを使用して
国を指定します (英語名、ISO コード、または UPU コード)。
有効な値の一覧は、各国の ISO コードとモジュールサポー
ト（306ページ）を参照してください。
FirmName.Input
文字列
会社名または企業名
Street.Input
文字列
ストリート
Number.Input
Building Number
[79]
Building.Input
文字列
建物
SubBuilding.Input
文字列
従属する建物
DeliveryService.Input
文字列
配送サービス
結果コード
これらの出力フィールドには、検証処理の結果に関する情報が格納されます。
表 106 : 結果コード
応答要素
結果コード
AddressType
米国とカナダの住所の場合のみ、AddressType フィールドは住所のタイプ
を示します。次のいずれかです。
F
REST Web サービスガイド
住所の妥当性が確認され社名まで修正されました。
261
Universal Addressing モジュール
応答要素
262
結果コード
B
住所の妥当性が確認され建物名まで修正されました。
G
住所は局留めの住所です。
H
住所の妥当性が確認され高層のデフォルトまで修正されました。
L
住所は、Large Volume Receiver (LVR) です。
M
住所は、軍施設の住所です。
P
住所の妥当性が確認され私書箱まで修正されました。
R
住所の妥当性が確認され地方配送路まで修正されました。
S
住所の妥当性が確認されストリートの住所まで修正されました。
U
タイプが不明なために住所を検証/修正できませんでした。
Confidence
返された住所に割り当てられた確信レベル。範囲は 0 ～ 100 です。0 は失
敗を表し、100 はマッチ結果が正しいことに対する確信レベルが非常に高
いことを表します。
CountOverflow
候補住所数が返される数より多いかどうかを示します。次のいずれかで
す。
はい
他の候補住所があります。他の候補を取得するには、の
値を増やします。
いいえ
いいえ、これ以外の候補はありません。
ElementInputStatus
ElementInputStatus は入力要素を参照データに対してマッチングした際の
要素ごとの情報を提供します。このフィールドの値は、バッチとパースの
どちらのモードを使用するかによって変わります。このフィールドの値に
ついては、ElementInputStatus、 ElementResultStatus、および
ElementRelevance の解釈（265ページ）を参照してください。
ElementRelevance
その土地の郵便当局の基準から基準から判断して、実際にどの住所要素が
関連しているかを示します。このフィールドの値については、
ElementInputStatus、 ElementResultStatus、および ElementRelevance
の解釈（265ページ）を参照してください。
ElementResultStatus
ElementResultStatus は、出力フィールドが入力フィールドから変更されて
いるか、またどのように変わっているかを示すことによって、結果を
ProcessStatus フィールドよりも詳細に分類します。このフィールドの値
については、ElementInputStatus、 ElementResultStatus、および
ElementRelevance の解釈（265ページ）を参照してください。
MailabilityScore
郵便が住所にどの程度確実に配達されるかの予測を示します。次のいずれ
かです。
5
確実に配達される
4
ほぼ確実に配達される
3
おそらく配達される
2
五分五分
1
配達されない可能性が高い
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
応答要素
結果コード
0
配達されない
ModeUsed
使用された処理モードを示します。処理モードは、オプションで指定しま
す。モードの説明については、プロセスオプション（257ページ）を参照
してください。
MultimatchCount
住所が参照データ内の複数の候補住所と一致した場合、このフィールドに
は一致した候補の数が含まれます。
ProcessStatus
出力の品質に関する一般的な記述が含まれます。出力の品質について、詳
しくは ElementResultStatus フィールドを参照してください。
次のいずれかです。
REST Web サービスガイド
V4
検証済み。正しい入力データです。すべての要素がチェックさ
れ、入力データが完全に一致しました。
V3
検証済み。入力されたデータは正しいものですが、一部または
すべての要素が正規化されたか、あるいは入力データに旧式の名
前または外名 (エクソニム) が含まれます。
V2
検証済み。正しい入力データですが、一部の要素について、参
照データが完全でないために検証できていません。
V1
検証済み。正しい入力データですが、ユーザによる正規化によっ
て、正しく配達される可能性が損なわれています(たとえば選択
された郵便番号の長さが短すぎるなど、ユーザによって要素の正
規化が正しく行われていない)。検証によってセットされませ
ん。
C4
修正済み。すべての要素がチェック済みです。
C3
修正済みですが、一部の要素をチェックできませんでした。
C2
修正済みですが、配達のステータスがわかりません (参照データ
がありません)。
C1
修正済みですが、ユーザによる正規化が正しくなかったため、配
達のステータスがわかりません。検証によってセットされませ
ん。
I4
データを完全には修正できませんでしたが、かなりの確率で正し
く配達されます。単一の一致が見つかりました (例えば HNO は
誤りだが、参照データに HNO が 1 件だけ見つかるような場合)。
I3
データを完全には修正できませんでしたが、かなりの確率で正し
く配達されます。複数の一致が見つかりました (例えば HNO は
誤りだが、参照データに複数の HNO が見つかるような場合)。
I2
データを修正できませんでしたが、この住所で正しく配達される
可能性がわずかにあります。
I1
データを修正することができず、正しく配達される可能性もほと
んどありません。
RA
国が強制国の設定から認識されました。
R9
国が DefaultCountryISO3 の設定から認識されました。
263
Universal Addressing モジュール
応答要素
Status
Status.Code
264
結果コード
R8
国が名前からエラーなしで認識されました。
R7
国が名前からエラー付きで認識されました。
R6
国が地域から認識されました。
R5
国が省から認識されました。
R4
国が主要な都市から認識されました。
R3
国がフォーマットから認識されました。
R2
国がスクリプトから認識されました。
R1
国が認識されませんでした。複数の一致が見つかりました。
R0
国が認識されませんでした。
S4
完全にパースされました。
S3
パースされ、複数の結果が得られました。
S2
パースされ、エラーが発生しました。要素の位置が変わってい
ます。
S1
パースエラー。入力フォーマットが一致しません。
N1
バリデーションエラー: 国が認識されなかったため、検証が実行
されませんでした。
N2
バリデーションエラー: 必要な参照データベースを使用できない
ため、検証が実行されませんでした。
N3
バリデーションエラー: 国をロック解除できなかったため、検証
が実行されませんでした。
N4
バリデーションエラー: 参照データベースが破損しているか、
フォーマットが正しくないため、検証が実行されませんでした。
N5
バリデーションエラー: 参照データベースが古すぎるため、検証
が実行されませんでした。
N6
バリデーションエラー: 入力データが十分でないため、検証が実
行されませんでした。
Q3
高速実行ステータス: 提案 (完全な住所) を利用可能です。
Q2
高速実行ステータス: 完全な住所が提案されましたが、入力デー
タの要素と組み合わせられています (追加または削除)。
Q1
高速実行ステータス: 提案された住所は完全ではありません (情
報を追加してください)。
Q0
高速実行ステータス: 十分でない情報から提案が生成されました。
処理試行が成功したか失敗したかをレポートします。
NULL
成功
F
失敗
失敗したものがあれば、その理由を示します。
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
応答要素
結果コード
Status.Description
失敗したものがあれば、その理由を説明する記述が入ります。
ElementInputStatus、 ElementResultStatus、および ElementRelevance の解釈
ElementInputStatus、ElementResultStatus、および ElementRelevance の出力フィールドには、検証
操作の結果を詳細に示す一連の数字が含まれます。 ElementInputStatus にはパーシング操作に関する
いくつかの情報が含まれます。
ElementInputStatus の値は以下のようになります。
44606040600000000060
ElementResultStatus の値は以下のようになります。
88F0F870F00000000040
ElementRelevance の値は以下のようになります。
11101010100000000000
これらのフィールドの値について理解するためには、各ポジションの数字がどの要素を表すか、およ
び各ポジションの値の意味を知る必要があります。たとえば、先頭の数字は PostalCode.Base 出力
フィールドの結果を示します。以下に各ポジションの意味を一覧で示します。
• ポジション 1—PostalCode.Base
• ポジション 2—PostalCode.AddOn
• ポジション 3—City
• ポジション 4—Locality および Suburb
• ポジション 5—StateProvice
• ポジション 6—County
• ポジション 7—StreetName
• ポジション 8—SecondaryStreet
• ポジション 9—HouseNumber
• ポジション 10—Number レベル 1
• ポジション 11—POBox
• ポジション 12—Delivery サービスレベル 1
• ポジション 13—Building レベル 0
• ポジション 14—BuildingName
• ポジション 15—Sub building レベル 0
• ポジション 16—Floor and Room
• ポジション 17—FirmName
• ポジション 18—Organization レベル 1
• ポジション 19—Country
• ポジション 20—Territory
ElementInputStatus の場合、検証の値として以下のいずれかが入ります。
• 0—空
• 1—見つからない
• 2—チェックなし (参照データなし)
REST Web サービスガイド
265
Universal Addressing モジュール
• 3—誤り - 検証によってのみセット。参照データベースによれば、Number または DeliveryService の
いずれかの数が正しい範囲内にない。入力はコピーされ、バッチモードでは修正されていない。イ
ンタラクティブモードと FastCompletion では、提案が提供されている
• 4—この要素内でエラーありで一致
• 5—変更ありで一致 (挿入または削除)。例:
• パーシング: "MainSt 1" の家番号を分割するなど
• バリデーション: 外名 (エクソニム) が入力された場合に置換したり、フィールドのサイズを超えて
入力され、国の参照データベースによって無効とされたデータを短くしたなど
• 6—エラーなしで一致
ElementInputStatus の場合、パーシングの値には以下のいずれかが入ります。
• 0—空
• 1—要素の位置を変更する必要があった
• 2—一致したが、正規化する必要があった
• 3—一致した
ElementRelevance の場合、パーシングの値には以下のいずれかが入ります。
• 0—空
• 1—要素の位置を変更する必要があった
• 2—一致したが、正規化する必要があった
• 3—一致した
ElementResultStatus の場合、(国を除くすべての住所要素に対して) 以下のいずれかの値が入ります。
• 0—空
• 1—検証されず、変更されていない。元のデータがコピーされている
• 2—検証されなかったが正規化された
• 3—検証されたが、入力が無効 (データベースによれば、数値が正しい範囲内にない) であるため変更
されなかった入力がコピーされ、修正されていない (このステータス値はバッチモードでのみセッ
トされる)
• 4—検証されたが、参照データが見つからないため変更されていない
• 5—検証されたが、複数の一致が見つかったため変更されていない。バッチモードでのみセットさ
れる。そうでない場合、入力を置換する複数の提案が修正済みとしてマークされる (ステータス値
7)
• 6—検証され、入力値の除外という変更が行われている
• 7—検証され、参照データに基づく修正という変更が行われている
• 8—検証され、参照データに基づく値の追加という変更が行われている
• 9—検証され、変更はされていないが、配達ステータスがわからない (例えば、DPV の値で、指定の
数値範囲が参照データと部分的にしか一致せず正しくないなど)
• C—検証され、妥当性確認済みだが名前が旧式であるため変更されている
• D—検証され、妥当性確認済みだが外名から公式の名前に変更されている
• E—検証され、妥当性確認済みだが大文字と小文字の区別、または言語に基づく正規化のため変更さ
れている。入力が別の言語と完全に一致する場合に、検証でのみこのステータスがセットされる
• F—検証され、妥当性確認済みで、完全に一致したため変更されなかった
国 (ポジション 19 と 20) に関しては、以下のいずれかの値が入ります。
• 0—空
• 1—国が認識されない
266
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
• 4—国が DefaultCountryISO3 の設定から認識された
• 5—国が認識されない。複数の一致が見つかった
• 6—国がスクリプトから認識された
• 7—国がフォーマットから認識された
• 8—国が主要な都市から認識された
• 9—国が省から認識された
• C—国が地域から認識された
• D—国がエラーありで名前から認識された
• E—国が名前からエラーなしで認識された
• F—国が ForceCountryISO3 の設定から認識された
ValidateAddressLoqate
ValidateAddressLoqate は、郵便当局の住所データを使用して、住所を正規化し、妥当性を確認しま
す。 ValidateAddress Loqate は、情報を修正し、管轄の郵便当局が推奨する書式で住所の書式を整え
ることができます。また、郵便番号、都市名、州/省名など、欠落している郵便情報を追加します。
ValidateAddressLoqate は、ValidateAddressLoqate が住所の妥当性を確認したかどうか、返された住
所の確信レベル、住所の妥当性が確認できなかった場合はその理由など、検証処理に関する結果イン
ジケータも返します。
ValidateAddressLoqate は、住所のマッチングと正規化において、住所行をコンポーネントに分割し、
それらを Universal Addressing モジュールの各種データベースの内容と比較します。マッチを検出し
た場合、入力住所をデータベース情報に合わせて正規化します。データベースにマッチしなかった場
合、ValidateAddressLoqate は、オプションで入力住所の書式を整えます。書式設定プロセスでは、
該当する郵便当局の規則に従って住所行の構成を試みます。
ValidateAddressLoqate は、Universal Addressing モジュールに含まれています。
リソース URL
JSON エンドポイント:
http://server:port/rest/ValidateAddressLoqate/results.json
XML エンドポイント:
http://server:port/rest/ValidateAddressLoqate/results.xml
JSON 応答の例
次の例では、JSON 応答を要求します。
http://myserver:8080/rest/ValidateAddressLoqate/results.json?
Data.AddressLine1=1+Global+View&Data.City=Troy&Data.StateProvince=NY
この要求から次のような JSON が返されます。
{"output_port": [{
"Confidence": "95",
"CouldNotValidate": "",
"ProcessedBy": "LOQATE",
"MatchScore": "100.0",
"AddressLine1": "1 Global Vw",
"AddressLine2": "",
"City": "Troy",
"StateProvince": "NY",
"PostalCode": "12180-8371",
REST Web サービスガイド
267
Universal Addressing モジュール
"Country": "United States",
"FirmName": "",
"PostalCode.Base": "12180",
"PostalCode.AddOn": "8371",
"user_fields": []
}]}
XML 応答の例
次の例では、XML 応答を要求します。
http://myserver:8080/rest/ValidateAddressLoqate/results.xml?
Data.AddressLine1=1+Global+View&Data.City=Troy&Data.StateProvince=NY
この要求から次のような XML が返されます。
<ns2:xml.ValidateAddressLoqateResponse
xmlns:ns2="http://www.pb.com/spectrum/services/ValidateAddressLoqate">
<ns2:output_port>
<ns2:Address>
<ns2:Confidence>95</ns2:Confidence>
<ns2:CouldNotValidate/>
<ns2:ProcessedBy>LOQATE</ns2:ProcessedBy>
<ns2:MatchScore>100.0</ns2:MatchScore>
<ns2:AddressLine1>1 Global Vw</ns2:AddressLine1>
<ns2:AddressLine2/>
<ns2:City>Troy</ns2:City>
<ns2:StateProvince>NY</ns2:StateProvince>
<ns2:PostalCode>12180-8371</ns2:PostalCode>
<ns2:PostalCode.Base>12180</ns2:PostalCode.Base>
<ns2:PostalCode.AddOn>8371</ns2:PostalCode.AddOn>
<ns2:Country>United States</ns2:Country>
<ns2:FirmName/>
<ns2:user_fields/>
</ns2:Address>
</ns2:output_port>
</ns2:xml.ValidateAddressLoqateResponse>
要求
入力データのパラメータ
ValidateAddressLoqate は、入力として住所を受け取ります。住所がある国にかかわらず、すべての
国がこのフォーマットを使用します。米国住所に対する住所行データの処理方法に関する重要な情報
については、「米国住所に対する住所行処理（269ページ）」を参照してください。住所をサポート
していません。
表 107 : 入力フォーマット
268
パラメータ
フォー
マット
説明
Data.AddressLine1
文字列
最初の住所行。
Data.AddressLine2
文字列
2 行目の住所行。
Data.AddressLine3
文字列
3 行目の住所行。
Data.AddressLine4
文字列
4 行目の住所行。
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
パラメータ
フォー
マット
説明
Data.City
文字列
都市名。
Data.Country
文字列
国コードまたは名前を、以下のいずれかのフォーマットで
入力します。
• 2 文字の ISO 3116-1 Alpha-2 国コード
• 3 文字の ISO 3116-1 Alpha-3 国コード
• 英語の国名
ISO コードの一覧については、各国の ISO コードとモジュー
ルサポート（306ページ）を参照してください。
Data.FirmName
文字列
会社名または企業名。
Data.PostalCode
文字列
住所に対する郵便番号を次のいずれかのフォーマットで示
します。
99999
99999-9999
A9A9A9
A9A 9A9
9999 999
Data.StateProvince
文字列
州または省。
米国住所に対する住所行処理
米国住所の場合、AddressLine1 から AddressLine4 の入力フィールドの処理方法は、企業名抽出また
は都市化コード抽出のオプションが有効になっているかどうかによって異なります。 2 つのオプショ
ンのいずれかが有効になっている場合、ValidateAddressLoqate は、4 つすべてのフィールドのデータ
を参照して、住所の妥当性を確認し、要求されたデータ (企業名または都市化コード) を抽出します。
どちらのオプションも有効でない場合は、ValidateAddressLoqate は、空白でない最初の 2 つの住所行
フィールドのみを使用して、妥当性を確認します。他の住所行フィールドのデータは、
AdditionalInputData 出力フィールドに返されます。例を次に示します。
AddressLine1: A1 Calle A
AddressLine2:
AddressLine3: URB Alamar
AddressLine4: Pitney Bowes Software
この住所において、企業名抽出または都市化コード抽出が有効である場合、ValidateAddressLoqate
は、4 つすべての住所行を確認します。企業名抽出と都市化コード抽出がどちらも有効でない場合は、
ValidateAddressLoqate は、AddressLine1 と AddressLine3 (空白でない最初の 2 つの住所行) を参照し
て、そのデータを使用して住所の妥当性を確認します。AddressLine4 のデータは、AdditionalInputData
出力フィールドに返されます。
オプション
以下の表に、ValidateAddressLoqate が返す情報の種類を制御するオプションの一覧を示します。
REST Web サービスガイド
269
Universal Addressing モジュール
表 108 : 出力データオプション
パラメータ
説明
Option.Database.Loqate
国際住所の妥当性の確認に使用するデータベースを指定し
ます。国際住所検証用のデータベースを指定するには、
[データベース] ドロップダウンリストからデータベースを
選択します。
Option.OutputFieldLevelReturnCodes
フィールドレベルの結果インジケータを含めるかどうかを
指定します。フィールドレベルの結果インジケータは、
ValidateAddressLoqate が各住所要素をどのように処理した
かを示します。フィールドレベルの結果インジケータは、
修飾子 "Result" で返されます。例えば、HouseNumber の
フィールドレベルの結果インジケータは
HouseNumber.Result に格納されます。結果インジケー
タの出力フィールドの完全な一覧は、結果インジケータ
（279ページ）を参照してください。
Option.OutputFormattedOnFail
N
フィールドレベルのリターンコードを出力しませ
ん (デフォルト)。
Y
フィールドレベルのリターンコードを出力します。
住所の妥当性を確認できない場合に書式を整えた住所を返
すかどうかを指定します。住所には、その国の標準住所書
式が設定されます。このオプションを選択しない場合、
ValidateAddressLoqate が住所の妥当性を確認できないと、
出力住所フィールドは空白になります。
注 : このオプションは、米国およびカナダの住所のみに
適用されます。その他の住所に対して書式を整えた
データは返されません。
N
失敗した住所の書式を整えません (デフォルト)。
Y
失敗した住所の書式を整えます。
[標準住所を含める]、[住所行の要素を含める]、および [郵
便情報を含める] の各チェックボックスで指定されたフォー
マットを使用して、書式を整えた住所が返されます。 [住所
行の要素を含める] を選択した場合は、妥当性が確認できた
住所に対しては、パース済みで妥当性を確認済みの住所が、
パース済み住所要素に含まれることに注意してください。
住所の妥当性が確認できなかった場合には、パース済み住
所要素には、入力住所がパース済み形式で含まれることに
なります。 ValidateAddressLoqate が住所の妥当性を確認
できたかどうかにかかわらず、必ず入力住所をパース済み
形式で出力したい場合は、[正規化された入力住所要素を含
める] を選択します。
このオプションをオンにする場合は、[標準住所を含める]
と [住所行の要素を含める] またはそのいずれかを選択する
必要があります。
270
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
パラメータ
説明
OutputRecordType オプションで指定されたフォーマット
を使用して、書式を整えた住所が返されます。
OutputRecordType=E を指定した場合は、妥当性が確認で
きた住所に対しては、パース済みで妥当性を確認済みの住
所が、パース済み住所要素に含まれることに注意してくだ
さい。住所の妥当性が確認できなかった場合には、パース
済み住所要素には、入力住所がパース済み形式で含まれる
ことになります。 ValidateAddressLoqate が住所の妥当性
を確認できたかどうかにかかわらず、必ず入力住所をパー
ス済み形式で出力したい場合は、OutputRecordType=I を
指定します。
Y を指定する場合は、OutputRecordType に対して "A" と
"E" またはそのいずれかを指定する必要があります。
Option.OutputRecordType オプションで指定されたフォー
マットを使用して、書式を整えた住所が返されます。
Option.OutputRecordType=E を指定した場合は、妥当性
が確認できた住所に対しては、パース済みで妥当性を確認
済みの住所が、パース済み住所要素に含まれることに注意
してください。住所の妥当性が確認できなかった場合に
は、パース済み住所要素には、入力住所がパース済み形式
で含まれることになります。 ValidateAddressLoqate が住
所の妥当性を確認できたかどうかにかかわらず、必ず入力
住所をパース済み形式で出力したい場合は、
Option.OutputRecordType=I を指定します。
Y を指定する場合は、Option.OutputRecordType に対して
"A" と "E" またはそのいずれかを指定する必要があります。
Option.OutputAddressBlocks
実際の郵便物に印字される、書式を整えた住所を返すかど
うかを指定します。住所の各行が、別々の住所ブロック
フィールドに入れて返されます。 AddressBlock1 から
AddressBlock9 まで、最大 9 つの住所ブロック出力フィー
ルドが使用されます。
例えば、以下の住所入力の場合、
AddressLine1: 4200 Parliament Place
AddressLine2: Suite 600
City: Lanham
StateProvince: MD
PostalCode: 20706
以下の住所ブロックが出力されます。
AddressBlock1: 4200 PARLIAMENT PL STE 600
AddressBlock2: LANHAM MD 20706-1882
AddressBlock3: UNITED STATES OF AMERICA
ValidateAddressLoqate は、郵便当局の規格に従って住所の
書式を整え、住所ブロックの形式にします。国名は、万国
郵便連合 (UPU) の国名で返されます。オプションは、住所
ブロックの国名には影響を与えないことに注意してくださ
REST Web サービスガイド
271
Universal Addressing モジュール
パラメータ
説明
い。[国フォーマット] オプションは、Country 出力フィー
ルドに返される名前のみに影響を与えます。
米国およびカナダ以外の住所に対しては、
ValidateAddressLoqate で住所の妥当性が確認できなかった
場合、住所ブロックは返されません。米国およびカナダの
住所に対しては、妥当性が確認できなかった場合も住所ブ
ロックが返されます。
次のいずれかです。
Option.OutputCasing
N
住所ブロックを返しません。こちらがデフォルト
です。
Y
住所ブロックを返します。
出力データの大文字と小文字の区別を指定します。次のい
ずれかです。
M
出力には、大文字と小文字が混在します (デフォル
ト)。例:
123 Main St
Mytown FL 12345
U
出力に大文字を使用します。例:
123 MAIN ST
MYTOWN FL 12345
Option.HomeCountry
デフォルト国を指定します。大部分の住所が存在する国を
指定してください。例えば、処理する住所の大部分がカナ
ダにある場合は、カナダを指定します。
ValidateAddressLoqate は、[StateProvince]、[PostalCode]、
および [Country] の各住所フィールドから国を特定できな
かった場合、指定された国を使用して、住所の検証を試み
ます。有効な国名には次のものがあります。
Afghanistan, Albania, Algeria, American Somoa, Andorra,
Angola, Anguilla, Antigua And Barbuda, Argentina, Armenia,
Aruba, Australia, Austria, Azerbaijan, Bahamas, Bahrain,
Bangladesh, Barbados, Belarus, Belgium, Belize, Benin,
Bermuda, Bhutan, Bolivia, Bosnia And Herzegovina,
Botswana, Brazil, British Virgin Islands, Brunei Darussalam,
Bulgaria, Burkina Faso, Burundi, Cambodia, Cameroon,
Canada, Cape Verde, Cayman Islands, Central African
Republic, Chad, Chile, China, Colombia, Comoros Islands,
Congo, Cook Islands, Costa Rica, Cote D'Ivoire, Croatia,
Cuba, Cyprus, Czech Republic, Democratic Republic Of
Congo, Denmark, Djibouti, Dominica, Dominican Republic,
East Timor, Ecuador, Egypt, El Salvador, Equitorial Guinea,
Eritrea, Estonia, Ethiopia, Falkland Islands, Faroe Islands,
Federated States Of Micronesia, Fiji, Finland, France, French
Guiana, Gabon, Gambia, Germany, Ghana, Gibraltar,
Greece, Greenland, Grenada, Guadeloupe, Guam,
272
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
パラメータ
説明
Guatemala, Guinea, Guinea Bissau, Guyana, Haiti, Holy
See, Honduras, Hong Kong, Hungary, Iceland, India,
Indonesia, Iran, Iraq, Ireland, Israel, Italy, Jamaica, Japan,
Jordan, Kazakhstan, Kenya, Kiribati, Korea, Kuwait,
Kyrgyzstan, Laos, Latvia, Lebanon, Lesotho, Liberia, Libya,
Liechtenstein, Lithuania, Luxembourg, Macau, Macedonia,
Madagascar, Malawi, Malaysia, Maldives, Mali, Malta,
Marshall Islands, Martinique, Mauritania, Mauritius, Mayotte,
Mexico, Moldova, Monaco, Mongolia, Monserrat, Morocco,
Mozambique, Myanmar, Namibia, Nauru, Nepal, Netherlands
Antilles, New Caledonia, New Zealand, Nicaragua, Niger,
Nigeria, Niue, Norway, Oman, Pakistan, Palau, Panama,
Papua New Guinea, Paraguay, Peru, Philippines, Pitcairn
Islands, Poland, Portugal, Puerto Rico, Qatar, Republic Of
Georgia, Republic Of Korea, Republic Of Singapore, Reunion,
Romania, Russia, Rwanda, Saint Helena, Saint Kitts And
Nevis, Saint Lucia, Saint Pierre And Miquelon, Saint Vincent
And The Grenadines, Samoa, San Marino, Sao Tome And
Principe, Saudi Arabia, Senegal, Seychelles, Sierra Leone,
Slovakia, Slovenia, Solomon Islands, Somalia, South Africa,
Spain, Sri Lanka, Sudan, Surivalue, Swaziland, Sweden,
Switzerland, Syria, Tahiti, Taiwan, Tajikistan, Tanzania,
Thailand, The Netherlands, Togo, Tonga, Trinidad And
Tobago, Tristan Da Cunha, Tunisia, Turkey, Turkmenistan,
Turks And Caicos Islands, Tuvalu, Uganda, Ukraine, United
Arab Emirates, United Kingdom, United States, Uruguay,
Uzbekistan, Vanuatu, Venezuela, Vietnam, Virgin Islands
(US), Wallis And Futuna, Yemen, Yugoslavia, Zambia,
Zimbabwe
Option.OutputCountryFormat
Option.OutputScript
REST Web サービスガイド
Country 出力フィールドに返される国名に使用するフォー
マットを指定します。例えば、英語を選択した場
合、"Deutschland" という国名は "Germany" として返され
ます。
E
英語の国名を使用します (デフォルト)。
I
国名の代わりにその国の 2 文字の ISO の略語を使用
します。
U
国名の代わりにその国の万国郵便連合 (Universal
Postal Union: UPU) の略語を使用します。
出力がどのアルファベットまたはスクリプトで返されるか
を指定します。このオプションは双方向で、通常はネイ
ティブからラテン文字へ、およびラテン文字からネイティ
ブへ実行されます。
Input
書き直しを実行せず、入力と同じスクリプト
で出力します (デフォルト)。
Native
使用可能な場合は、選択した国のネイティブ
スクリプトで出力します。
Latn
英語の値を使用します。
273
Universal Addressing モジュール
パラメータ
説明
Option.KeepMultimatch
一致する可能性のある住所を複数持つ入力住所に対して複
数の住所を返すかどうかを示します。
Y
複数のマッチを返します (デフォルト)。
N
複数のマッチを返しません。
詳細については、複数マッチを返す（274ページ）を参照し
てください。
複数の一致を不許可
一致する可能性のある住所が複数存在する入力住所に対し
て、複数の住所を許可しません。
複数マッチを返す
ValidateAddressLoqate が、入力住所に一致する可能性のある複数の住所を郵便データベース内で検出
した場合に、ValidateAddressLoqate がそれらの複数の住所を返すように設定できます。例えば、次
の住所は米国郵便データベース内の複数の住所にマッチします。
PO BOX 1 New York, NY
オプション
複数マッチを返すには、次の表に示すオプションを使用します。
表 109 : 複数マッチのオプション
説明/有効値
一致する可能性のある住所を複数持つ入力住所に対して複数の住所を
返すかどうかを示します。
返す住所の最大数を示す 1 ～ 10 の数字を入力します。デフォルト値
は 1 です。
注 : との違いは、は複数マッチによって失敗が返され、は複数マッ
チによって 1 つのレコードが返される点です。
どの出力住所が候補住所かを特定するには、必要があります。このよ
うに設定すると、候補住所のレコードのフィールドレベルの結果イン
ジケータに 1 つ以上の値 "M" が格納されます。
出力
複数マッチを返すよう選択した場合、住所は指定した住所フォーマットで返されます。住所フォー
マットの指定については、オプション（269ページ）を参照してください。どのレコードが候補住所で
あるかを特定するには、フィールドレベルの結果インジケータに複数の値 "M" があるかどうかを調べ
ます。詳細については、結果インジケータ（279ページ）を参照してください。
274
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
応答
ValidateAddressLoqate からの出力には、選択した出力カテゴリに応じてさまざまな情報が含まれま
す。
標準住所出力
標準住所出力は、実際の宛名ラベルに表記される住所に対応する 4 行の住所で構成されます。都市、
州/省、郵便番号などのデータも、標準住所出力に含まれます。した場合、Validate Address Loqate
は、妥当性を確認した住所に対し、標準住所出力を返します。したかどうかにかかわらず、妥当性が
確認できなかった住所に対しては、標準住所フィールドが必ず返されます。妥当性が確認されなかっ
た住所に対しては、標準住所出力フィールドには、入力住所がそのまま含まれます ("パススルー" デー
タ)。 ValidateAddressLoqate において、妥当性が確認できなかった場合に、郵便当局の規格に従って
住所を正規化するには、します。
表 110 : 標準住所出力
応答要素
説明
AdditionalInputData
特定の住所コンポーネントに一致しなかった入力データ。詳細につい
ては、「その他の入力データについて」を参照してください。
AddressLine1-4
住所の妥当性が確認された場合は、妥当性が確認され、正規化された
住所の 1 行目です。住所の妥当性が確認できなかった場合は、入力住
所の 1 行目がそのまま出力されます。住所ブロック出力フィールドは
最大で、AddressLine1 から AddressLine4 の 4 つになります。
City
妥当性が確認された都市名。
Country
で選択した、以下のいずれかのフォーマットで示された国。
• ISO コード
• UPU コード
• 英語
FirmName
妥当性が確認された企業名。
PostalCode
妥当性が確認された ZIP Code または郵便番号。
PostalCode.AddOn
ZIP Code の 4 桁のアドオン部分。例えば、60655-1844 という ZIP
™
™
™
Code において、4 桁のアドオン部分は 1844 になります
™
PostalCode.Base
5 桁の ZIP Code 。例: 20706。
StateProvince
妥当性が確認された州または省の略称。
パース済み住所要素出力
した場合、出力住所は、パース済み住所の形式で書式設定されます。 ValidateAddressLoqate で、妥
当性が確認できなかった場合に、パース済み住所形式で書式設定されたデータ (正規化済み住所) を返
すには、します。
注 : ValidateAddressLoqate で、妥当性が確認できたかどうかにかかわらず、常にパースした入力デー
タを返すには、します。詳細については、パース済み入力（277ページ）を参照してください。
REST Web サービスガイド
275
Universal Addressing モジュール
表 111 : パース済み住所出力
Response Element
説明
AddressBlock1-9
AddressBlock 出力フィールドには、正規化済み、
または標準化済みの住所が、実際の郵便物に印刷
される形式にフォーマットされて入ります。
Validate Address Global は住所を郵便当局の規格
に従って住所ブロックにフォーマットします。住
所の各行が、別々の住所ブロックフィールドに入
れて返されます。 AddressBlock1 から
AddressBlock9 まで、最大 9 つの住所ブロック出
力フィールドが使用されます。例えば、以下の住
所入力の場合、
AddressLine1: 4200 Parliament Place
AddressLine2: Suite 600
City: Lanham
StateProvince: MD
PostalCode: 20706
以下の住所ブロックが出力されます。
AddressBlock1: 4200 PARLIAMENT PL STE 600
AddressBlock2: LANHAM MD 20706-1882
ApartmentLabel
アパート指定子 (STE や APT など)。例: 123 E
Main St APT 3
ApartmentNumber
アパート番号。例: 123 E Main St APT 3
ApartmentNumber2
補助的なアパート番号。例: 123 E Main St APT
3, 4th Floor
注 : このリリースでは、このフィールドは常に
空白になります。
City
妥当性が確認された都市名
Country
国。フォーマットは、で選択したものになりま
す。
• ISO コード
• UPU コード
• 英語
276
FirmName
妥当性が確認された企業名
HouseNumber
家番号 1。例: 123 E Main St Apt 3
LeadingDirectional
接頭方向指示。例: 123 E Main St Apt 3
POBox
私書箱番号。住所が地方配送路住所である場合
は、地方配送路の私書箱番号がここに表示されま
す。
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
Response Element
説明
PostalCode
妥当性が検証された郵便番号。米国住所では、
ZIP Code と呼びます。
StateProvince
妥当性が確認された州または省の名前
StreetName
ストリート名。例: 123 E Main St Apt 3
StreetSuffix
ストリート接尾語。例: 123 E Main St Apt 3
TrailingDirectional
接尾方向指示。例: 123 Pennsylvania Ave NW
パース済み入力
出力には、パース済み形式で入力住所を含めることができます。このようなタイプの出力は、"パース
済み入力" と呼ばれます。パース済み入力フィールドには、ValidateAddress が住所の妥当性を検証し
たかどうかにかかわらず、入力として使用される住所データが含まれます。パース済み入力は、住所
の妥当性を検証できた場合にパース済み住所要素に妥当性が検証された住所が含まれ、オプションで、
住所の妥当性が検証できなかった場合には入力データが含まれるという点で、"パース済み住所要素"
出力と異なります。パース済み入力には、ValidateAddress が住所の妥当性を検証したかどうかにか
かわらず、常に入力住所が含まれます。
パース済み入力フィールドを出力に含めるには、。
表 112 : パース済み入力
応答要素
説明
ApartmentLabel.Input
アパート指定子 (STE や APT など)。例: 123 E
Main St APT 3
ApartmentNumber.Input
アパート番号。例: 123 E Main St APT 3
City.Input
妥当性が確認された都市名
Country.Input
国。フォーマットは、で選択したものになりま
す。
• ISO コード
• UPU コード
• 英語
FirmName.Input
妥当性が確認された企業名
HouseNumber.Input
家番号 1。例: 123 E Main St Apt 3
LeadingDirectional.Input
接頭方向指示。例: 123 E Main St Apt 3
POBox.Input
私書箱番号。住所が地方配送路住所である場合
は、地方配送路の私書箱番号がここに表示されま
す。
PostalCode.Input
妥当性が検証された郵便番号。米国住所では、
ZIP Code と呼びます。
REST Web サービスガイド
277
Universal Addressing モジュール
応答要素
説明
StateProvince.Input
妥当性が確認された州または省の名前
StreetName.Input
ストリート名。例: 123 E Main St Apt 3
StreetSuffix.Input
ストリート接尾語。例: 123 E Main St Apt 3
TrailingDirectional.Input
接尾方向指示。例: 123 Pennsylvania Ave NW
ジオコード出力
ValidateAddressLoqate は、緯度/経度、ジオコーディングマッチコード、従属する地方、従属地方に
含まれる地方、従属する大ストリート、下位行政区画と上位行政区画、検索距離を出力として返しま
す。マッチコードは、入力住所がどの程度まで既知の住所に一致したかを表すとともに、マッチング
の全体的なステータスを示します。検索距離コードは、ジオコードが住所の実際の物理的な位置にど
の程度近いかを表します。出力がDataTable クラスに返されます。 DataTable クラスの詳細について
は、の「API の基礎」のセクションを参照してください。
表 113 : 標準住所出力
応答要素
説明
Geocode.MatchCode
住所に対するジオコードマッチングのステータスとレベルを表す 2 バ
イトコード。
最初のバイトはジオコーディングステータスを表し、次のいずれかに
なります。
A
入力住所に一致する複数のジオコード候補が検出され、それ
らの平均が返されました。
I
ある範囲の入力住所のロケーションからジオコードを補間す
ることができました。
P
入力住所に一致する単一のジオコードが検出されました。
U
入力住所に対するジオコードを生成できませんでした。
2 つめのバイトはジオコードマッチングのレベルを表し、次のいずれ
かになります。
278
5
配達ポイント (郵便受けまたは従属する建物)
4
敷地または建物
3
大ストリート
2
地方
1
行政区画
0
なし
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
応答要素
説明
表 114 : 都市/ストリート/郵便番号セントロイドマッチコード
要素
マッチコード
住所ポイント
P4
住所ポイント補間
I4
ストリートセントロイド
A4/P3
郵便番号/都市セントロイド
A3/P2/A2
注 : Geocode.Match.Code は、ストリートセグメントに対して 2 つ
の座標を返すことはしません (ストリートの一部の開始と終了な
ど)。代わりに、入力に対するリターンコードが I3 になった
(大ストリートまたはストリートレベルに補間され、敷地番号は
入力されていない) 場合は、ストリート全体が計算に使用されま
す。
Latitude
小数第 5 位まで計算される 8 桁の度数 (指定したフォーマットで表記
されます)。
Longitude
小数第 5 位まで計算される 8 桁の度数 (指定したフォーマットで表記
されます)。
SearchDistance
メートル単位で表した精度の半径。与えられたジオコードと実際の物
理的位置との間の推測最大距離を表します。このフィールドは、基盤
の参照データから導き出され、その精度と対象範囲に依存します。
結果インジケータ
結果インジケータは、住所に対して実行した処理の種類に関する情報を提供します。結果インジケー
タには、次の 2 種類があります。
• レコードレベルの結果インジケータ
• フィールドレベルの結果インジケータ
レコードレベルの結果インジケータ
レコードレベルの結果インジケータは、各レコードに対する ValidateAddressLoqate 処理の結果に関
するデータを提供します。例えば、マッチングの成功または失敗、住所を処理したコーダーなどの詳
細情報を示します。以下の表に、ValidateAddressLoqate が返すレコードレベルの結果インジケータ
の一覧を示します。
表 115 : レコードレベルインジケータ
応答要素
説明
Confidence
返された住所に割り当てられた確信レベル。範囲は 0 ～ 100 です。0
は失敗を表し、100 はマッチ結果が正しいことに対する確信レベルが
非常に高いことを表します。複数のマッチ結果がある場合、確信レベ
REST Web サービスガイド
279
Universal Addressing モジュール
応答要素
説明
ルは 0 です。この数値の計算方法については、Validate Address 確
信アルゴリズムの概要（328ページ）を参照してください。
CouldNotValidate
マッチしなかった場合の、妥当性が確認できなかった住所コンポーネ
ント。
•
•
•
•
•
•
•
•
•
ApartmentNumber
HouseNumber
StreetName
PostalCode
City
Directional
StreetSuffix
Firm
POBoxNumber
注 : 複数のコンポーネントがカンマ区切りリストとして返されるこ
とがあります。
MatchScore
MatchScore は、入力データと、最も近い一致として検出された参照
データとの間の類似性を表します。 MatchScore は、マッチ結果を得
るために入力住所をどれだけ変更したかを表す Confidence とはまっ
たく異なるものです。MatchScore の意味は米国住所と米国以外の住
所で異なります。住所行の末尾以外に存在する余分なデータは返され
ません。
int getFieldMatchscore (unit record, const char*) フィールドは、入力
データと、最も近い一致として検出された参照データとの間の類似性
を表す 0 ～ 100 の整数値です。 100 は、入力データに、エイリアス、
大文字小文字、付加記号以外の変更を加えなかったことを表します。
0 は、入力データと、最も近い一致として検出された参照データとの
間にまったく類似性がないことを表します。
注: Validate Address Loqate および Advanced Matching モジュール
のコンポーネントは、どちらも MatchScore フィールドを使用し
ます。データフローの出力の MatchScore フィールドの値は、
出力ステージに送られる前に最後に値を変更したステージによっ
て決まります。データフローに Validate Address Loqate および
Advanced Matching モジュールのコンポーネントが含まれ、各
ステージの MatchScore 出力フィールドを確認したい場合は、
Transformer ステージを使用して、MatchScore 値を他のフィー
ルドにコピーしてください。例えば、Validate Address Loqate
によって MatchScore という出力フィールドが作成され、
Transformer ステージによって Validate Address Loqate の
MatchScore フィールドが AddressMatchScore というフィール
ドにコピーされます。マッチャーステージを実行すると、マッ
チャーから得た値が MatchScore フィールドに設定され、Validate
Address Loqate から得た AddressMatchScore の値が引き渡さ
れます。
ProcessedBy
280
住所を処理した住所コーダーです。
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
応答要素
説明
LOQATE
Status
Status.Code
Loqate コーダーが住所を処理しています。
マッチの成功または失敗を報告します。複数のマッチがある場合、一
致する可能性のあるすべてのものに対してこのフィールドが "F" にな
ります。
NULL
成功
F
失敗
失敗の原因 (ある場合)。
• UnableToValidate
Status.Description
問題の説明 (ある場合)。
Address Not Found Status.Code=UnableToValidate の場合にこの
値が表示されます。
フィールドレベルの結果インジケータ
フィールドレベルの結果インジケータは、ValidateAddressLoqate が各住所要素をどのように処理した
かを示します。フィールドレベルの結果インジケータは、修飾子 "Result" で返されます。例えば、
HouseNumber のフィールドレベルの結果インジケータは HouseNumber.Result に格納されます。
フィールドレベルの結果インジケータを有効にするには、。
次の表に、フィールドレベルの結果インジケータの一覧を示します。特定のフィールドが住所に適用
されない場合、結果インジケータが空白になる場合があります。
表 116 : フィールドレベルの結果インジケータ
応答要素
ApartmentLabel.Result
REST Web サービスガイド
説明
A
追加済み。フィールドが空白の入力フィールドに追加されま
した。米国およびカナダの住所のみ。
C
修正済み。米国およびカナダの住所のみ。
D
ドロップ済み。入力に与えられたフィールドが削除されまし
た。米国およびカナダの住所のみ。詳細については、その他
の入力データについてを参照してください。
F
書式設定済み。郵便規格に準拠するよう、スペースや句読文
字が変更されました。
P
パススルー。データは検証プロセスで使用されませんでした
が、出力に保持されました。米国およびカナダの住所のみ。
R
アパートラベルが必須ですが、入力住所から欠落しています。
米国住所のみ。
S
正規化。このオプションには、標準の略語が含まれます。
U
マッチしませんでした。カナダの住所には適用されません。
281
Universal Addressing モジュール
応答要素
ApartmentNumber.Result
City.Result
282
説明
V
妥当性が確認されました。データは正しいことが確認され、
入力から変更されていません。
A
追加済み。フィールドが空白の入力フィールドに追加されま
した。米国およびカナダの住所のみ。
C
修正済み。カナダの住所のみ。
D
ドロップ済み。入力に与えられたフィールドが削除されまし
た。米国住所にのみ適用されます。詳細については、その他
の入力データについてを参照してください。
F
書式設定済み。郵便規格に準拠するよう、スペースや句読文
字が変更されました。米国またはカナダの住所には適用され
ません。
P
パススルー。データは検証プロセスで使用されませんでした
が、出力に保持されました。 EWS にマッチする米国の住所に
は、P の値が割り当てられます。米国およびカナダの住所の
み。
R
アパート番号が必須ですが、入力住所から欠落しています。
米国住所のみ。
S
正規化。このオプションには、標準の略語が含まれます。米
国住所には適用されません。
U
マッチしませんでした。
V
妥当性が確認されました。データは正しいことが確認され、
入力から変更されていません。
A
追加済み。フィールドが空白の入力フィールドに追加されま
した。米国およびカナダの住所のみ。
C
修正済み。米国およびカナダの住所のみ。
F
ハイフンの欠落または句読文字エラー。カナダの住所のみ。
M
複数。入力住所が郵便データベース内の複数レコードにマッ
チし、マッチする各レコードのこのフィールドの値が異なり
ます。米国またはカナダの住所には適用されません。
P
パススルー。データは検証プロセスで使用されませんでした
が、出力に保持されました。
R
都市名が必須ですが、入力住所から欠落しています。米国住
所にのみ適用されます。
S
正規化。このオプションには、標準の略語が含まれます。米
国住所には適用されません。
U
マッチしませんでした。カナダの住所には適用されません。
V
妥当性が確認されました。データは正しいことが確認され、
入力から変更されていません。
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
応答要素
説明
Country.Result
これらの結果コードは、米国またはカナダの住所には適用されませ
ん。
FirmName.Result
HouseNumber.Result
LeadingDirectional.Result
REST Web サービスガイド
M
複数。入力住所が郵便データベース内の複数レコードにマッ
チし、マッチする各レコードのこのフィールドの値が異なり
ます。
S
正規化。このオプションには、標準の略語が含まれます。
U
マッチしませんでした。
V
妥当性が確認されました。データは正しいことが確認され、
入力から変更されていません。
C
修正済み。米国住所にのみ適用されます。
P
パススルー。データは検証プロセスで使用されませんでした
が、出力に保持されました。米国およびカナダの住所のみ。
U
マッチしませんでした。米国およびカナダの住所のみ。
V
妥当性が確認されました。データは正しいことが確認され、
入力から変更されていません。米国住所にのみ適用されま
す。
A
追加済み。フィールドが空白の入力フィールドに追加されま
した。カナダの住所のみ。
C
修正済み。カナダの住所のみ。
D
ドロップ済み。入力に与えられたフィールドが削除されまし
た。米国住所にのみ適用されます。詳細については、その他
の入力データについてを参照してください。
F
書式設定済み。郵便規格に準拠するよう、スペースや句読文
字が変更されました。米国またはカナダの住所には適用され
ません。
O
範囲外。. 米国またはカナダの住所には適用されません。
P
パススルー。データは検証プロセスで使用されませんでした
が、出力に保持されました。カナダの住所のみ。
R
家番号が必須ですが、入力住所から欠落しています。カナダ
の住所のみ。
S
正規化。このオプションには、標準の略語が含まれます。米
国またはカナダの住所には適用されません。
U
マッチしませんでした。
V
妥当性が確認されました。データは正しいことが確認され、
入力から変更されていません。
A
追加済み。フィールドが空白の入力フィールドに追加されま
した。米国およびカナダの住所のみ。
283
Universal Addressing モジュール
応答要素
POBox.Result
284
説明
C
修正済み。空白のない入力が、空白のない値に修正されまし
た。米国住所にのみ適用されます。
D
ドロップ済み。入力に与えられたフィールドが削除されまし
た。米国住所にのみ適用されます。詳細については、その他
の入力データについてを参照してください。
F
書式設定済み。郵便規格に準拠するよう、スペースや句読文
字が変更されました。米国またはカナダの住所には適用され
ません。
M
複数。入力住所が郵便データベース内の複数レコードにマッ
チし、マッチする各レコードのこのフィールドの値が異なりま
す。米国住所にのみ適用されます。
P
パススルー。データは検証プロセスで使用されませんでした
が、出力に保持されました。カナダの住所のみ。
S
正規化。このオプションには、標準の略語が含まれます。
U
マッチしませんでした。
V
妥当性が確認されました。データは正しいことが確認され、
入力から変更されていません。カナダの住所には適用されま
せん。
A
追加済み。フィールドが空白の入力フィールドに追加されま
した。カナダの住所のみ。
C
修正済み。カナダの住所のみ。
D
ドロップ済み。入力に与えられたフィールドが削除されまし
た。米国住所にのみ適用されます。詳細については、その他
の入力データについてを参照してください。
F
書式設定済み。郵便規格に準拠するよう、スペースや句読文
字が変更されました。米国またはカナダの住所には適用され
ません。
M
複数マッチ。入力住所が郵便データベース内の複数レコード
にマッチし、マッチする各レコードのこのフィールドの値が異
なります。米国住所にのみ適用されます。
P
パススルー。データは検証プロセスで使用されませんでした
が、出力に保持されました。カナダの住所のみ。
R
私書箱. 番号が必須ですが、入力住所から欠落しています。米
国住所にのみ適用されます。
S
正規化。このオプションには、標準の略語が含まれます。
U
マッチしませんでした。
V
妥当性が確認されました。データは正しいことが確認され、
入力から変更されていません。
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
応答要素
PostalCode.Result
PostalCode.Type
説明
A
追加済み。フィールドが空白の入力フィールドに追加されま
した。米国およびカナダの住所のみ。
C
修正済み。米国およびカナダの住所のみ。
F
書式設定済み。郵便規格に準拠するよう、スペースや句読文
字が変更されました。米国またはカナダの住所には適用され
ません。
M
複数。入力住所が郵便データベース内の複数レコードにマッ
チし、マッチする各レコードのこのフィールドの値が異なりま
す。カナダの住所には適用されません。
P
パススルー。データは検証プロセスで使用されませんでした
が、出力に保持されました。米国住所には適用されません。
R
郵便番号が必須ですが、入力住所から欠落しています。米国
住所にのみ適用されます。
S
正規化。このオプションには、標準の略語が含まれます。米
国またはカナダの住所には適用されません。
U
マッチしませんでした。例えば、ストリート名と郵便番号が
一致しない場合、StreetName.Result と PostalCode.Result の
両方に U が割り当てられます。
V
妥当性が確認されました。データは正しいことが確認され、
入力から変更されていません。
P
™
ZIP Code には、PO Box 住所のみが含まれます。米国住
所にのみ適用されます。
U
™
ZIP Code は、特定の会社または場所に割り当てられたユ
™
ニークな ZIP Code です。米国住所にのみ適用されます。
M
™
ZIP Code は、軍施設の住所です。米国住所にのみ適用さ
れます。
NULL
RRHC.Type
StateProvince.Result
REST Web サービスガイド
™
™
ZIP Code は、標準 ZIP Code です。
これらの結果コードは米国住所にのみ適用されます。
HC
住所は、Highway Contract 住所です。
RR
住所は、地方配送路住所です。
A
追加済み。フィールドが空白の入力フィールドに追加されま
した。米国およびカナダの住所のみ。
C
修正済み。米国住所にのみ適用されます。
M
複数。入力住所が郵便データベース内の複数レコードにマッ
チし、マッチする各レコードのこのフィールドの値が異なりま
す。米国またはカナダの住所には適用されません。
P
パススルー。データは検証プロセスで使用されませんでした
が、出力に保持されました。米国およびカナダの住所のみ。
285
Universal Addressing モジュール
応答要素
Street.Result
StreetName.Result
286
説明
R
アパートラベルが必須ですが、入力住所から欠落しています。
米国住所にのみ適用されます。
S
正規化。このオプションには、標準の略語が含まれます。米
国住所には適用されません。
U
マッチしませんでした。カナダの住所には適用されません。
V
妥当性が確認されました。データは正しいことが確認され、
入力から変更されていません。
これらの結果コードは国際住所のみに適用されます。
M
複数。入力住所が郵便データベース内の複数レコードにマッ
チし、マッチする各レコードのこのフィールドの値が異なり
ます。
P
パススルー。データは検証プロセスで使用されませんでした
が、出力に保持されました。
R
ストリートが修正済みです。家番号が範囲外にあります。英
国および日本のレコードのみに適用。
S
正規化。このオプションには、標準の略語が含まれます。
U
マッチしませんでした。
V
妥当性が確認されました。データは正しいことが確認され、
入力から変更されていません。
A
追加済み。フィールドが空白の入力フィールドに追加されま
した。カナダの住所のみ。
C
修正済み。米国およびカナダの住所のみ。
D
ドロップ済み。入力に与えられたフィールドが削除されまし
た。米国住所にのみ適用されます。詳細については、その他
の入力データについてを参照してください。
F
書式設定済み。郵便規格に準拠するよう、スペースや句読文
字が変更されました。米国またはカナダの住所には適用され
ません。
M
複数。入力住所が郵便データベース内の複数レコードにマッ
チし、マッチする各レコードのこのフィールドの値が異なりま
す。米国住所にのみ適用されます。
P
パススルー。データは検証プロセスで使用されませんでした
が、出力に保持されました。米国住所には適用されません。
S
正規化。このオプションには、標準の略語が含まれます。米
国およびカナダの住所のみ。
U
マッチしませんでした。
V
妥当性が確認されました。データは正しいことが確認され、
入力から変更されていません。
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
応答要素
StreetSuffix.Result
TrailingDirectional.Result
REST Web サービスガイド
説明
A
追加済み。フィールドが空白の入力フィールドに追加されま
した。米国およびカナダの住所のみ。
C
修正済み。米国およびカナダの住所のみ。
D
ドロップ済み。入力に与えられたフィールドが削除されまし
た。米国およびカナダの住所のみ。詳細については、その他
の入力データについてを参照してください。
F
書式設定済み。郵便規格に準拠するよう、スペースや句読文
字が変更されました。米国またはカナダの住所には適用され
ません。
M
複数。入力住所が郵便データベース内の複数レコードにマッ
チし、マッチする各レコードのこのフィールドの値が異なりま
す。米国住所にのみ適用されます。
P
パススルー。データは検証プロセスで使用されませんでした
が、出力に保持されました。カナダの住所のみ。
S
正規化。このオプションには、標準の略語が含まれます。
U
マッチしませんでした。米国住所には適用されません。
V
妥当性が確認されました。データは正しいことが確認され、
入力から変更されていません。
A
追加済み。フィールドが空白の入力フィールドに追加されま
した。米国およびカナダの住所のみ。
C
修正済み。米国およびカナダの住所のみ。
D
ドロップ済み。入力に与えられたフィールドが削除されまし
た。米国およびカナダの住所のみ。詳細については、その他
の入力データについてを参照してください。
F
書式設定済み。郵便規格に準拠するよう、スペースや句読文
字が変更されました。米国またはカナダの住所には適用され
ません。
M
複数。入力住所が郵便データベース内の複数レコードにマッ
チし、マッチする各レコードのこのフィールドの値が異なりま
す。米国住所にのみ適用されます。
P
パススルー。データは検証プロセスで使用されませんでした
が、出力に保持されました。カナダの住所のみ。
S
正規化。このオプションには、標準の略語が含まれます。
U
マッチしませんでした。カナダの住所には適用されません。
V
妥当性が確認されました。データは正しいことが確認され、
入力から変更されていません。
287
Universal Name モジュール
Universal Name モジュール
OpenNameParser
OpenNameParser は、名前データフィールドにある個人名、企業名、またはその他の名称を構成要素
に分解します。これらのパースされた名前要素は、名前のマッチング、名前の正規化、複数レコード
名の統合など、他の自動化処理に使用できます。
OpenNameParser は、次の処理を行います。
• 名前が担う機能を示すために、その名前のタイプを特定します。名前エンティティタイプは、個人
名と企業名の 2 つのグループに分かれます。それぞれのグループには、さらに複数のサブグループ
があります。
• パーシングに使う構文を把握するために、名前の形式を特定します。個人名は、通常、自然な (署
名) 順序または逆の順序に従います。企業名は、通常、階層型の順序に従います。
• 名前を構成する各要素が名前全体に占める構文上の関連性を識別するために、要素を特定してラベ
ル付けします。個人名の構文は、敬称、名、ミドルネーム、姓、接尾語、アカウントを示す用語、
その他の個人名要素で構成されます。企業名の構文は、企業名や接尾語などで構成されます。
• 結合された個人名と企業名をパースし、それらを 1 つのレコードとして残すか、複数のレコードに
分割します。 Examples of conjoined names include "Mr. and Mrs. John Smith" and "Baltimore Gas
& Electric dba Constellation Energy".
• 出力をレコードまたはリストとしてパースします。
• パーシングによる訂正の信頼度を示すパーシングスコアを割り当てます。
リソース URL
JSON エンドポイント:
http://server:port/rest/OpenNameParser/results.json
XML エンドポイント:
http://server:port/rest/OpenNameParser/results.xml
JSON 応答の例
次の例では、JSON 応答を要求します。
http://myserver:8080/rest/OpenNameParser/results.json?
Data.Name=John+Williams+Smith
この要求から次のような JSON が返されます。
{"output_port": [{
"Name": "John Williams Smith",
"CultureCodeUsedToParse": "",
"FirstName": "John",
"LastName": "Smith",
"MiddleName": "Williams",
"Names": [],
"IsParsed": true,
"IsPersonal": true,
"IsConjoined": false,
"IsReverseOrder": false,
"IsFirm": false,
"NameScore": 100,
288
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
"user_fields": []
}]}
XML 応答の例
次の例では、XML 応答を要求します。
http://myserver:8080/rest/OpenNameParser/results.xml?
Data.Name=John+Williams+Smith
この要求から次のような XML が返されます。
<ns2:xml.OpenNameParserResponse
xmlns:ns2="http://www.pb.com/spectrum/services/OpenNameParser">
<ns2:output_port>
<ns2:Result>
<ns2:Name>John Williams Smith</ns2:Name>
<ns2:CultureCodeUsedToParse/>
<ns2:FirstName>John</ns2:FirstName>
<ns2:LastName>Smith</ns2:LastName>
<ns2:MiddleName>Williams</ns2:MiddleName>
<ns2:Names/>
<ns2:IsParsed>true</ns2:IsParsed>
<ns2:IsPersonal>true</ns2:IsPersonal>
<ns2:IsConjoined>false</ns2:IsConjoined>
<ns2:IsReverseOrder>false</ns2:IsReverseOrder>
<ns2:IsFirm>false</ns2:IsFirm>
<ns2:NameScore>100</ns2:NameScore>
<ns2:user_fields/>
</ns2:Result>
</ns2:output_port>
</ns2:xml.OpenNameParserResponse>
要求
入力データのパラメータ
表 117 : Open Name Parser の入力
パラメータ
説明
Data.CultureCode
入力された名前データのカルチャー。オプションは次のとおりです。
Null (empty)
グローバルカルチャー (デフォルト)。
de
ドイツ語。
es
スペイン語。
ja
日本語。
注 : Open Parser ドメインエディターを使用して独自のドメインを
追加した場合、そのドメインのカルチャーとカルチャーコード
も有効になります。
Data.Name
REST Web サービスガイド
パースしたい名前。このフィールドは必須です。
289
Universal Name モジュール
オプション
パーシングオプションのパラメータ
次の表に、名前のパーシングを制御するオプションを示します。
表 118 : Open Name Parser パーシングオプション
パラメータ
説明
Option.ParseNaturalOrderPersonalNames
敬称、名、ミドルネーム、姓、および接尾語の順
序で名前をパースするかどうかを指定します。
Option.ParseReverseOrderPersonalNames
Option.ParseConjoinedNames
Option.SplitConjoinedNames
true
正順序の個人名をパースします。
false
正順序の名前をパースしません。
姓が最初に指定されている名前をパースするかど
うかを指定します。
true
逆順序の個人名をパースします。
false
逆順序の名前をパースしません。
結合名をパースするかどうかを指定します。
true
結合名をパースします。
false
結合名をパースしません。
Bill & Sally Smith など、複数の人物を含む
結合名を複数のレコードに分割するかどうかを指
定します。
Option.ParseBusinessNames
Option.OutputAsList
Option.ShortcutThreshold
290
true
結合名を分割します。
false
結合名を分割しません。
企業名をパースするかどうかを指定します。
true
企業名をパースします。
false
企業名をパースしません。
パース済み名前要素をリスト形式で返すかどうか
を指定します。
true
パース済み要素をリスト形式で返しま
す。
false
パース済み要素をリスト形式で返しま
せん。
パフォーマンスと品質のバランスをとる方法を指
定します。パフォーマンスを上げると、品質出力
が下がります。同様に、品質を上げると、パフォー
マンスが下がります。このしきい値を満たすと、
レコードに対して他の処理は実行されません。
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
パラメータ
説明
0 ～ 100 の値を指定します。デフォルトは 100
です。
カルチャーオプションのパラメータ
次の表に、名前カルチャーを制御するオプションを示します。
表 119 : Open Name Parser カルチャーオプション
パラメータ
説明
Option.DefaultCulture
パーシンググラマーに含めるカルチャーを指定し
ます。デフォルトでは、グローバルカルチャー
が選択されます。
カンマ区切りリストに 2 文字のカルチャーコード
を優先する順に指定することで、カルチャーを指
定します。例えば、まずはスペインのカル
チャー、次に日本のカルチャーを使用して名前の
パースを試みるには、次のように指定します。
es,ja,,
詳細オプションのパラメータ
次の表に、名前パーシング用の詳細オプションを示します。
表 120 : Open Name Parser の詳細オプション
オプション
説明
Option.NaturalOrderPersonalNamesDomain
正順序個人名のパース時に使用するドメインを指
定します。有効な値は、Enterprise Designer の
Open Parser ドメインエディタツールで定義さ
れたドメイン名です。
Option.NaturalOrderPersonalNamesPriority
使用する他のドメインに対する正順序個人名ドメ
インの優先度を示す 1 ～ 5 の数値を指定します。
これにより、実行するパーサーの順序が決定され
ます。
ショートカットしきい値のオプションに設定され
た数字よりもスコアの高い最初のドメインに対し
て結果が返されます。そのしきい値に達している
ドメインがない場合は、スコアの最も高いドメイ
ンに対する結果が返されます。複数のドメインが
同時にしきい値に達している場合は、最初に実行
された (ここで設定された順序によって決まる) ド
メインが優先され、その結果が返されます。
REST Web サービスガイド
291
Universal Name モジュール
オプション
説明
Option.ReverseOrderPersonalNamesDomain
逆順序個人名のパース時に使用するドメインを指
定します。有効な値は、Enterprise Designer の
Open Parser ドメインエディタツールで定義さ
れたドメイン名です。
Option.ReverseOrderPersonalNamesPriority
使用する他のドメインに対する逆順序個人名ドメ
インの優先度を示す 1 ～ 5 の数値を指定します。
これにより、実行するパーサーの順序が決定され
ます。
ショートカットしきい値のオプションに設定され
た数字よりもスコアの高い最初のドメインに対し
て結果が返されます。そのしきい値に達している
ドメインがない場合は、スコアの最も高いドメイ
ンに対する結果が返されます。複数のドメインが
同時にしきい値に達している場合は、最初に実行
された (ここで設定された順序によって決まる) ド
メインが優先され、その結果が返されます。
Option.NaturalOrderConjoinedPersonalNamesDomain 正順序結合個人名のパース時に使用するドメイン
を指定します。有効な値は、Enterprise Designer
の Open Parser ドメインエディタツールで定義
されたドメイン名です。
Option.NaturalOrderConjoinedPersonalNamesPriority 使用する他のドメインに対する正順序結合個人名
ドメインの優先度を示す 1 ～ 5 の数値を指定しま
す。これにより、実行するパーサーの順序が決定
されます。
ショートカットしきい値のオプションに設定され
た数字よりもスコアの高い最初のドメインに対し
て結果が返されます。そのしきい値に達している
ドメインがない場合は、スコアの最も高いドメイ
ンに対する結果が返されます。複数のドメインが
同時にしきい値に達している場合は、最初に実行
された (ここで設定された順序によって決まる) ド
メインが優先され、その結果が返されます。
Option.ReverseOrderConjoinedPersonalNamesDomain 逆順序結合個人名のパース時に使用するドメイン
を指定します。有効な値は、Enterprise Designer
の Open Parser ドメインエディタツールで定義
されたドメイン名です。
Option.ReverseOrderConjoinedPersonalNamesPriority 使用する他のドメインに対する逆順序結合個人名
ドメインの優先度を示す 1 ～ 5 の数値を指定しま
す。これにより、実行するパーサーの順序が決定
されます。
ショートカットしきい値のオプションに設定され
た数字よりもスコアの高い最初のドメインに対し
て結果が返されます。そのしきい値に達している
ドメインがない場合は、スコアの最も高いドメイ
292
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
オプション
説明
ンに対する結果が返されます。複数のドメインが
同時にしきい値に達している場合は、最初に実行
された (ここで設定された順序によって決まる) ド
メインが優先され、その結果が返されます。
Option.BusinessNamesDomain
企業名のパース時に使用するドメインを指定しま
す。有効な値は、Enterprise Designer の Open
Parser ドメインエディタツールで定義されたド
メイン名です。
Option.BusinessNamesPriority
使用する他のドメインに対する企業名ドメインの
優先度を示す 1 ～ 5 の数値を指定します。これ
により、実行するパーサーの順序が決定されま
す。
ショートカットしきい値のオプションに設定され
た数字よりもスコアの高い最初のドメインに対し
て結果が返されます。そのしきい値に達している
ドメインがない場合は、スコアの最も高いドメイ
ンに対する結果が返されます。複数のドメインが
同時にしきい値に達している場合は、最初に実行
された (ここで設定された順序によって決まる) ド
メインが優先され、その結果が返されます。
応答
表 121 : Open Name Parser の出力
応答要素
書式
説明
AccountDescription
文字列
名前の一部であるアカウント説明。例えば、"Mary Jones
Account # 12345" で、アカウント説明は "Account#12345"。
Names
文字列
パース済み要素のリストを含む階層フィールド。このフィー
ルドは、[パーシングオプション] の [結果をリストに出力]
ボックスをチェックしている場合に返されます。
FirmConjunction
文字列
"d/b/a" (doing business as)、"o/a" (operating as)、"t/a"
(trading as) などの略語を含む企業の名前を示します。
FirmName
文字列
会社名。例えば、"Pitney Bowes"。
FirmSuffix
文字列
会社名の接尾語。例えば、"Co."、"Inc."
IsFirm
文字列
名前が、個人名ではなく、企業名であることを示します。
文字列
名前に、"and"、"or"、"&" などの接続詞が含まれることを示
します。
会社名関係のフィールド
個人名に関係するフィールド
Conjunction
REST Web サービスガイド
293
Universal Name モジュール
応答要素
書式
説明
CultureCode
文字列
入力データに含まれるカルチャーコード。
CultureCodeUsedToParse
文字列
データのパースに使用されたカルチャー固有のグラマーを
特定します。
Null (empty)
グローバルカルチャー (デフォルト)。
de
ドイツ語。
es
スペイン語。
ja
日本語。
注 : Open Parser ドメインエディターを使用して独自のド
メインを追加した場合、そのドメインのカルチャーと
カルチャーコードもこのフィールドに表示されます。
FirstName
文字列
個人のファーストネーム。
GeneralSuffix
文字列
個人名の一般/職業接尾語。例えば、 MD PhD 。
IsParsed
文字列
出力レコードがパースされたかどうかを示します。値は
True または False です。
IsPersonal
文字列
名前が企業名ではなく、個人名であるかどうかを示します。
値は True または False です。
IsReverseOrder
文字列
入力名が逆順序であるかどうかを示します。値は True また
は False です。
LastName
文字列
個人名のラストネーム。父方の姓が含まれます。
LeadingData
文字列
名前の前に付けられる、名前以外の情報。
MaturitySuffix
文字列
個人の世代/家族接尾語。例えば、Jr. または Sr.。
MiddleName
文字列
個人のミドルネーム。
Name.
文字列
入力に指定された個人名または企業名。
NameScore
文字列
各名前の既知および不明トークンの平均スコアを示します。
NameScore の値は、パーシンググラマーでの定義に従っ
て、0 ～ 100 の間になります。マッチが返されない場合は、
0 が返されます。
SecondaryLastName
文字列
スペイン語のパーシンググラマーでは、その人の母の姓。
TitleOfRespect
文字列
"Mr."、"Mrs."、"Dr." など、名前の前に付けられる情報。
TrailingData
文字列
名前の後に付けられる、名前以外の情報。
Conjunction2
文字列
結合されている 2 番目の名前に、"and"、"or"、"&" などの接
続詞が含まれることを示します。
Conjunction3
文字列
結合されている 3 番目の名前に、"and"、"or"、"&" などの接
続詞が含まれることを示します。
FirmName2
文字列
結合されている 2 番目の企業名。例えば、Baltimore Gas &
Electric dba Constellation Energy。
結合名関係のフィールド
294
Spectrum Technology Platform 9.0 SP3
第 2 章 : Web サービス
応答要素
書式
説明
FirmSuffix2
文字列
結合されている 2 番目の企業の接尾語。
FirstName2
文字列
結合されている 2 番目の名前の名。
FirstName3
文字列
結合されている 3 番目の名前の名。
GeneralSuffix2
文字列
結合されている 2 番目の名前の一般/職業接尾語。例えば、
MD PhD 。
GeneralSuffix3
文字列
結合されている 3 番目の名前の一般/職業接尾語。例えば、
MD PhD 。
IsConjoined
文字列
入力名が結合名であることを示します。結合名は、例え
ば、"John and Jane Smith"。
LastName2
文字列
結合されている 2 番目の名前の姓。
LastName3
文字列
結合されている 3 番目の名前の姓。
MaturitySuffix2
文字列
結合されている 2 番目の名前の世代/家族接尾語。例えば、
Jr. または Sr.。
MaturitySuffix3
文字列
結合されている 3 番目の名前の世代/家族接尾語。例えば、
Jr. または Sr.。
MiddleName2
文字列
結合されている 2 番目の名前のミドルネーム。
MiddleName3
文字列
結合されている 3 番目の名前のミドルネーム。
TitleOfRespect2
文字列
"Mr."、"Mrs."、"Dr." など、結合されている 2 番目の名前の
前に付けられる情報。
TitleOfRespect3
文字列
"Mr."、"Mrs."、"Dr." など、結合されている 3 番目の名前の
前に付けられる情報。
REST Web サービスガイド
295
Appendix
このセクションの構成
•
•
•
•
The ACR Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .299
Buffering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .303
Country Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .305
ValidateAddress Confidence アルゴリズム . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .327
The ACR Code
このセクションの構成
• ACR コード . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .300
A
ACR コード
ACR (住所訂正結果) コードは、各レコードでどのデータが変更されたかを示します。 ACR は、以下
のような形式です。
L5-P0S0A5T1R0Z0C4-098
ACR コードは、以下の 3 つの部分で構成されています。
• バリデーションレベル
• コンポーネントステータス
• 検証マッチスコア
バリデーションレベル
住所訂正結果の最初の 2 文字は、バリデーションのタイプとレベルを表します。
最初の文字 (常に英字) はバリデーションのタイプを示します。
• U — 住所の正規化ができません。
• C — 住所はコンポーネント形式です。
• L — 住所は書式が設定され、住所行に変換されました。
• R — 住所は元に戻されました。許容レベルに達していません。
2 番目の文字 (常に数字) はバリデーションのレベルを示します。数字が大きいほど、バリデーション
のレベルが高くなります。到達できるレベルは以下のとおりです。
• 0 — コンポーネントはいずれも検証されませんでした。
• 1 — 国名のみが検証されました。
• 2 — 都市名と国名が検証されました。
• 3 — 都市名、郵便番号、および国名が検証されました。
• 4 — ストリート名、都市名、郵便番号、および国名が検証されました。
• 5 — 敷地番号、建物名、従属する建物名、私書箱、企業名、ストリート名、都市名、郵便番号、お
よび国名が検証されました。
コンポーネントステータス
ACR コードの 2 番目の部分は、住所の主要コンポーネントのステータスを表します。住所のコンポー
ネントは、以下のように識別されます。
• 3、4 文字目: P — 敷地/家番号
• 5、6 文字目: S — ストリート
• 7、8 文字目: A — 従属する都市 (都市エリア)
• 9、10 文字目: T — 都市
• 11、12 文字目: R — 地域/州
®
• 13、14 文字目: Z — 郵便番号/ZIP Code
• 15、16 文字目: C — 国
コンポーネントの直後には数字が 1 文字配置され、以下のいずれかの値を示します。
• 0 — 見つかりません/空。
• 1 — 入力データ内での位置に基づいて推測しました。
• 2 — Address Now モジュールデータベースに基づいて認識されました。
• 3 — Address Now モジュールデータベースに基づいて認識され、正規の形式に変換されました。
300
Spectrum Technology Platform 9.0 SP3
付録 A : The ACR Code
• 4 — Address Now モジュールデータベースを使って検証されました。
• 5 — Address Now モジュールデータベースを使って更新/訂正されました。
• 6 — Address Now モジュールデータベースを使って追加されました。
• 7 — 正常な空。
• 8 — Address Now モジュールデータベースを使って部分的に認識されました。
• 9 — 訂正して Address Now モジュールデータベースに一致させる必要があります。
検証マッチスコア
検証マッチスコアは、ACR コードの最後の 3 文字 (17 ～ 19 文字目) に設定されます。これは、正規
化データ (コンポーネント形式のデータ) を、Address Now モジュールデータベースから返されたマッ
チ候補と比較した結果です。
このスコアを計算するために、Address Now モジュールデータベースから返されたすべてのフィール
ドが確認され、それらが個別に既存のコンポーネントデータと比較されます。その後、全体のマッチ
スコアを計算するために、これらの個別の値から平均スコアが求められます。この計算には、住所バ
リデーションのオプションを設定するダイアログボックスで指定できるマッチスコア重み付けが加味
されます。例を次に示します。
入力データ:
住所行 1: 11 High Street
都市: Anytown
国: UK
正規化データ:
敷地: 11
ストリート: High Street
都市: Anytown
このレコードを検証すると、Address Now モジュールデータベースからは以下のデータが返されま
す。
敷地: 11
ストリート: High Street
都市: Anytown
郵便番号: ZZ9 9ZZ
Address Now モジュールデータベースを正規化データと比較すると、以下の結果が得られます。
• 敷地番号: 100% マッチ
• ストリート: 100% match
• 都市: 100% match
• 郵便番号: 使用なし (入力時に空白)
これらの割合を結合すると、マッチスコアは 100% となります。
別の例を以下に示します。
入力データ:
住所行 1: bergerstrasse 12
住所行 2: munich
住所行 3: 80124
国: Germany
正規化データ:
REST Web サービスガイド
301
敷地: 12
ストリート: Bergerstr.
都市: München
郵便番号: 80124
Address Now モジュールデータベースからの出力:
敷地: 12
ストリート: Burgerstr.
都市: München
郵便番号: 80142
Address Now モジュールデータベースの出力を正規化データと比較すると、以下の結果が得られま
す。
• 敷地番号:100% マッチ
• ストリート: 90% マッチ (実際の数値は、2 つの値をテキストとして照合して決定されます)
• 都市: 100% match
• 郵便番号: 80% マッチ (番号の位置が入れ替わっているため)
マッチスコアの重み付けをすべて 1 に設定した場合、全体のマッチスコアは 92% になります。郵便
コードのマッチスコア重み付けを増やすと、全体のマッチスコアは減ります。これは、郵便番号コン
ポーネントのスコア (80%) が計算の際に重視されるからです。都市名のマッチスコア重み付けを増
やすと、全体のマッチスコアは増えます。これは、都市名コンポーネントのスコア (100%) がより重
視されるからです。
例:
L5-P4S4A5T5R4Z4C4-098
• L は、住所行を作成するために書式が設定されたことを意味します。
• バリデーションレベルは 5 です。Address Now モジュールデータベースとのマッチングが最高レ
ベルで実行されたことを意味します。
• 従属する都市 (A) と都市 (T) を除き、すべてのコンポーネントが 4 に設定されています。これは、
Address Now モジュールデータベースを使って検証されたことを意味します。
• 従属する都市と都市のコードはどちらも 5 に設定されています。これらのコンポーネントが Address
Now モジュールデータベースに従って訂正されたことを意味します。
住所全体の Address Now モジュールデータベースに対するマッチングは 98% です。
注 : また、検証マッチスコアの代わりに "SDS" という値が返される場合があります。 SDS が返され
るのは住所が正規化されなかったことを意味し、その場合、住所が元に戻された可能性がありま
す。
302
Spectrum Technology Platform 9.0 SP3
Buffering
このセクションの構成
• バッファリング . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .304
B
バッファリング
ポリゴン、ライン、ポイントに近いエリアを指定するのにバッファリングを使用します。
バッファリングされたポリゴン
(zone)
バッファリングされたライン
(corridor)
バッファリングされたポイント
(circle)
例えば、あなたが保険会社に勤務している場合、潜在的な顧客の家が洪水発生地帯の 500 フィート以
内にあるかどうかを知ることができれば、実際に洪水発生地帯内になかったとしても、洪水保険を勧
めることができます。下記の図は、バッファリングされたポリゴンを使用してこのシナリオを表して
います。点線は、洪水発生地帯の境界線を示しており、色の付いているエリアは境界線から 500 フィー
トの範囲にあるエリアを示しています。
バッファエリアは、境界線の両サイド (内側と外側) に及んでいます。バッファリングを使用する場
合、出力フィールド BufferRelation はそのポイントがバッファリングに含まれているかどうか、また、
ポリゴンの内側と外側のどちらにあるかを示します。以下の図は、これを表したものです。
ポイントはポリゴンの中にあり、ポイントは、ポリゴンの中にあ
バッファエリア内にはありませり、バッファエリア内にありま
ん。
す。
ポイントは、ポリゴンの外にあ
りますが、バッファエリア内に
あります。
出力フィールド BufferRelation は出力フィールド BufferRelation は出力フィールド BufferRelation は
"P" となります。
"I" となります。
"B" となります。
レコードごとのポリゴンバッファのサイズは BufferWidth 入力フィールドで指定し、ジョブ用のデフォ
ルトのポリゴンバッファ幅はオプションで設定します。
304
Spectrum Technology Platform 9.0 SP3
Country Codes
このセクションの構成
• 各国の ISO コードとモジュールサポート . . . . . . . . . . . . .306
C
各国の ISO コードとモジュールサポート
次の表に、各国の ISO コードと、各国の住所作成、ジオコーディング、およびルーティングをサポー
トするモジュールを示します。
Enterprise Geocoding モジュールにアフリカ (30 か国)、中東 (8 か国)、ラテンアメリカ (20 か国) の
データベースが含まれていることに注意してください。これらのデータベースは、国別のジオコー
ディングデータベースがない、各地域の比較的小さな国をカバーします。 [サポートされるモジュー
ル] 列は、これらのアフリカ、中東、ラテンアメリカデータベースに含まれる国を示しています。
また、Geocode Address World データベースは、すべての国について地図上の限定的な郵便ジオコー
ディング (ストリートレベルではない) を提供します。
ISO 国名
ISO 3116-1
Alpha-2
ISO 3116-1
Alpha-3
サポートされるモジュール
Afghanistan
AF
AFG
Address Now モジュール
Universal Addressing モジュール
Aland Islands
AX
ALA
Address Now モジュール
Universal Addressing モジュール
Albania
AL
ALB
Address Now モジュール
Universal Addressing モジュール
Algeria
DZ
DZA
Address Now モジュール
Universal Addressing モジュール
American Samoa
AS
ASM
Address Now モジュール
Universal Addressing モジュール
Andorra
AD
AND
Address Now モジュール
1
Enterprise Geocoding モジュール
Universal Addressing モジュール
GeoComplete モジュール
1
306
Angola
AO
AGO
Address Now モジュール
Enterprise Geocoding モジュール (アフ
リカ)
Universal Addressing モジュール
Anguilla
AI
AIA
Address Now モジュール
Universal Addressing モジュール
Antarctica
AQ
ATA
Address Now モジュール
Universal Addressing モジュール
Antigua And Barbuda
AG
ATG
Address Now モジュール
Universal Addressing モジュール
アンドラは、スペインのジオコーダでサポートされています。
Spectrum Technology Platform 9.0 SP3
付録 C : Country Codes
ISO 国名
ISO 3116-1
Alpha-2
ISO 3116-1
Alpha-3
サポートされるモジュール
Argentina
AR
ARG
Address Now モジュール
Enterprise Geocoding モジュール
Universal Addressing モジュール
Armenia
AM
ARM
Address Now モジュール
Universal Addressing モジュール
Aruba
AW
ABW
Address Now モジュール
Enterprise Geocoding モジュール (ラテ
ンアメリカ)
Universal Addressing モジュール
Australia
AU
AUS
Address Now モジュール
Enterprise Geocoding モジュール
Enterprise Routing モジュール
Universal Addressing モジュール
Austria
AT
AUT
Address Now モジュール
Enterprise Geocoding モジュール
Enterprise Routing モジュール
Universal Addressing モジュール
GeoComplete モジュール
Azerbaijan
AZ
AZE
Address Now モジュール
Universal Addressing モジュール
Bahamas
BS
BHS
Address Now モジュール
Enterprise Geocoding モジュール
Universal Addressing モジュール
Bahrain
BH
BHR
Address Now モジュール
Enterprise Geocoding モジュール (中東)
Enterprise Routing モジュール
Universal Addressing モジュール
Bangladesh
BD
BGD
Address Now モジュール
Universal Addressing モジュール
Barbados
BB
BRB
Address Now モジュール
Enterprise Geocoding モジュール (ラテ
ンアメリカ)
Universal Addressing モジュール
Belarus
BY
BLR
Address Now モジュール
Universal Addressing モジュール
Belgium
BE
BEL
Address Now モジュール
Enterprise Geocoding モジュール
Enterprise Routing モジュール
REST Web サービスガイド
307
ISO 国名
ISO 3116-1
Alpha-2
ISO 3116-1
Alpha-3
サポートされるモジュール
Universal Addressing モジュール
GeoComplete モジュール
308
Belize
BZ
BLZ
Address Now モジュール
Enterprise Geocoding モジュール (ラテ
ンアメリカ)
Universal Addressing モジュール
Benin
BJ
BEN
Address Now モジュール
Enterprise Geocoding モジュール (アフ
リカ)
Universal Addressing モジュール
Bermuda
BM
BMU
Address Now モジュール
Universal Addressing モジュール
Bhutan
BT
BTN
Address Now モジュール
Universal Addressing モジュール
Bolivia, Plurinational State Of BO
BOL
Address Now モジュール
Enterprise Geocoding モジュール (ラテ
ンアメリカ)
Universal Addressing モジュール
Bonaire, Saint Eustatius And BQ
Saba
BES
Address Now モジュール
Universal Addressing モジュール
Bosnia And Herzegovina
BA
BIH
Address Now モジュール
Universal Addressing モジュール
Botswana
BW
BWA
Address Now モジュール
Enterprise Geocoding モジュール (アフ
リカ)
Universal Addressing モジュール
Bouvet Island
BV
BVT
Address Now モジュール
Universal Addressing モジュール
Brazil
BR
BRA
Address Now モジュール
Enterprise Geocoding モジュール
Enterprise Routing モジュール
Universal Addressing モジュール
GeoComplete モジュール
British Indian Ocean Territory IO
IOT
Address Now モジュール
Universal Addressing モジュール
Brunei Darussalam
BRN
Address Now モジュール
Universal Addressing モジュール
BN
Spectrum Technology Platform 9.0 SP3
付録 C : Country Codes
ISO 国名
ISO 3116-1
Alpha-2
ISO 3116-1
Alpha-3
サポートされるモジュール
Bulgaria
BG
BGR
Address Now モジュール
Universal Addressing モジュール
Burkina Faso
BF
BFA
Address Now モジュール
Enterprise Geocoding モジュール (アフ
リカ)
Universal Addressing モジュール
Burundi
BI
BDI
Address Now モジュール
Enterprise Geocoding モジュール (アフ
リカ)
Universal Addressing モジュール
Cambodia
KH
KHM
Address Now モジュール
Universal Addressing モジュール
Cameroon
CM
CMR
Address Now モジュール
Enterprise Geocoding モジュール (アフ
リカ)
Universal Addressing モジュール
Canada
CA
CAN
Address Now モジュール
Enterprise Geocoding モジュール
Enterprise Routing モジュール
Universal Addressing モジュール
GeoComplete モジュール
Cape Verde
CV
CPV
Address Now モジュール
Universal Addressing モジュール
Cayman Islands
KY
CYM
Address Now モジュール
Universal Addressing モジュール
Central African Republic
CF
CAF
Address Now モジュール
Universal Addressing モジュール
Chad
TD
TCD
Address Now モジュール
Universal Addressing モジュール
Chile
CL
CHL
Address Now モジュール
Enterprise Geocoding モジュール
Universal Addressing モジュール
GeoComplete モジュール
China
CN
CHN
Address Now モジュール
Enterprise Geocoding モジュール
Universal Addressing モジュール
Christmas Island
CX
CXR
Address Now モジュール
Universal Addressing モジュール
REST Web サービスガイド
309
310
ISO 国名
ISO 3116-1
Alpha-2
ISO 3116-1
Alpha-3
サポートされるモジュール
Cocos (Keeling) Islands
CC
CCK
Address Now モジュール
Universal Addressing モジュール
Colombia
CO
COL
Address Now モジュール
Universal Addressing モジュール
Comoros
KM
COM
Address Now モジュール
Universal Addressing モジュール
Congo
CG
COG
Address Now モジュール
Enterprise Geocoding モジュール (アフ
リカ)
Universal Addressing モジュール
Congo, The Democratic
Republic Of The
CD
COD
Address Now モジュール
Enterprise Geocoding モジュール (アフ
リカ)
Universal Addressing モジュール
Cook Islands
CK
COK
Address Now モジュール
Universal Addressing モジュール
Costa Rica
CR
CRI
Address Now モジュール
Enterprise Geocoding モジュール (ラテ
ンアメリカ)
Universal Addressing モジュール
Côte d'Ivoire
CI
CIV
Address Now モジュール
Universal Addressing モジュール
Croatia
HR
HRV
Address Now モジュール
Enterprise Geocoding モジュール
Enterprise Routing モジュール
Universal Addressing モジュール
Cuba
CU
CUB
Address Now モジュール
Enterprise Geocoding モジュール (ラテ
ンアメリカ)
Universal Addressing モジュール
Curacao
CW
CUW
Address Now モジュール
Universal Addressing モジュール
Cyprus
CY
CYP
Address Now モジュール
Universal Addressing モジュール
Czech Republic
CZ
CZE
Address Now モジュール
Enterprise Geocoding モジュール
Enterprise Routing モジュール
Spectrum Technology Platform 9.0 SP3
付録 C : Country Codes
ISO 国名
ISO 3116-1
Alpha-2
ISO 3116-1
Alpha-3
サポートされるモジュール
Universal Addressing モジュール
GeoComplete モジュール
Denmark
DK
DNK
Address Now モジュール
Enterprise Geocoding モジュール
Enterprise Routing モジュール
Universal Addressing モジュール
GeoComplete モジュール
Djibouti
DJ
DJI
Address Now モジュール
Universal Addressing モジュール
Dominica
DM
DMA
Address Now モジュール
Universal Addressing モジュール
Dominican Republic
DO
DOM
Address Now モジュール
Enterprise Geocoding モジュール (ラテ
ンアメリカ)
Universal Addressing モジュール
Ecuador
EC
ECU
Address Now モジュール
Enterprise Geocoding モジュール (ラテ
ンアメリカ)
Universal Addressing モジュール
Egypt
EG
EGY
Address Now モジュール
Enterprise Geocoding モジュール (中東)
Enterprise Routing モジュール
Universal Addressing モジュール
El Salvador
SV
SLV
Address Now モジュール
Enterprise Geocoding モジュール (ラテ
ンアメリカ)
Universal Addressing モジュール
Equatorial Guinea
GQ
GNQ
Address Now モジュール
Universal Addressing モジュール
Eritrea
ER
ERI
Address Now モジュール
Universal Addressing モジュール
Estonia
EE
EST
Address Now モジュール
Enterprise Geocoding モジュール
Enterprise Routing モジュール
Universal Addressing モジュール
Ethiopia
ET
ETH
Address Now モジュール
Universal Addressing モジュール
REST Web サービスガイド
311
ISO 国名
ISO 3116-1
Alpha-2
ISO 3116-1
Alpha-3
サポートされるモジュール
Falkland Islands (Malvinas)
FK
FLK
Address Now モジュール
Universal Addressing モジュール
Faroe Islands
FO
FRO
Address Now モジュール
Universal Addressing モジュール
Fiji
FJ
FJI
Address Now モジュール
Universal Addressing モジュール
Finland
FI
FIN
Address Now モジュール
Enterprise Geocoding モジュール
Enterprise Routing モジュール
Universal Addressing モジュール
GeoComplete モジュール
France
FR
FRA
Address Now モジュール
Enterprise Geocoding モジュール
Enterprise Routing モジュール
Universal Addressing モジュール
GeoComplete モジュール
French Guiana
GF
GUF
Address Now モジュール
2
Enterprise Geocoding モジュール
Universal Addressing モジュール
2
312
French Polynesia
PF
PYF
Address Now モジュール
Universal Addressing モジュール
French Southern Territories
TF
ATF
Address Now モジュール
Universal Addressing モジュール
Gabon
GA
GAB
Address Now モジュール
Enterprise Geocoding モジュール (アフ
リカ)
Universal Addressing モジュール
Gambia
GM
GMB
Address Now モジュール
Universal Addressing モジュール
Georgia
GE
GEO
Address Now モジュール
Universal Addressing モジュール
Germany
DE
DEU
Address Now モジュール
Enterprise Geocoding モジュール
Enterprise Routing モジュール
Universal Addressing モジュール
GeoComplete モジュール
フランス領ギアナは、フランスのジオコーダでサポートされています。
Spectrum Technology Platform 9.0 SP3
付録 C : Country Codes
ISO 国名
ISO 3116-1
Alpha-2
ISO 3116-1
Alpha-3
サポートされるモジュール
Ghana
GH
GHA
Address Now モジュール
Enterprise Geocoding モジュール (アフ
リカ)
Universal Addressing モジュール
Gibraltar
GI
GIB
Address Now モジュール
Enterprise Geocoding モジュール
3
Universal Addressing モジュール
Greece
GR
GRC
Address Now モジュール
Enterprise Geocoding モジュール
Universal Addressing モジュール
Greenland
GL
GRL
Address Now モジュール
Universal Addressing モジュール
Grenada
GD
GRD
Address Now モジュール
Universal Addressing モジュール
Guadeloupe
GP
GLP
Address Now モジュール
4
Enterprise Geocoding モジュール
Universal Addressing モジュール
3
4
Guam
GU
GUM
Address Now モジュール
Universal Addressing モジュール
Guatemala
GT
GTM
Address Now モジュール
Enterprise Geocoding モジュール (ラテ
ンアメリカ)
Universal Addressing モジュール
Guernsey
GG
GGY
Address Now モジュール
Universal Addressing モジュール
Guinea
GN
GIN
Address Now モジュール
Universal Addressing モジュール
Guinea-Bissau
GW
GNB
Address Now モジュール
Universal Addressing モジュール
Guyana
GY
GUY
Address Now モジュール
Enterprise Geocoding モジュール (ラテ
ンアメリカ)
Universal Addressing モジュール
Haiti
HT
HTI
Address Now モジュール
Universal Addressing モジュール
ジブラルタルは、スペインのジオコーダでサポートされています。
グアドループは、フランスのジオコーダでサポートされています。
REST Web サービスガイド
313
ISO 国名
ISO 3116-1
Alpha-2
ISO 3116-1
Alpha-3
サポートされるモジュール
Heard Island and McDonald
Islands
HM
HMD
Address Now モジュール
Universal Addressing モジュール
VAT
Address Now モジュール
5
Enterprise Geocoding モジュール
Holy See (Vatican City State) VA
Universal Addressing モジュール
5
314
Honduras
HN
HND
Address Now モジュール
Enterprise Geocoding モジュール (ラテ
ンアメリカ)
Universal Addressing モジュール
Hong Kong
HK
HKG
Address Now モジュール
Enterprise Geocoding モジュール
Universal Addressing モジュール
Hungary
HU
HUN
Address Now モジュール
Enterprise Geocoding モジュール
Enterprise Routing モジュール
Universal Addressing モジュール
GeoComplete モジュール
Iceland
IS
ISL
Address Now モジュール
Universal Addressing モジュール
India
IN
IND
Address Now モジュール
Enterprise Geocoding モジュール
Universal Addressing モジュール
Indonesia
ID
IDN
Address Now モジュール
Enterprise Geocoding モジュール
Universal Addressing モジュール
Iran, Islamic Republic Of
IR
IRN
Address Now モジュール
Universal Addressing モジュール
Iraq
IQ
IRQ
Address Now モジュール
Universal Addressing モジュール
Ireland
IE
IRL
Address Now モジュール
Enterprise Geocoding モジュール
Enterprise Routing モジュール
Universal Addressing モジュール
GeoComplete モジュール
Isle Of Man
IM
IMN
Address Now モジュール
Universal Addressing モジュール
バチカンは、イタリアのジオコーダでサポートされています。
Spectrum Technology Platform 9.0 SP3
付録 C : Country Codes
ISO 国名
ISO 3116-1
Alpha-2
ISO 3116-1
Alpha-3
サポートされるモジュール
Israel
IL
ISR
Address Now モジュール
Universal Addressing モジュール
Italy
IT
ITA
Address Now モジュール
Enterprise Geocoding モジュール
Enterprise Routing モジュール
Universal Addressing モジュール
GeoComplete モジュール
Jamaica
JM
JAM
Address Now モジュール
Enterprise Geocoding モジュール (ラテ
ンアメリカ)
Universal Addressing モジュール
Japan
JP
JPN
Address Now モジュール
Enterprise Geocoding モジュール
Enterprise Routing モジュール
Universal Addressing モジュール
GeoComplete モジュール
Jersey
JE
JEY
Address Now モジュール
Universal Addressing モジュール
Jordan
JO
JOR
Address Now モジュール
Universal Addressing モジュール
Kazakhstan
KZ
KAZ
Address Now モジュール
Universal Addressing モジュール
Kenya
KE
KEN
Address Now モジュール
Enterprise Geocoding モジュール (アフ
リカ)
Universal Addressing モジュール
Kiribati
KI
KIR
Address Now モジュール
Universal Addressing モジュール
Korea, Democratic People's
Republic Of
KP
PRK
Address Now モジュール
Universal Addressing モジュール
Korea, Republic Of
KR
KOR
Address Now モジュール
Universal Addressing モジュール
Kosovo
KS
KOS
Address Now モジュール
Universal Addressing モジュール
GeoComplete モジュール
Kuwait
KW
KWT
Address Now モジュール
Enterprise Geocoding モジュール (中東)
REST Web サービスガイド
315
ISO 国名
ISO 3116-1
Alpha-2
ISO 3116-1
Alpha-3
サポートされるモジュール
Enterprise Routing モジュール
Universal Addressing モジュール
Kyrgyzstan
KG
KGZ
Address Now モジュール
Universal Addressing モジュール
Lao People's Democratic
Republic
LA
LAO
Address Now モジュール
Universal Addressing モジュール
Latvia
LV
LVA
Address Now モジュール
Enterprise Geocoding モジュール
Enterprise Routing モジュール
Universal Addressing モジュール
Lebanon
LB
LBN
Address Now モジュール
Enterprise Geocoding モジュール (中東)
Universal Addressing モジュール
Lesotho
LS
LSO
Address Now モジュール
Enterprise Geocoding モジュール (アフ
リカ)
Universal Addressing モジュール
Liberia
LR
LBR
Address Now モジュール
Universal Addressing モジュール
Libyan Arab Jamahiriya
LY
LBY
Address Now モジュール
Universal Addressing モジュール
Liechtenstein
LI
LIE
Address Now モジュール
6
Enterprise Geocoding モジュール
Enterprise Routing モジュール
Universal Addressing モジュール
GeoComplete モジュール
Lithuania
LT
LTU
Address Now モジュール
Enterprise Geocoding モジュール
Enterprise Routing モジュール
Universal Addressing モジュール
Luxembourg
LU
LUX
Address Now モジュール
7
Enterprise Geocoding モジュール
Enterprise Routing モジュール
Universal Addressing モジュール
GeoComplete モジュール
6
7
316
リヒテンシュタインは、スイスのジオコーダでサポートされています。
ルクセンブルクは、ベルギーのジオコーダでサポートされています。
Spectrum Technology Platform 9.0 SP3
付録 C : Country Codes
8
ISO 国名
ISO 3116-1
Alpha-2
ISO 3116-1
Alpha-3
サポートされるモジュール
Macao
MO
MAC
Address Now モジュール
Enterprise Geocoding モジュール
Universal Addressing モジュール
Macedonia, Former Yugoslav MK
Republic Of
MKD
Address Now モジュール
Universal Addressing モジュール
Madagascar
MG
MDG
Address Now モジュール
Universal Addressing モジュール
Malawi
MW
MWI
Address Now モジュール
Enterprise Geocoding モジュール (アフ
リカ)
Universal Addressing モジュール
Malaysia
MY
MYS
Address Now モジュール
Enterprise Geocoding モジュール
Enterprise Routing モジュール
Universal Addressing モジュール
Maldives
MV
MDV
Address Now モジュール
Universal Addressing モジュール
Mali
ML
MLI
Address Now モジュール
Enterprise Geocoding モジュール (アフ
リカ)
Universal Addressing モジュール
Malta
ML
MLT
Enterprise Routing モジュール
Address Now モジュール
Universal Addressing モジュール
Marshall Islands
MH
MHL
Address Now モジュール
Universal Addressing モジュール
Martinique
MQ
MTQ
Address Now モジュール
Enterprise Geocoding モジュールグア
ドループは、フランスのジオコーダで
サポートされています。 Universal
Addressing モジュール
Mauritania
MR
MRT
Address Now モジュール
Enterprise Geocoding モジュール (アフ
リカ)
Universal Addressing モジュール
Mauritius
MU
MUS
Address Now モジュール
Enterprise Geocoding モジュール (アフ
マルティニークは、フランスのジオコーダでサポートされています。
REST Web サービスガイド
317
ISO 国名
ISO 3116-1
Alpha-2
ISO 3116-1
Alpha-3
サポートされるモジュール
リカ)
Universal Addressing モジュール
9
10
318
Mayotte
YT
MYT
Address Now モジュール
Enterprise Geocoding モジュール
Universal Addressing モジュール
Mexico
MX
MEX
Address Now モジュール
Enterprise Geocoding モジュール
Universal Addressing モジュール
Micronesia, Federated States FM
Of
FSM
Address Now モジュール
Universal Addressing モジュール
Moldova, Republic Of
MD
MDA
Address Now モジュール
Universal Addressing モジュール
Monaco
MC
MCO
Address Now モジュール
Enterprise Geocoding モジュール
10
Universal Addressing モジュール
Mongolia
MN
MNG
Address Now モジュール
Universal Addressing モジュール
Montenegro
ME
MNE
Address Now モジュール
Universal Addressing モジュール
Montserrat
MS
MSR
Address Now モジュール
Universal Addressing モジュール
Morocco
MA
MAR
Address Now モジュール
Enterprise Geocoding モジュール (アフ
リカ)
Enterprise Routing モジュール
Universal Addressing モジュール
Mozambique
MZ
MOZ
Address Now モジュール
Enterprise Geocoding モジュール (アフ
リカ)
Universal Addressing モジュール
Myanmar
MM
MMR
Address Now モジュール
Universal Addressing モジュール
Namibia
NA
NAM
Address Now モジュール
Enterprise Geocoding モジュール (アフ
リカ)
Universal Addressing モジュール
マヨットは、フランスのジオコーダでサポートされています。
モナコは、フランスのジオコーダでサポートされています。
Spectrum Technology Platform 9.0 SP3
付録 C : Country Codes
ISO 国名
ISO 3116-1
Alpha-2
ISO 3116-1
Alpha-3
サポートされるモジュール
Nauru
NR
NRU
Address Now モジュール
Universal Addressing モジュール
Nepal
NP
NPL
Address Now モジュール
Universal Addressing モジュール
Netherlands
NL
NLD
Address Now モジュール
Enterprise Geocoding モジュール
Enterprise Routing モジュール
Universal Addressing モジュール
GeoComplete モジュール
New Caledonia
NC
NCL
Address Now モジュール
Universal Addressing モジュール
New Zealand
NZ
NZL
Address Now モジュール
Enterprise Geocoding モジュール
Enterprise Routing モジュール
Universal Addressing モジュール
Nicaragua
NI
NIC
Address Now モジュール
Enterprise Geocoding モジュール (ラテ
ンアメリカ)
Universal Addressing モジュール
Niger
NE
NER
Address Now モジュール
Enterprise Geocoding モジュール (アフ
リカ)
Universal Addressing モジュール
Nigeria
NG
NGA
Address Now モジュール
Enterprise Geocoding モジュール (アフ
リカ)
Enterprise Routing モジュール
Universal Addressing モジュール
Niue
NU
NIU
Address Now モジュール
Universal Addressing モジュール
Norfolk Island
NF
NFK
Address Now モジュール
Universal Addressing モジュール
Northern Mariana Islands
MP
MNP
Address Now モジュール
Universal Addressing モジュール
Norway
NO
NOR
Address Now モジュール
Enterprise Geocoding モジュール
Enterprise Routing モジュール
Universal Addressing モジュール
GeoComplete モジュール
REST Web サービスガイド
319
320
ISO 国名
ISO 3116-1
Alpha-2
ISO 3116-1
Alpha-3
サポートされるモジュール
Oman
OM
OMN
Address Now モジュール
Enterprise Geocoding モジュール (中東)
Enterprise Routing モジュール
Universal Addressing モジュール
Pakistan
PK
PAK
Address Now モジュール
Universal Addressing モジュール
Palau
PW
PLW
Address Now モジュール
Universal Addressing モジュール
Palestinian Territory,
Occupied
PS
PSE
Address Now モジュール
Universal Addressing モジュール
Panama
PA
PAN
Address Now モジュール
Enterprise Geocoding モジュール (ラテ
ンアメリカ)
Universal Addressing モジュール
Papua New Guinea
PG
PNG
Address Now モジュール
Universal Addressing モジュール
Paraguay
PY
PRY
Address Now モジュール
Enterprise Geocoding モジュール (ラテ
ンアメリカ)
Universal Addressing モジュール
Peru
PE
PER
Address Now モジュール
Enterprise Geocoding モジュール (ラテ
ンアメリカ)
Universal Addressing モジュール
Philippines
PH
PHL
Address Now モジュール
Enterprise Geocoding モジュール
Universal Addressing モジュール
Pitcairn
PN
PCN
Address Now モジュール
Universal Addressing モジュール
Poland
PL
POL
Address Now モジュール
Enterprise Geocoding モジュール
Enterprise Routing モジュール
Universal Addressing モジュール
GeoComplete モジュール
Portugal
PT
PRT
Address Now モジュール
Enterprise Geocoding モジュール
Enterprise Routing モジュール
Universal Addressing モジュール
GeoComplete モジュール
Spectrum Technology Platform 9.0 SP3
付録 C : Country Codes
ISO 国名
ISO 3116-1
Alpha-2
ISO 3116-1
Alpha-3
サポートされるモジュール
Puerto Rico
PR
PRI
Address Now モジュール
Universal Addressing モジュール
Qatar
QA
QAT
Address Now モジュール
Enterprise Geocoding モジュール (中東)
Enterprise Routing モジュール
Universal Addressing モジュール
Reunion
RE
REU
Address Now モジュール
Enterprise Geocoding モジュール
11
Universal Addressing モジュール
Romania
RO
ROU
Address Now モジュール
Universal Addressing モジュール
Enterprise Routing モジュール
11
Russian Federation
RU
RUS
Address Now モジュール
Enterprise Geocoding モジュール
Universal Addressing モジュール
GeoComplete モジュール
Rwanda
RW
RWA
Address Now モジュール
Enterprise Geocoding モジュール (アフ
リカ)
Universal Addressing モジュール
Saint Barthelemy
BL
BLM
Address Now モジュール
Universal Addressing モジュール
Saint Helena, Ascension &
Tristan Da Cunha
SH
SHE
Address Now モジュール
Universal Addressing モジュール
Saint Kitts and Nevis
KN
KNA
Address Now モジュール
Enterprise Geocoding モジュール (ラテ
ンアメリカ)
Universal Addressing モジュール
Saint Lucia
LC
LCA
Address Now モジュール
Universal Addressing モジュール
Saint Martin (French Part)
MF
MAF
Address Now モジュール
Universal Addressing モジュール
Saint Pierre and Miquelon
PM
SPM
Address Now モジュール
Universal Addressing モジュール
Saint Vincent And The
Grenadines
VC
VCT
Address Now モジュール
Universal Addressing モジュール
レユニオンは、フランスのジオコーダでサポートされます。
REST Web サービスガイド
321
ISO 国名
ISO 3116-1
Alpha-2
ISO 3116-1
Alpha-3
サポートされるモジュール
Samoa
WS
WSM
Address Now モジュール
Universal Addressing モジュール
San Marino
SM
SMR
Address Now モジュール
12
Enterprise Geocoding モジュール
Universal Addressing モジュール
12
322
Sao Tome And Principe
ST
STP
Address Now モジュール
Universal Addressing モジュール
Saudi Arabia
SA
SAU
Address Now モジュール
Enterprise Geocoding モジュール (中東)
Universal Addressing モジュール
Senegal
SN
SEN
Address Now モジュール
Enterprise Geocoding モジュール (アフ
リカ)
Universal Addressing モジュール
Serbia
RS
SRB
Address Now モジュール
Universal Addressing モジュール
Seychelles
SC
SYC
Address Now モジュール
Universal Addressing モジュール
Sierra Leone
SL
SLE
Address Now モジュール
Universal Addressing モジュール
Singapore
SG
SGP
Address Now モジュール
Enterprise Geocoding モジュール
Enterprise Routing モジュール
Universal Addressing モジュール
GeoComplete モジュール
Sint Maarten (Dutch Part)
SX
SXM
Universal Addressing モジュール
Slovakia
SK
SVK
Address Now モジュール
Enterprise Geocoding モジュール
Enterprise Routing モジュール
Universal Addressing モジュール
GeoComplete モジュール
Slovenia
SI
SVN
Address Now モジュール
Enterprise Geocoding モジュール
Enterprise Routing モジュール
Universal Addressing モジュール
GeoComplete モジュール
サンマリノは、イタリアのジオコーダでサポートされています。
Spectrum Technology Platform 9.0 SP3
付録 C : Country Codes
ISO 国名
ISO 3116-1
Alpha-2
ISO 3116-1
Alpha-3
サポートされるモジュール
Solomon Islands
SB
SLB
Address Now モジュール
Universal Addressing モジュール
Somalia
SO
SOM
Address Now モジュール
Universal Addressing モジュール
South Africa
ZA
ZAF
Address Now モジュール
Enterprise Geocoding モジュール
Universal Addressing モジュール
GeoComplete モジュール
South Georgia And The South GS
Sandwich Islands
SGS
Address Now モジュール
Enterprise Geocoding モジュール
Universal Addressing モジュール
South Sudan
SS
SSD
Address Now モジュール
Universal Addressing モジュール
Spain
ES
ESP
Address Now モジュール
Enterprise Geocoding モジュール
Enterprise Routing モジュール
Universal Addressing モジュール
GeoComplete モジュール
Sri Lanka
LK
LKA
Address Now モジュール
Universal Addressing モジュール
Sudan
SD
SDN
Address Now モジュール
Universal Addressing モジュール
Suriname
SR
SUR
Address Now モジュール
Enterprise Geocoding モジュール (ラテ
ンアメリカ)
Universal Addressing モジュール
Svalbard And Jan Mayen
SJ
SJM
Address Now モジュール
Universal Addressing モジュール
Swaziland
SZ
SWZ
Address Now モジュール
Enterprise Geocoding モジュール (アフ
リカ)
Universal Addressing モジュール
Sweden
SE
SWE
Address Now モジュール
Enterprise Geocoding モジュール
Enterprise Routing モジュール
Universal Addressing モジュール
GeoComplete モジュール
REST Web サービスガイド
323
324
ISO 国名
ISO 3116-1
Alpha-2
ISO 3116-1
Alpha-3
サポートされるモジュール
Switzerland
CH
CHE
Address Now モジュール
Enterprise Geocoding モジュール
Enterprise Routing モジュール
Universal Addressing モジュール
GeoComplete モジュール
Syrian Arab Republic
SY
SYR
Address Now モジュール
Universal Addressing モジュール
Taiwan, Province of China
TW
TWN
Enterprise Routing モジュール
Address Now モジュール
Universal Addressing モジュール
Tajikistan
TJ
TJK
Address Now モジュール
Universal Addressing モジュール
Tanzania, United Republic Of TZ
TZA
Address Now モジュール
Enterprise Geocoding モジュール (アフ
リカ)
Universal Addressing モジュール
Thailand
TH
THA
Address Now モジュール
Enterprise Geocoding モジュール
Enterprise Routing モジュール
Universal Addressing モジュール
Timor-Leste
TL
TLS
Address Now モジュール
Universal Addressing モジュール
Togo
TG
TGO
Address Now モジュール
Enterprise Geocoding モジュール (アフ
リカ)
Universal Addressing モジュール
Tokelau
TK
TKL
Address Now モジュール
Universal Addressing モジュール
Tonga
TO
TON
Address Now モジュール
Universal Addressing モジュール
Trinidad and Tobago
TT
TTO
Address Now モジュール
Enterprise Geocoding モジュール (ラテ
ンアメリカ)
Universal Addressing モジュール
Tunisia
TN
TUN
Address Now モジュール
Enterprise Geocoding モジュール (アフ
リカ)
Universal Addressing モジュール
Spectrum Technology Platform 9.0 SP3
付録 C : Country Codes
ISO 国名
ISO 3116-1
Alpha-2
ISO 3116-1
Alpha-3
サポートされるモジュール
Turkey
TR
TUR
Address Now モジュール
Enterprise Geocoding モジュール
Universal Addressing モジュール
GeoComplete モジュール
Turkmenistan
TM
TKM
Address Now モジュール
Universal Addressing モジュール
Turks And Caicos Islands
TC
TCA
Address Now モジュール
Universal Addressing モジュール
Tuvalu
TV
TUV
Address Now モジュール
Universal Addressing モジュール
Uganda
UG
UGA
Address Now モジュール
Enterprise Geocoding モジュール (アフ
リカ)
Universal Addressing モジュール
Ukraine
UA
UKR
Address Now モジュール
Enterprise Geocoding モジュール
Enterprise Routing モジュール
Universal Addressing モジュール
United Arab Emirates
AE
ARE
Address Now モジュール
Enterprise Geocoding モジュール (中東)
Enterprise Routing モジュール
Universal Addressing モジュール
United Kingdom
GB
GBR
Address Now モジュール
Enterprise Geocoding モジュール
Enterprise Routing モジュール
Universal Addressing モジュール
GeoComplete モジュール
United States
US
USA
Address Now モジュール
Enterprise Geocoding モジュール
Enterprise Routing モジュール
Universal Addressing モジュール
GeoComplete モジュール
United States Minor Outlying UM
Islands
UMI
Address Now モジュール
Universal Addressing モジュール
Uruguay
UY
URY
Address Now モジュール
Enterprise Geocoding モジュール
Universal Addressing モジュール
Uzbekistan
UZ
UZB
Address Now モジュール
Universal Addressing モジュール
REST Web サービスガイド
325
326
ISO 国名
ISO 3116-1
Alpha-2
ISO 3116-1
Alpha-3
サポートされるモジュール
Vanuatu
VU
VUT
Address Now モジュール
Universal Addressing モジュール
Venezuela, Bolivarian
Republic Of
VE
VEN
Address Now モジュール
Enterprise Geocoding モジュール
Universal Addressing モジュール
Viet Nam
VN
VNM
Enterprise Routing モジュール
Address Now モジュール
Universal Addressing モジュール
Virgin Islands, British
VG
VGB
Address Now モジュール
Universal Addressing モジュール
Virgin Islands, U.S.
VI
VIR
Address Now モジュール
Universal Addressing モジュール
Wallis and Futuna
WF
WLF
Address Now モジュール
Universal Addressing モジュール
Western Sahara
EH
ESH
Address Now モジュール
Universal Addressing モジュール
Yemen
YE
YEM
Address Now モジュール
Universal Addressing モジュール
Zambia
ZM
ZMB
Address Now モジュール
Enterprise Geocoding モジュール (アフ
リカ)
Universal Addressing モジュール
Zimbabwe
ZW
ZWE
Address Now モジュール
Enterprise Geocoding モジュール (アフ
リカ)
Universal Addressing モジュール
Spectrum Technology Platform 9.0 SP3
ValidateAddress Confidence
アルゴリズム
このセクションの構成
• Validate Address 確信アルゴリズムの概要 . . . . . . . . . . .328
• 米国とカナダの住所に対する確信アルゴリズム住所の検証 .328
• 国際住所用の確信アルゴリズム . . . . . . . . . . . . . . . . . . . . .329
D
Validate Address 確信アルゴリズムの概要
ValidateAddress は、妥当性を確認した各住所に対し、確信スコアを計算します。このスコアは、妥
当性を確認した住所がどの程度正しいかを表します。確信コードの値は 0 ～ 100 で、0 はまったく確
信がなく、100 はマッチ結果が正しいことに対する確信レベルが非常に高いことを表します。確信コー
ドは、個々の出力フィールドに対するマッチ結果を考慮に入れたアルゴリズムに基づいて計算されま
す。この計算に関連する出力フィールドは、以下のとおりです。
•
•
•
•
•
•
•
•
•
•
Country
City
State
PostalCode
StreetName
HouseNumber
LeadingDirectional
TrailingDirectional
StreetSuffix
ApartmentNumber
アルゴリズムにおいて、各フィールドにはそれぞれ独自の重みがあります。また、各フィールドに対
し、"成功"、"失敗"、または "変更" というマッチ結果が存在します ("変更" は、マッチさせるために
フィールドの内容を修正した場合に該当します)。マッチ結果 ("成功"、"失敗"、または "変更") によっ
て、そのフィールドの係数が決まります。以上より、確信コードは、重みと係数の積を用いて、次の
ように算出します。
Confidence = (Weight * Factor) for City
+ (Weight * Factor) for Country
+ (Weight * Factor) for State
+ (Weight * Factor) for PostalCode
+ (Weight * Factor) for StreetName
+ (Weight * Factor) for HouseNumber
+ (Weight * Factor) for Directionals
+ (Weight * Factor) for Street Suffix
+ (Weight * Factor) for ApartmentNumber
米国とカナダの住所に対する確信アルゴリズム住所の検証
以下の表で、米国およびカナダの住所に対する ValidateAddress の確信アルゴリズムのスコアリング
とロジックについて説明します。独立した住所行に存在する余分なデータを返します。
表 122 : 米国とカナダの住所に対する確信アルゴリズム住所の検証
14
13
328
13
14
フィールド
重み付け/マッチスコ
ア
変更の場合の係数
埋めた場合の係数
Country
10
100%
0%
City
10
50%
75%
State
15
50%
75%
PostalCode
15
25%
25%
StreetName
15
50%
75%
このフィールドに入力データが存在しないが、マッチを得るためにデータが埋められた場合のこと。
このフィールドの入力データが、マッチを得るために変更された場合のこと。
Spectrum Technology Platform 9.0 SP3
付録 D : ValidateAddress Confidence アルゴリズム
13
14
フィールド
重み付け/マッチスコ
ア
変更の場合の係数
埋めた場合の係数
HouseNumber
15
50%
75%
Directionals
10
50%
75%
StreetSuffix
5
50%
75%
ApartmentNumber
5
50%
75%
国際住所用の確信アルゴリズム
米国およびカナダ以外の住所用に 2 つの確信アルゴリズムがあります。 1 つは郵便番号を使用する国
の住所用で、もう 1 つは郵便番号を使用しない国の住所用です。
以下の表に、郵便番号を使用している国の米国およびカナダ以外の住所用の確信アルゴリズムの詳細
を示します。
表 123 : 郵便番号がある国用の確信アルゴリズム
14
13
16
15
17
フィールド
重み付け/マッチスコア変更の場合の係埋めた場合の郵便データが使
15
16
数
係数
用できない場合
の係数
Country
11.1111111111111
100%
0%
City
11.1111111111111
50%
75%
0%
State
16.6666666666667
100%
100
80%
PostalCode
16.6666666666667
100%
100%
80%
StreetName
16.6666666666667
50%
75%
50%
HouseNumber
16.6666666666667
50%
75%
50%
Directionals
0
50%
75%
0%
StreetSuffix
5.55555555555556
50%
75%
50%
ApartmentNumber
5.55555555555556
50%
75%
50%
0%
17
このフィールドに入力データが存在しないが、マッチを得るためにデータが埋められた場合のこと。
このフィールドの入力データが、マッチを得るために変更された場合のこと。
このフィールドに入力データが存在しないが、マッチを得るためにデータが埋められた場合のこと。
このフィールドの入力データが、マッチを得るために変更された場合のこと。
カテゴリ C の国の場合、この値は 50% です。各国は、次のいずれかのカテゴリに分類されます。
• カテゴリ A — 住所の郵便番号、都市名、州/郡名、ストリートの住所要素、および国名の検証と修
正が可能です。
• カテゴリ B — 住所の郵便番号、都市名、州/郡名、および国名の検証と修正が可能です。ストリー
トの住所要素の検証または修正はサポートしません。
• カテゴリ C — 国名の検証および修正と、郵便番号の書式の検証が可能です。
REST Web サービスガイド
329
郵便番号を使用しない国用の確信アルゴリズムの詳細を次の表に示します。
表 124 : 郵便番号がない国用の確信アルゴリズム
フィールド
重み付け/マッチスコア変更の場合の係埋めた場合の
18
19
数
係数
郵便データが使
用できない場合
の係数
Country
13.3333333333333
100%
0%
0%
City
13.3333333333333
50%
75%
0%
State
20
100%
100
80%
StreetName
20
50%
75%
50%
HouseNumber
20
50%
75%
50%
Directionals
0
50%
75%
0%
StreetSuffix
6.66666666666667
50%
75%
50%
ApartmentNumber
6.66666666666667
50%
75%
50%
20
郵便番号がない国の一覧を以下の表に示します。
表 125 : 郵便番号がない国
19
18
20
Afghanistan
Albania
Angola
Anguilla
Bahamas
Barbados
Belize
Benin
Bhutan
Botswana
Burkina Faso
Burundi
Cameroon
Cayman Islands
中央アフリカ共和国
Chad
ココス諸島
コロンビア
Comoros
コンゴ (民主共和国)
コンゴ (共和国)
コートジボワール
北朝鮮
Djibouti
Dominica
Equatorial Guinea
Eritrea
Fiji
Gabon
Gambia
Ghana
Grenada
Guyana
このフィールドに入力データが存在しないが、マッチを得るためにデータが埋められた場合のこと。
このフィールドの入力データが、マッチを得るために変更された場合のこと。
カテゴリ C の国の場合、この値は 50% です。各国は、次のいずれかのカテゴリに分類されます。
• カテゴリ A — 住所の郵便番号、都市名、州/郡名、ストリートの住所要素、および国名の検証と修
正が可能です。
• カテゴリ B — 住所の郵便番号、都市名、州/郡名、および国名の検証と修正が可能です。ストリー
トの住所要素の検証または修正はサポートしません。
• カテゴリ C — 国名の検証および修正と、郵便番号の書式の検証が可能です。
330
Spectrum Technology Platform 9.0 SP3
付録 D : ValidateAddress Confidence アルゴリズム
Ireland
Jamaica
Kiribati
リビア
Malawi
Mali
Mauritania
Namibia
Nauru
パラオ
Panama
Peru
Qatar
Rwanda
Saint Lucia
セントビンセントおよびグレナ
ディーン諸島
Samoa
サントメ・プリンシペ
Seychelles
Sierra Leone
Suriname
タンザニア
ティモール島
Togo
Tonga
トリニダード・トバゴ
Tuvalu
Uganda
United Arab Emirates
Vanuatu
Yemen
Zimbabwe
REST Web サービスガイド
331
著作権に関する通知
2014 Pitney Bowes Software Inc. All rights reserved. MapInfo および Group 1 Software は Pitney
Bowes Software Inc. の商標です。その他のマークおよび商標はすべて、それぞれの所有者の資産で
す。
©
®
USPS 情報
®
Pitney Bowes Inc. は、ZIP + 4 データベースを光学および磁気媒体に発行および販売する非独占的ラ
イセンスを所有しています。 CASS、CASS 認定、DPV、eLOT、FASTforward、First-Class Mail、
Link
Link
Intelligent Mail、LACS 、NCOA 、PAVE、PLANET Code、Postal Service、POSTNET、Post
Link
Office、RDI、Suite
、United States Postal Service、Standard Mail、United States Post Office、
USPS、ZIP Code、および ZIP + 4 の各商標は United States Postal Service が所有します。 United
States Postal Service に帰属する商標はこれに限りません。
Link®
Pitney Bowes Inc. は、NCOA
®
処理に対する USPS の非独占的ライセンスを所有しています。
Pitney Bowes Software の製品、オプション、およびサービスの価格は、USPS® または米国政府によっ
™
て規定、制御、または承認されるものではありません。 RDI データを利用して郵便送料を判定する
®
場合に、使用する郵便配送業者の選定に関するビジネス上の意思決定が USPS または米国政府によっ
て行われることはありません。
データプロバイダおよび関連情報
このメディアに含まれて、Pitney Bowes Software アプリケーション内で使用されるデータ製品は、各
種商標によって、および次の 1 つ以上の著作権によって保護されています。
©
Copyright United States Postal Service. All rights reserved.
©
2014 TomTom. All rights reserved. TomTom および TomTom ロゴは TomTom N.V の登録商標です。
©
Copyright NAVTEQ. All rights reserved
データ © 2014 NAVTEQ North America, LLC
Fuente: INEGI (Instituto Nacional de Estadística y Geografía)
電子データに基づいています。© National Land Survey Sweden.
©
Copyright United States Census Bureau
©
Copyright Nova Marketing Group, Inc.
このプログラムの一部は著作権で保護されています。© Copyright 1993-2007 by Nova Marketing Group
Inc. All Rights Reserved
©
Copyright Second Decimal, LLC
©
Copyright Canada Post Corporation
この CD-ROM には、Canada Post Corporation が著作権を所有している編集物からのデータが収録さ
れています。
©
2007 Claritas, Inc.
Geocode Address World データセットには、http://creativecommons.org/licenses/by/3.0/legalcode
に存在するクリエイティブコモンズアトリビューションライセンス (「アトリビューションライセン
ス」) の下に提供されている GeoNames Project (www.geonames.org) からライセンス供与されたデー
タが含まれています。お客様による GeoNames データ (Spectrum™ Technology Platform ユーザマ
ニュアルに記載) の使用は、アトリビューションライセンスの条件に従う必要があり、お客様と Pitney
Bowes Software, Inc. との契約と、アトリビューションライセンスの間に矛盾が生じる場合は、アト
リビューションライセンスのみに基づいてそれを解決する必要があります。お客様による GeoNames
データの使用に関しては、アトリビューションライセンスが適用されるためです。
334
Spectrum Technology Platform 9.0 SP3
Copyright
ICU 情報
Copyright © 1995-2011 International Business Machines Corporation and others.
All rights reserved.
ここでの許可は、このソフトウェアおよび関連ドキュメントファイル (以下「ソフトウェア」) のコ
ピーを取得する任意のユーザに無償で付与されるものであり、ソフトウェアのコピーを使用、複製、
改変、結合、発行、頒布、および/または販売する権利に対する制限などの制約を一切受けることなく
ソフトウェアを扱い、かつ、ソフトウェアが提供されるユーザがそうした目的で使用することを認め
るもので、その条件として、上記の著作権情報およびここでの許可情報をソフトウェアのすべてのコ
ピーに掲載すること、かつ上記の著作権情報およびここでの許可情報の両方を補足ドキュメントに掲
載する必要があります。
ソフトウェアは、何等保証のない「現状有姿」で提供されるものであり、商品性、特定用途に対する
適合性、第三者の権利非侵害、およびその他について、明示であると黙示であるとを問わず、一切保
証しないものとします。いかなる場合も、ここに記載される著作権所有者は、あらゆる請求に対し
て、あるいは契約上の行為であれ、怠慢であれ、このソフトウェアの使用またはパフォーマンスに起
因または関連して発生するその他の不法行為であれ、使用不能損失、データ損失、または利益損失を
原因として発生する特別損害、間接損害、派生的損害、またはその他のいかなる損害に対しても、一
切責任を負わないものとします。
ここでの記載を除き、著作権所有者の名前を、著作権所有者の書面による事前の許可なく、広告で、
あるいはこのソフトウェアの販売、使用、または取扱を促進するその他媒体で使用してはなりません。
REST Web サービスガイド
335

Download Report