![[9]](../common/images/ref-num9.gif)
エラー時のレスポンス
航空券検索API
リクエストURL
検索クエリ
| パラメータ | 項目名 | 説明 | 必須 | 値 |
|---|---|---|---|---|
| key | APIキー | APIを利用するために割り当てられたキーを設定します。 | ○ | |
| id | 航空券id | 航空券毎のIDこの項目を指定した場合はym,ymdを除くその他の絞込みクエリはすべて無視されます。複数指定可能*2 | *1 | 例:324322 |
| area | エリアコード | エリアマスタAPI参照。同時にzone、country、cityの指定があった場合は無視される。複数指定する事で OR 検索が可能 *2 特殊記法で AND 絞り込みも可 |
*1 | 例:EUR |
| zone | 地域コード | 地域マスタAPI参照。同時にcountry、cityの指定があった場合は無視される。複数指定する事で OR 検索が可能 *2 特殊記法で AND 絞り込みも可 |
*1 | 例: BC2 |
| country | 国コード | 国マスタAPI参照。同時にcityの指定があった場合は無視される。複数指定する事で OR 検索が可能 *2 特殊記法で AND 絞り込みも可 |
*1 | 例: BE |
| city | 都市(空港)コード | 都市（空港）マスタ空港API参照。複数指定する事で OR 検索が可能 *2 特殊記法で AND 絞り込みも可 |
*1 | 例: NYC |
| keyword | フリーワード | 文字コードはUTF8。半角スペース区切りの文字列を渡すことでAND検索になる。複数指定可能*2。 別途クエリ項目 kwic=1 を指定する事で Keyword In Context 機能も利用可能 (詳細はこちらを参照)。 フリーワードを指定して、かつ並び順 order に何も指定しない場合、検索結果は「フリーワードマッチ順」でソートされます。 |
*1 | 例: ベトナム |
| keyword_or | フリーワード(OR検索) | 文字コードはUTF8。半角スペース区切りの文字列 (最大5単語まで) を渡すことでOR検索になる。上記フリーワード (keyword) 指定がある場合、こちらは無視される。複数指定可能*2。 別途クエリ項目 kwic=1 を指定する事で Keyword In Context 機能も利用可能 (詳細はこちらを参照)。 フリーワードを指定して、かつ並び順 order に何も指定しない場合、検索結果は「フリーワードマッチ順」でソートされます。 |
*1 | 例: ベトナム |
| dept | 出発地(大分類） | コードで指定。複数指定する事で OR 検索が可能*2 特殊記法で AND 絞り込みも可 |
TYO:東京 NGO:名古屋 OSA:大阪 FUK:福岡 999:その他 |
|
| dept_detail | 出発地詳細 | 出発地詳細マスタ参照。複数指定する事で OR 検索が可能*2 特殊記法で AND 絞り込みも可 |
*1 | HND |
| ym | 出発月 | 200708 (6桁yyymm)または 0708 (4桁yymm)または 08 (2桁mm:今年の8月)または 8 (1桁m:今年の8月)。あるいは今月からの相対指定も可能 *3 | *1 | 例: 0708 |
| ymd | 出発日 | 20070812 (8桁yyyymmdd)または 070812 (6桁yymmdd)または 0812 (4桁mmdd:今年の8月12日)。ymとymd両方を指定していた場合はymdが優先。あるいは今月からの相対指定も可能 *3 | *1 | 例: 070812 |
| price_min | 価格帯下限 | この価格以上の航空券を検索。 単位は円 | 例:30000 | |
| price_max | 価格帯上限 | この価格以下の航空券を検索。 単位は円 | 例:100000 | |
| term_min | 期間下限 | この期間以上の航空券を検索。 単位は日 | 例:3 | |
| term_max | 期間上限 | この期間以下の航空券を検索。 単位は日 | 例:10 | |
| seat_class | シートクラス | 0:指定しない (デフォルト) 1:エコノミー 2:プレミアムエコノミー 3:ビジネス 4:ファースト 複数指定可能*2 |
例: 0 | |
| dept_time | 出発時間帯 | 0:指定しない (デフォルト) 1:午前便 2:午後便 3:夜便 複数指定可能*2 |
例: 0 | |
| trip_type | 航空券の種類 | 0:指定しない (デフォルト) 1:OPEN 2:FIX 3:FIX/OPEN 4:片道 複数指定可能*2 参照：航空券用語説明 |
例: 0 | |
| airline | 航空会社 | 航空会社マスタAPI参照。複数指定する事で OR 検索が可能 *2 特殊記法で AND 絞り込みも可 |
*1 | 例: AO |
| kodaw | こだわり項目 | こだわりマスタAPI参照。コードで指定。複数指定する事で OR 検索が可能 *2 特殊記法で AND 絞り込みも可 |
*1 | 例: 1 |
| order | ソート順 | 検索結果の並び順を指定します。 検索クエリ項目「フリーワード」を指定しつつ、この order に何も指定をしなかった場合は自動的に「フリーワードマッチ順」でソートされます (AB-ROAD独自定義のワード適合ロジック)。 |
0:新着順(更新日付が新しい航空券から表示、デフォルト) 1:価格安い順 2:価格高い順 3:期間短い順 4:期間長い順 |
|
| kiwc | KWICレスポンス設定 | クエリ項目「フリーワード」を利用の際、追加でこの kwic に値 1 を指定する事で API レスポンスに KWIC コンテンツを追加させる事ができます (詳細はこちらを参照) 。 | 例:1 | |
| start | 検索の開始位置 | 検索結果の何件目から出力するかを指定します。 | 初期値:1 | |
| count | 1ページあたりの取得数 | 検索結果の最大出力データ数を指定します。 | 初期値：10、最小1、最大100 | |
| format | レスポンス形式 | レスポンスをXMLかJSONかJSONPかを指定します。JSONPの場合、さらにパラメータ callback=コールバック関数名 を指定する事により、javascript側コールバック関数の名前を指定できます。 | 初期値:xml。xml または json または jsonp。 |
- *1：いずれか最低1つが必要。id指定の場合、その他絞込みパラメータは無視される (e.g. 国/都市/価格/期間など)
- *2：複数可のパラメータの指定方法
name=value1&name=value2&...または name=value1,value2,... - *3：+1m, +6m 等で今月からの月加算 (+0m:今月)、+1d, +30d (日加算)でも +1y (年加算)でも可。※プラス記号(+)は省略可。
サンプルクエリ
※実際にご利用いただくには新規登録をした上で、取得したご自身のAPIキーをGETパラメータに加えていただく必要があります。
レスポンスフィールド
| フィールド | 説明 | 例 |
|---|---|---|
| results | ||
| api_version | APIバージョン | 1.0 |
| results_available | クエリー条件にマッチする、検索結果の全件数 | 14 |
| results_returned | このXMLに含まれるアイテム数 | 10 |
| results_start | 検索結果の開始位置 | 1 |
| ticket | 航空券[複数要素] | |
| id | 航空券のID | AR459283 |
| title | 航空券のタイトル | 香港周遊 往復 |
| last_update | 最終更新日時 | 2009-12-31T14:14:14Z |
| airline | 航空会社[複数要素] | |
| code | 航空会社コード | 000001 |
| name | 航空会社名 | リクルート航空 |
| airline_type | 利用予定航空会社区分 未定、指定、共同運行、いづれか(airlineでレスポンスされる航空会社のいづれか） | 指定 |
| airline_summary | 利用航空会社要約（航空会社の文字列airline要素のnameを接続した文字列）+ 利用予定航空会社区分 | リクルート航空指定 |
| mile | マイル加算提携航空会社 | DY、DD、DA、CD |
| dept_detail | 出発地詳細[複数要素] | |
| code | コード | NRT |
| name | 地名(空港) | 成田 |
| dept | 出発地大分類 | |
| code | コード | TKO |
| name | 名称 | 東京 |
| city_number | 訪問可能都市 | |
| number | 訪問可能都市数 | 3 |
| open_jow | オープンジョー(1:オープンジョー区間あり 0:オープンジョー区間なし) | 1 |
| summary | 詳細 | 3都市(オープンジョー区間有り) |
| city | 訪問可能都市[複数要素] | |
| code | 訪問可能都市(空港)のコード | NYK |
| name | 訪問可能都市(空港)名 | ジュネーブ、ロンドン、フランクフルト |
| nonstop | 直行便かどうか(1:直行便である、0:直行便でない) | 1 |
| term_min | 最短利用期間 | 6 |
| term_max | 最長利用期間 | 16 |
| seat_class | シートクラス | |
| code | コード(1:エコノミー、2:プレミアムエコノミー、3:ビジネス、4:ファースト) | 1 |
| name | シートクラス名 | エコノミー |
| dept_time | 出発時間帯 | |
| code | コード(1:午前便、2:午後便、3:夜便、4:未定) | 1 |
| name | 名称 | 午前便 |
| trip_type | 片道／往復 | |
| code | コード(1:OPEN、2:FIX、3:FIX/OPEN、4:片道) | 1 |
| name | 名称 | OPEN |
| kodaw | こだわり条件[複数要素] | |
| code | こだわり条件コード | 1 |
| name | 条件 | オープンジョー可 |
| price | 金額 | |
| all_month | 申し込み可能期間の金額 | |
| min | 申し込み可能期間内での最安値(円) | 30000 |
| max | 申し込み可能期間内での最高値(円) | 500000 |
| min | 検索対象期間内での最安値(円) | 20000 |
| max | 検索対象期間内での最高値(円) | 600000 |
| bland | ブランド | |
| code | ブランドコード | SDE321435 |
| name | ブランド名 | abroad sky |
| urls | エイビーロード(AB-ROAD)の航空券詳細ページのURL | |
| mobile | モバイル用 | URL |
| pc | PC用 | URL |
| qr | QRコード画像の表示 | URL |
エリアマスタAPI
リクエストURL
検索クエリ
| パラメータ | 項目名 | 説明 | 必須 | 値 |
|---|---|---|---|---|
| key | APIキー | APIを利用するために割り当てられたキーを設定します。 | ○ | |
| format | レスポンス形式 | レスポンスをXMLかJSONかJSONPかを指定します。JSONPの場合、さらにパラメータ callback=コールバック関数名 を指定する事により、javascript側コールバック関数の名前を指定できます。 | 初期値:xml。xml または json または jsonp。 |
- *1：複数可のパラメータの指定方法
name=value1&name=value2&...または name=value1,value2,...
サンプルクエリ
※実際にご利用いただくには新規登録をした上で、取得したご自身のAPIキーをGETパラメータに加えていただく必要があります。
レスポンスフィールド
| フィールド | 説明 | 例 |
|---|---|---|
| results | ||
| api_version | APIバージョン | 1.0 |
| results_available | クエリー条件にマッチする、検索結果の全件数 | 14 |
| results_returned | このXMLに含まれるアイテム数 | 10 |
| results_start | 検索結果の開始位置 | 1 |
| area | エリア[複数要素] | |
| code | エリアコード | EUR |
| name | エリア名 | ヨーロッパ |
| ticket_count | このエリアに行く航空券の件数 | 37 |
地域マスタAPI
リクエストURL
検索クエリ
| パラメータ | 項目名 | 説明 | 必須 | 値 |
|---|---|---|---|---|
| key | APIキー | APIを利用するために割り当てられたキーを設定します。 | ○ | |
| format | レスポンス形式 | レスポンスをXMLかJSONかJSONPかを指定します。JSONPの場合、さらにパラメータ callback=コールバック関数名 を指定する事により、javascript側コールバック関数の名前を指定できます。 | 初期値:xml。xml または json または jsonp。 |
- *1：複数可のパラメータの指定方法
name=value1&name=value2&...または name=value1,value2,...
サンプルクエリ
※実際にご利用いただくには新規登録をした上で、取得したご自身のAPIキーをGETパラメータに加えていただく必要があります。
レスポンスフィールド
| フィールド | 説明 | 例 |
|---|---|---|
| results | ||
| api_version | APIバージョン | 1.0 |
| results_available | クエリー条件にマッチする、検索結果の全件数 | 14 |
| results_returned | このXMLに含まれるアイテム数 | 10 |
| results_start | 検索結果の開始位置 | 1 |
| zone | 地域[複数要素] | |
| code | 地域コード | BC2 |
| name | 地域名 | 南太平洋ビーチ |
| ticket_count | この地域に行く航空券の件数 | 37 |
| area | エリア | |
| code | エリアコード | BCH |
| name | エリア名 | ビーチリゾート |
国マスタAPI
リクエストURL
検索クエリ
| パラメータ | 項目名 | 説明 | 必須 | 値 |
|---|---|---|---|---|
| key | APIキー | APIを利用するために割り当てられたキーを設定します。 | ○ | |
| area | エリアコード | 複数指定可能*1 | 例:EUR | |
| country | 国コード | 複数指定可能*1 | 例: BE | |
| keyword | フリーワード | 文字コードはUTF8。半角スペース区切りの文字列を渡すことでAND検索になる。複数指定可能*1 | 例: ベトナム | |
| in_use | 航空券の有無 | 1:そこに行く航空券が存在する国のみ返す(デフォルト)。0:航空券の存在有無に関係なく全件を返す。 | 1:有のみ(デフォルト)、0:全件 | |
| order | ソート順 | 検索結果の並び順を指定します。 | 0:コード順(デフォルト)、1:名前順 | |
| start | 検索の開始位置 | 検索結果の何件目から出力するかを指定します。 | 初期値:1 | |
| count | 1ページあたりの取得数 | 検索結果の最大出力データ数を指定します。 | 初期値：10、最小1、最大100 | |
| format | レスポンス形式 | レスポンスをXMLかJSONかJSONPかを指定します。JSONPの場合、さらにパラメータ callback=コールバック関数名 を指定する事により、javascript側コールバック関数の名前を指定できます。 | 初期値:xml。xml または json または jsonp。 |
- *1：複数可のパラメータの指定方法
name=value1&name=value2&...または name=value1,value2,...
サンプルクエリ
※実際にご利用いただくには新規登録をした上で、取得したご自身のAPIキーをGETパラメータに加えていただく必要があります。
レスポンスフィールド
| フィールド | 説明 | 例 |
|---|---|---|
| results | ||
| api_version | APIバージョン | 1.01 |
| results_available | クエリー条件にマッチする、検索結果の全件数 | 14 |
| results_returned | このXMLに含まれるアイテム数 | 10 |
| results_start | 検索結果の開始位置 | 1 |
| country | 国[複数要素] | |
| code | 国コード | IN |
| name | 国名 | インド |
| name_en | 国名の英語表記(未登録の場合、*が入る場合もあり。) | INDIA |
| ticket_count | この国に行く航空券の件数 | 37 |
| area | エリア | |
| code | エリアコード | AAS |
| name | エリア名 | アジア |
都市(空港)マスタAPI
リクエストURL
検索クエリ
| パラメータ | 項目名 | 説明 | 必須 | 値 |
|---|---|---|---|---|
| key | APIキー | APIを利用するために割り当てられたキーを設定します。 | ○ | |
| area | エリアコード | 複数指定可能*1 | 例:EUR | |
| country | 国コード | 複数指定可能*1 | 例: BE | |
| city | 都市(空港)コード | 複数指定可能*1 | 例: A10 | |
| tour_city | エービーロードのツアー都市コード | 複数指定可能*1 | 例: NYC | |
| zone | 地域コード | 複数指定可能*1 | 例: BC2 | |
| keyword | フリーワード | 文字コードはUTF-8。半角スペース区切りの複数の文字列を渡せます。複数指定可*2 | 例: ベトナム | |
| in_use | 航空券の有無 | 1:そこに行く航空券が存在する都市のみ返す(デフォルト)。0:航空券の存在有無に関係なく全件を返す。 | 例: 1 | |
| order | ソート順 | 検索結果の並び順指定 | 例: 0:国名＋都市名(デフォルト)、1:都市名 | |
| start | 検索の開始位置 | 検索結果の何件目から出力するかを指定します。 | 初期値:1 | |
| count | 1ページあたりの取得数 | 検索結果の最大出力データ数を指定します。 | 初期値：10、最小1、最大100 | |
| format | レスポンス形式 | レスポンスをXMLかJSONかJSONPかを指定します。JSONPの場合、さらにパラメータ callback=コールバック関数名 を指定する事により、javascript側コールバック関数の名前を指定できます。 | 初期値:xml。xml または json または jsonp。 |
- *1：複数可のパラメータの指定方法
name=value1&name=value2&...または name=value1,value2,...
サンプルクエリ
※実際にご利用いただくには新規登録をした上で、取得したご自身のAPIキーをGETパラメータに加えていただく必要があります。
レスポンスフィールド
| フィールド | 説明 | 例 |
|---|---|---|
| results | ||
| api_version | APIバージョン | 1.0 |
| results_available | クエリー条件にマッチする、検索結果の全件数 | 14 |
| results_returned | このXMLに含まれるアイテム数 | 10 |
| results_start | 検索結果の開始位置 | 1 |
| city | 都市(空港)[複数要素] | |
| code | 都市(空港)コード | ELS |
| name | 都市(空港)名 | イーストロンドン |
| ticket_count | この都市に行く航空券の件数 | 37 |
| tour_city | エービーロードツアーの都市[複数要素] | |
| code | エービーロードツアーの都市コード | D17 |
| name | エービーロードツアーの都市名 | カナディアンロッキー |
| area | エリア | |
| code | エリアコード | CAF |
| name | エリア名 | アフリカ・他 |
| country | 国 | |
| code | 国コード | ZA |
| name | 国名 | 南アフリカ |
| name_en | 国名の英語表記 | SOUTH AFRICA |
| zone | 地域 | |
| code | 地域コード | BC2 |
| name | 地域名 | 南太平洋ビーチ |
出発地詳細マスタAPI
リクエストURL
検索クエリ
| パラメータ | 項目名 | 説明 | 必須 | 値 |
|---|---|---|---|---|
| key | APIキー | APIを利用するために割り当てられたキーを設定します。 | ○ | |
| dept_detail | 出発地詳細コード | 複数指定可能*1 | 例: NRT | |
| dept | 出発地コード | TYO:東京、OSA:大阪、NGO:名古屋、FUK:福岡、999:その他。複数指定可能*1 | 例: TYO | |
| in_use | 航空券の有無 | 1:この出発地からの航空券が存在する場合のみ返す(デフォルト)。0:航空券の存在有無に関係なく全件を返す。 | 例: 1 | |
| start | 検索の開始位置 | 検索結果の何件目から出力するかを指定します。 | 初期値:1 | |
| count | 1ページあたりの取得数 | 検索結果の最大出力データ数を指定します。 | 初期値：10、最小1、最大100 | |
| format | レスポンス形式 | レスポンスをXMLかJSONかJSONPかを指定します。JSONPの場合、さらにパラメータ callback=コールバック関数名 を指定する事により、javascript側コールバック関数の名前を指定できます。 | 初期値:xml。xml または json または jsonp。 |
- *1：複数可のパラメータの指定方法
name=value1&name=value2&...または name=value1,value2,...
サンプルクエリ
※実際にご利用いただくには新規登録をした上で、取得したご自身のAPIキーをGETパラメータに加えていただく必要があります。
レスポンスフィールド
| フィールド | 説明 | 例 |
|---|---|---|
| results | ||
| api_version | APIバージョン | 1.0 |
| results_available | クエリー条件にマッチする、検索結果の全件数 | 14 |
| results_returned | このXMLに含まれるアイテム数 | 10 |
| results_start | 検索結果の開始位置 | 1 |
| dept_detail | 出発地詳細[複数要素] | |
| code | 出発地詳細コード | NRT |
| name | 出発地詳細名 | 成田 |
| ticket_count | この出発地から出発する航空券の件数 | 37 |
| dept | 出発地 | |
| code | 出発地コード | TYO |
| name | 出発地名 | 東京 |
航空会社マスタAPI
リクエストURL
検索クエリ
| パラメータ | 項目名 | 説明 | 必須 | 値 |
|---|---|---|---|---|
| key | APIキー | APIを利用するために割り当てられたキーを設定します。 | ○ | |
| airline | 航空会社コード | 複数指定可能*1 | 例: XX | |
| keyword | フリーワード | 文字コードはUTF8。半角スペース区切りの文字列を渡すことでAND検索になる。複数指定可能*1 | 例: スペイン | |
| start | 検索の開始位置 | 検索結果の何件目から出力するかを指定します。 | 初期値:1 | |
| count | 1ページあたりの取得数 | 検索結果の最大出力データ数を指定します。 | 初期値：10、最小1、最大100 | |
| format | レスポンス形式 | レスポンスをXMLかJSONかJSONPかを指定します。JSONPの場合、さらにパラメータ callback=コールバック関数名 を指定する事により、javascript側コールバック関数の名前を指定できます。 | 初期値:xml。xml または json または jsonp。 |
- *1：複数可のパラメータの指定方法
name=value1&name=value2&...または name=value1,value2,...
サンプルクエリ
※実際にご利用いただくには新規登録をした上で、取得したご自身のAPIキーをGETパラメータに加えていただく必要があります。
レスポンスフィールド
| フィールド | 説明 | 例 |
|---|---|---|
| results | ||
| api_version | APIバージョン | 1.0 |
| results_available | クエリー条件にマッチする、検索結果の全件数 | 14 |
| results_returned | このXMLに含まれるアイテム数 | 10 |
| results_start | 検索結果の開始位置 | 1 |
| airline | 航空会社名[複数要素] | |
| code | 航空会社コード | XX |
| name | 航空会社名 | 世界航空 |
こだわりマスタAPI
リクエストURL
検索クエリ
| パラメータ | 項目名 | 説明 | 必須 | 値 |
|---|---|---|---|---|
| key | APIキー | APIを利用するために割り当てられたキーを設定します。 | ○ | |
| format | レスポンス形式 | レスポンスをXMLかJSONかJSONPかを指定します。JSONPの場合、さらにパラメータ callback=コールバック関数名 を指定する事により、javascript側コールバック関数の名前を指定できます。 | 初期値:xml。xml または json または jsonp。 |
- *1：複数可のパラメータの指定方法
name=value1&name=value2&...または name=value1,value2,...
サンプルクエリ
※実際にご利用いただくには新規登録をした上で、取得したご自身のAPIキーをGETパラメータに加えていただく必要があります。
レスポンスフィールド
| フィールド | 説明 | 例 |
|---|---|---|
| results | ||
| api_version | APIバージョン | 1.0 |
| results_available | クエリー条件にマッチする、検索結果の全件数 | 14 |
| results_returned | このXMLに含まれるアイテム数 | 10 |
| results_start | 検索結果の開始位置 | 1 |
| kodaw | こだわり[複数要素] | |
| code | こだわりコード | 1 |
| name | こだわり | オンライン予約可 |
![[9]](/common/images/ref-num9.gif)
エラー時のレスポンス
<?xml version="1.0" encoding="UTF-8"?>
<results xmlns="http://webservice.recruit.co.jp/ab-road-air/">
<api_version>1.00</api_version>
<error>
<message>keyは必須パラメーターです</message>
</error>
</results>
エラーの際でも、HTTPレスポンスステータスは常に "200 OK" が返ります。実装側では常にレスポンスXMLの内容を見てエラー判断を行ってください。
![[10]](../common/images/ref-num10.gif)
Flashからの利用方法
Flash Action Script 2.0にて本APIを利用するには1フレーム目に下記の記述を追加する必要があります:
System.security.loadPolicyFile("http://webservice.recruit.co.jp/ab-road-air/crossdomain.xml");
このように crossdomain.xml を指定する事で、ご自身のサイト上にある Flash SWF ファイルから、本APIを利用することが可能になります。
