リクエストとレスポンス

このページでは、リクエストボディの形式、レスポンスのエンベロープ、ページネーション、日付と金額の形式、HTTP ステータスコードの解釈について説明します。

リクエストボディ#

エンドポイントは2種類のボディ形式のいずれかを使用します。どちらを使うかは各エンドポイントのリファレンスページに記載しています。

フォームボディの配列フィールドは、角括弧を付けて繰り返します：childAges[]=7&childAges[]=12。JSON ボディは UTF-8 でなければなりません。

レスポンスのエンベロープ#

レスポンスは JSON です。ほとんどのレスポンスは success フラグを含み、リストは count と items で返ります。

{
    "success": true,
    "count": 3,
    "items": [
        {
            "id": 1,
            "titleCode": "TRY",
            "symbol": "₺",
            "price": 1
        },
        {
            "id": 2,
            "titleCode": "EUR",
            "symbol": "€",
            "price": 47.85000000000000142108547152020037174224853515625
        }
    ]
}

ビジネスルールのチェックに失敗すると、success: false とエラーの説明が返ります。形式は次の2種類です。

{
    "success": false,
    "message": "online_cupon_is_not_found"
}

{
    "success": false,
    "errorMessage": "Invalid parameters.",
    "errorCode": 10022
}

例外として、連絡先エンドポイントはエンベロープなしのオブジェクトをそのまま返し、予約送信は BookingPushRS オブジェクトを返します。どちらもリファレンスに記載しています。

HTTP ステータスコード#

ページネーション#

リスト系のエンドポイント（/external/currencies、/external/languages、/external/online/social/media、/external/stock/packages）は、ページ番号でページ分割されます。

count は総件数です。page × limit ≥ count になった時点でリストの末尾に達しています。

日付・時刻・金額#

チェックアウト日は宿泊に含まれません。8月18日〜20日は2泊です。金額を float で加算しないでください。10進数ライブラリーか、最小通貨単位の整数を使用してください。

言語#

客室一覧は language フィールド（ISO 639-1：tr、en、de…）を受け取り、客室名、設備名、エラーメッセージをその言語で返します。パッケージ一覧は languageID を受け取ります。ID は言語エンドポイントから取得します。