|
楽天トラベル地区コードAPIとは
■リクエストURL(REST/JSON形式の場合)
http://api.rakuten.co.jp/rws/2.0/rest?[parameter]=[value]…
http://api.rakuten.co.jp/rws/2.0/json?[parameter]=[value]…
※JSONP形式は、JSON形式で入力パラメーターにcallBackを指定することで出力されます。
地区コードを取得する場合のリクエストURLは下記になります。(実際には改行せずに1行につなげてリクエストしてください。)
http://api.rakuten.co.jp/rws/2.0/rest?
developerId=[YOUR_developerID]
&operation=GetAreaClass
&version=2009-03-26
| ※ |
短い時間の間に大量に、同一のリクエストURLへアクセスすると、一定時間利用できなくなる場合がございます。テストの際にはご注意ください。 |
■SOAPについて
■入力パラメーター
| 楽天トラベル地区コードAPI(GetAreaClass) 入力パラメーター version:2009-03-26 |
| 区分 |
ID |
項目名 |
フィールド名 |
型
(括弧内は
最大
バイト数) |
必須 |
デフォルト |
備考 |
共
通
パ
ラ
メ
|
タ
| |
1 |
デベロッパID |
developerId |
String |
○ |
--- |
デベロッパーID |
| 2 |
アフィリエイトID |
affiliateId |
String |
- |
指定無し |
アフィリエイトID |
| 3 |
操作 |
operation |
String |
○ |
--- |
使用するAPIの操作名:GetAreaClass |
| 4 |
コールバック関数名 |
callBack |
String |
- |
指定無し |
JSONPとして出力する際のコールバック関数名
(UTF-8でURLエンコードした文字列)
英数字、「.(ドット)」、「_(アンダーバー)」、「[(中括弧)」、「](中括弧)」のいずれか1文字以上 |
サ
|
ビ
ス
固
有
パ
ラ
メ
|
タ
| |
1 |
バージョン |
version |
String |
○ |
--- |
2009-03-26 |
|
■出力パラメーター
| 楽天トラベル地区コードAPI(GetAreaClass) 出力パラメーター version:2009-03-26 |
| 区分 |
ID |
分類 |
項目名 |
フィールド名 |
備考 |
共
通
パ
ラ
メ
|
タ
| |
1 |
Arg |
--- |
User-Agent |
Valueにはユーザのユーザエージェントが表示される |
| 2 |
--- |
developerId |
ValueにはデベロッパーIDが表示される |
| 3 |
--- |
affiliateId |
Valueにはユーザの指定したアフィリエイトIDが表示される |
| 4 |
--- |
operation |
Valueにはユーザの指定した操作名が表示される |
| 5 |
--- |
version |
Valueにはユーザの指定した操作のバージョンが表示される |
| 6 |
Status |
--- |
Status |
Success / NotFound / ServerError / ClientError / Maintenance のいずれか |
| 7 |
StatusMsg |
--- |
StatusMsg |
Statusに特化したメッセージを出力 |
サ
|
ビ
ス
固
有
パ
ラ
メ
|
タ
| |
1 |
大区分 |
--- |
largeClass |
|
| 2 |
大区分コード |
largeClassCode |
例) japan |
| 3 |
大区分名称 |
largeClassName |
例) 日本 |
| 4 |
中区分 |
--- |
middleClass |
|
| 5 |
中区分コード |
middleClassCode |
例) tokyo |
| 6 |
中区分名称 |
middleClassName |
例) 東京 |
| 7 |
小区分 |
--- |
smallClass |
|
| 8 |
小区分コード |
smallClassCode |
例) tokyo |
| 9 |
小区分名称 |
smallClassName |
例) 東京23区 |
| 10 |
細区分 |
--- |
detailClass |
|
| 11 |
細区分コード |
detailClassCode |
例) A |
| 12 |
細区分名称 |
detailClassName |
例) 東京駅・銀座・日本橋 |
|
■エラー
エラーが起こった際は、出力中の「共通パラメーター」のStatusに下表に記載されたいずれかが表示されます。
| Statusでの表示 |
内容 |
| NotFound |
検索結果が存在しない。 |
| ServerError |
楽天ウェブサービス側のエラー。 |
| ClientError |
デベロッパーの入力に起因するエラー。 |
| Maintenance |
メンテナンス。 |
|
■過去のバージョン
本APIの過去のバージョンは下記からご覧いただけます。
|