|
■リクエストURL
http://api.rakuten.co.jp/rws/soap/GetAreaClass/2008-02-14
| ※ |
リクエストURLは取得するデータ種別にかかわらず、すべて同じです。 |
■インターフェース仕様
■入力パラメーター
| 楽天トラベル地区コードAPI(GetAreaClass) SOAP用入力パラメータ version:2008-02-14 |
| 区分 |
ID |
項目名 |
フィールド名 |
型 |
必須 |
デフォルト |
備考 |
共
通
パ
ラ
メ
|
タ
| |
1 |
デベロッパID |
developerId |
String |
○ |
--- |
デベロッパーID |
| 2 |
アフィリエイトID |
affiliateId |
String |
- |
指定無し |
アフィリエイトID |
サ
|
ビ
ス
固
有
パ
ラ
メ
|
タ
| |
1 |
バージョン |
apiVersion |
String |
○ |
--- |
1.11 |
|
■出力パラメーター
| 楽天トラベル地区コードAPI(GetAreaClass) SOAP用出力パラメータ version:2008-02-14 |
| 区分 |
ID |
分類 |
項目名 |
型 |
フィールド名 |
備考 |
共
通
パ
ラ
メ
|
タ
| |
1 |
arg |
--- |
String |
User-Agent |
Valueにはユーザのユーザエージェントが表示される |
| 2 |
--- |
String |
developerId |
ValueにはデベロッパーIDが表示される |
| 3 |
--- |
String |
affiliateId |
Valueにはユーザの指定したアフィリエイトIDが表示される |
| 4 |
--- |
String |
operation |
Valueにはユーザの指定した操作名が表示される |
| 5 |
--- |
String |
apiVersion |
Valueにはユーザの指定した楽天ウェブサービスのバージョンが表示される |
| 6 |
--- |
String |
version |
Valueにはユーザの指定した操作のバージョンが表示される |
| 7 |
status |
--- |
String |
Status |
Success / NotFound / ServerError / ClientError / Maintenance のいずれか |
| 8 |
statusMsg |
--- |
String |
StatusMsg |
Statusに特化したメッセージを出力 |
サ
|
ビ
ス
固
有
パ
ラ
メ
|
タ
| |
1 |
大区分 |
--- |
|
largeClass |
|
| 2 |
大区分コード |
String |
largeClassCode |
例) japan |
| 3 |
大区分名称 |
String |
largeClassName |
例) 日本 |
| 4 |
中区分 |
--- |
|
middleClass |
|
| 5 |
中区分コード |
String |
middleClassCode |
例) tokyo |
| 6 |
中区分名称 |
String |
middleClassName |
例) 東京 |
| 7 |
小区分 |
--- |
|
smallClass |
|
| 8 |
小区分コード |
String |
smallClassCode |
例) tokyo |
| 9 |
小区分名称 |
String |
smallClassName |
例) 東京23区 |
| 10 |
細区分 |
--- |
|
detailClass |
|
| 11 |
細区分コード |
String |
detailClassCode |
例) A |
| 12 |
細区分名称 |
String |
detailClassName |
例) 東京駅・銀座・日本橋 |
|
■エラー
エラーが起こった際は、出力中の「共通パラメーター」のStatusに下表に記載されたいずれかが表示されます。
| Statusでの表示 |
内容 |
| NotFound |
検索結果が存在しない。 |
| ServerError |
楽天ウェブサービス側のエラー。 |
| ClientError |
デベロッパーの入力に起因するエラー。 |
| Maintenance |
メンテナンス。 |
|
|