This website will be under maintenance from Friday August 23, 2:00 PM to Monday August 26, 2.00 PM JST. Only this website is impacted. The Rakuten APIs will continue to work. Sorry for the inconvenience. For more details please check our SNS announcement.
Home      API一覧     楽天トラベル地区コードAPI

楽天トラベル地区コードAPIは、楽天トラベルで用いられる地区コードの情報を取得することが可能なAPIです。

リクエストURL


https://app.rakuten.co.jp/services/api/Travel/GetAreaClass/20131024?[parameter]=[value]…

※JSONP形式は、JSON形式で入力パラメーターにcallbackを指定することで出力されます。

地区コードを取得する場合のリクエストURLは下記になります。(実際には改行せずに1行につなげてリクエストしてください。)

https://app.rakuten.co.jp/services/api/Travel/GetAreaClass/20131024?
applicationId=[アプリID]
&format=xml

※短い時間の間に大量に、同一のリクエストURLへアクセスすると、一定時間利用できなくなる場合がございます。テストの際にはご注意ください。

入力パラメーター


楽天トラベル地区コードAPI(GetAreaClass) 入力パラメーター version:2013-10-24

ID 項目名 パラメーター 型(括弧内は最大バイト数) 必須 デフォルト 備考
区分:共通パラメーター
1 アプリID applicationId String 必須 - こちらで確認できます
2 アフィリエイトID affiliateId String - 指定無し こちらで確認できます
3 レスポンス形式 format String - json json か xml を選択することができます。
json を選択した場合、 callback パラメーター指定により jsonp 形式にすることもできます。
4 コールバック関数名 callback String - 指定無し JSONPとして出力する際のコールバック関数名
(UTF-8でURLエンコードした文字列)
英数字、「.(ドット)」、「_(アンダーバー)」、「[(中括弧)」、「](中括弧)」のいずれか1文字以上
5 出力パラメーター指定 elements String - ALL カンマ区切りで、必要な出力パラメータを指定した場合、
指定された出力パラメータのみを返却します。
(例)elements=reviewCount,reviewAverage
6 出力フォーマットバージョン formatVersion int - 1

出力フォーマットのバージョン指定です。

2 を指定すると、JSONの出力方法が改善され以下のようになります。

formatVersion=1 の場合:
配列データに関して、以下の様にデータが返ります。
したがって、最初の itemName にアクセスするためにitems[0].item.itemNameとたどる必要があります。

{"items": [
    {"item": {
        "itemName": "a",
        "itemPrice": 10
    }},
    {"item": {
        "itemName": "b",
        "itemPrice": 20
    }}
]}

formatVersion=2 の場合:
下記のように、配列中の重複するオブジェクトが省略されます。
最初の itemName にアクセスするためにitems[0].itemNameでアクセスできます。

{"items": [
    {
        "itemName": "a",
        "itemPrice": 10
    },
    {
        "itemName": "b",
        "itemPrice": 20
    }
]}

出力パラメーター


楽天トラベル地区コードAPI(GetAreaClass) 出力パラメーター version:2013-10-24

ID 大分類 分類 項目名 パラメーター 備考
区分:サービス固有パラメーター
1 地区コード
areaClasses
大区分
largeClasses
"<largeClasses> ~ </largeClasses>"内に複数の
"<largeClass> ~ </largeClass>"が表示される
大区分コード largeClassCode 例) japan
2 大区分名称 largeClassName 例) 日本
3 中区分
middleClasses
"<middleClasses> ~ </middleClasses>"内に複数の
"<middleClass> ~ </middleClass>"が表示される
中区分コード middleClassCode 例) tokyo
4 中区分名称 middleClassName 例) 東京
5 小区分
smallClasses
"<smallClasses> ~ </smallClasses>"内に複数の
"<smallClass> ~ </smallClass>"が表示される
小区分コード smallClassCode 例) tokyo
6 小区分名称 smallClassName 例) 東京23区
7 細区分
detailClasses
"<detailClasses> ~ </detailClasses>"内に複数の
"<detailClass> ~ </detailClass>"が表示される
細区分コード detailClassCode 例) A
8 細区分名称 detailClassName 例) 東京駅・銀座・日本橋

エラー

エラー内容はHTTPステータスコードとレスポンスボディから判断できます。

HTTPステータスコード 意味 レスポンスボディ例 (JSON)
400 パラメーターエラー (必須パラメータ不足)

applicationId を指定しなかった場合

{
    "error": "wrong_parameter",
    "error_description": "specify valid applicationId"
}

keyword が正しい値でなかった時。(半角1文字のみ指定など)

{
    "error": "wrong_parameter",
    "error_description": "keyword parameter is not valid"
}
404 対象のデータが存在しなかった場合
{
    "error": "not_found",
    "error_description": "not found"
}
429 リクエスト過多 (各ユーザ制限値超過)

APIリクエスト数が上限に達した場合のエラーです。しばらく時間を空けてから、ご利用ください。

{
    "error": "too_many_requests",
    "error_description": "number of allowed requests has been exceeded for this API. please try again soon."
}
500 楽天ウェブサービス内のエラー

システムエラー。長時間続くようであれば、こちらよりごお問い合わせください。

{
    "error": "system_error",
    "error_description": "api logic error"
}
503 メンテナンス・リクエスト過多 (全ユーザ制限値超過)

メンテナンス (XXX/XXX にはAPI名が入る)

{
    "error": "service_unavailable",
    "error_description": "XXX/XXX is under maintenance"
}

レスポンスボディの形式は format に従います。

format エラー出力例
json
{
    "error": "wrong_parameter",
    "error_description": "page must be a number"
}
xml
<?xml version="1.0" encoding="UTF-8"?>
<root>
    <error>wrong_parameter</error>
    <error_description>page must be a number</error_description>
</root>