【更新履歴】
2009/07/13
1. 検索方法
下記URLへ必要なGETパラメータを付与しアクセスすることでXML情報を返却します。
http://xml.accesstrade.net/at/ws.html
2. 必須パラメータ
| パラメータ | 値 | 備考 |
|---|---|---|
| ws_type | searchreserve_atm | APIタイプ。通常は固定値です。 |
| ws_ver | 1 | バージョン。通常は固定値です。 |
| ws_id | ＊＊ | 管理画面で取得したWS_ID |
| category | ＊＊ | 100～500のいずれかの指定が必要です。 |
3. 必須条件（カテゴリー）
| カテゴリID | カテゴリー名 |
|---|---|
| 400 | ホテル・旅館 |
4. 任意パラメータ
| パラメータ名 | パラメータ | 設定例 | 備考 |
|---|---|---|---|
| item_id | 商品ID | 278802-1 | カンマ区切りで複数指定可能 |
| program_id | プログラムID | 3459 | カンマ区切りで複数指定可能 |
| keyword | 検索キーワード | "新宿 ホテル"⇒%E6%96%B0%E5%AE%BF%E3%80%80%E3%83%9B%E3%83%86%E3%83%AB | UTF-8でエンコード。複数指定はスペース区切り。 |
| item_code | 商品番号 | 1 | 複数指定不可,通常はitem_idを使用します。 |
| area_large | エリア大 | "関東"⇒%E9%96%A2%E6%9D%B1 | UTF-8エンコード |
| area_mid | エリア中 | "東京"⇒%E6%9D%B1%E4%BA%AC | UTF-8エンコード |
| area_small | エリア小 | "池袋"⇒%E6%B1%A0%E8%A2%8B | UTF-8エンコード |
| budget_min | 予算下限（円） | 3000 | 整数値 > 0 |
| budget_max | 予算上限（円） | 7000 | 整数値 > 0 |
| campaign | キャンペーン | 1 | 0:なし，1:あり，指定なし：すべて |
| row | 1ページ内件数 | 5 | 1～30の範囲で指定可能。整数値指定。 |
| page | 指定ページ | 2 | 2ページ目以降の明細を取得する際に指定。指定なしの場合は1ページが表示される。 |
| sort | ソート | 1 | 整数値指定 ※ソート一覧参照 |
| carrier | キャリア | 111 | 整数値指定。左桁より，docomo,kddi,softbank 1:対応,0:非対応 |
| latitude | 緯度 | 35.689425 | degree形式で指定，世界測地（wgs84） |
| longitude | 経度 | 139.6968 | degree形式で指定，世界測地（wgs84） |
| range | 範囲 | 2 | 1：300M 2：600M 3：1200M 4：1500M 5：3000M ※デフォルトは1：300M |
| station | 駅 | "池袋"⇒%E6%B1%A0%E8%A2%8B | UTF-8エンコード |
5. 出力項目
| パラメータ名 | 設定値 | 内容 |
|---|---|---|
| AllResult | - | 検索結果タグ |
| Request | - | 入力パラメータの結果タグ |
| ws_type | searchreserve_atm | サービスタイプ（固定値：必須） |
| ws_ver | 1 | サービスバージョン（固定値：必須） |
| ws_id | 入力値 | パートナーID（WS_ID：必須） |
| item_id | 入力値 | 一意なKEY |
| category | 入力値 | カテゴリ（※カテゴリ一覧参照）必須 |
| program_id | 入力値 | プログラムID |
| keyword | 入力値 | キーワード |
| item_code | 入力値 | 商品コード |
| area_large | 入力値 | エリア大 |
| area_mid | 入力値 | エリア中 |
| area_small | 入力値 | エリア小 |
| food_genre | 入力値 | 大小業態 |
| budget_min | 入力値 | 予算下限 |
| budget_max | 入力値 | 予算上限 |
| campaign | 入力値 | キャンペーン |
| carrier | 入力値 | キャリア |
| latitude | 入力値 | 緯度 |
| longitude | 入力値 | 経度 |
| range | 入力値 | 範囲 |
| station | 入力値 | 駅 |
| row | 入力値 | |
| page | 入力値 | |
| sort | 入力値 | |
| TotalCount | 検索結果の数 | |
| TotalPage | 検索結果の総ページ数 | |
| CurrentCount | 現在のページに含まれる検索数 | |
| CurrentPage | 現在のページ | |
| ErrorCode | エラーコード | |
| ErrorMsg | エラーメッセージ | エラーがあればメッセージが表示される。 |
| Reserve | - | 予約タグ（データ1件分） |
| ItemId | 検索結果 | 商品ID（ユニークキー） |
| ItemName | 検索結果 | 商品名・店舗名 |
| ItemCode | 検索結果 | 商品コード |
| ProgramId | 検索結果 | プログラムID |
| CorpName | 検索結果 | サービス名 |
| Category | 検索結果 | カテゴリID（※詳細はカテゴリ一覧参照） |
| CategoryName | 検索結果 | カテゴリ名（※詳細はカテゴリ一覧参照） |
| AreaLarge | 検索結果 | 大エリア |
| AreaMid | 検索結果 | 中エリア |
| AreaSmall | 検索結果 | 小エリア |
| Latitude | 検索結果 | 緯度 |
| LongItude | 検索結果 | 経度 |
| Coupon | 検索結果 | クーポン |
| Term | 検索結果 | 期間 |
| StartTerm | 検索結果 | 開始時間 |
| EndTerm | 検索結果 | 終了時間 |
| Budget | 検索結果 | 料金（予算） |
| BudgetAvg | 検索結果 | 平均（検索）料金 |
| Capacity | 検索結果 | 定員（席数） |
| ImageUrl1 | 検索結果 | 画像URL1 |
| Width1 | 検索結果 | 横サイズ1 |
| Height1 | 検索結果 | 縦サイズ1 |
| ImageUrl2 | 検索結果 | 画像URL2 |
| Width2 | 検索結果 | 横サイズ2 |
| Height2 | 検索結果 | 縦サイズ2 |
| ImageUrl3 | 検索結果 | 画像URL3 |
| Width3 | 検索結果 | 横サイズ3 |
| Height3 | 検索結果 | 縦サイズ3 |
| LinkCode |
検索結果 | ３キャリア共通リンクコード（docomo,au,softbank対応） |
| LinkCode_I | 検索結果 | 商品リンクコード（docomo対応） |
| LinkCode_E | 検索結果 | 商品リンクコード（kddi対応） |
| LinkCode_S | 検索結果 | 商品リンクコード（softbank対応） |
| Carrier_I | 検索結果 | キャリア対応(0 or 1)（docomo） |
| Carrier_E | 検索結果 | キャリア対応(0 or 1)（kddi） |
| Carrier_S | 検索結果 | キャリア対応(0 or 1)（softbank） |
| Campaign | 検索結果 | キャンペーン |
| Meal | 検索結果 | 食事 |
| CheckIn | 検索結果 | チェックイン |
| CheckOut | 検索結果 | チェックアウト |
| Style | 検索結果 | 様式 |
| Plan | 検索結果 | プラン |
| Access | 検索結果 | アクセス |
| ReserveSystem | 検索結果 | 予約方法 |
| Contact | 検索結果 | お問合せ |
| CatchCopy | 検索結果 | キャッチコピー |
| Description | 検索結果 | 特徴 |
| Postcode | 検索結果 | 郵便番号 |
| Address | 検索結果 | 所在地 |
| Tel | 検索結果 | 電話番号 |
| RewardType | 検索結果 | 報酬タイプ（0：クリック、1：定額、2：売上） |
| RewardRate | 検索結果 | 報酬率 |
| Reward | 検索結果 | 報酬額 |
| Remark | 検索結果 | 備考 |
| Status | 検索結果 | 提携状態(2固定。提携中の商品のみが表示されます。) |
| Formal | 検索結果 | 公式-勝手(0:公式,1:勝手) |
- レスポンスデータには，未入力の項目もありますので事前に取得した結果を確認してください。
6. 検索例
ws_idは管理画面で取得されたws_idに置き換えてください。
■ カテゴリー：ホテル・旅館，エリア中：東京，エリア小：池袋で宿を探す。
http://xml.accesstrade.net/at/ws.html?ws_ver=1&ws_type=searchreserve_atm&ws_id=****&category=400&area_mid=%E6%9D%B1%E4%BA%AC&area_small=%E6%B1%A0%E8%A2%8B
■ カテゴリー：ホテル・旅館，エリア中：東京，エリア小：池袋，予算上限:7000で宿を探す。
http://xml.accesstrade.net/at/ws.html?ws_ver=1&ws_type=searchreserve_atm&ws_id=****&category=400&area_mid=%E6%9D%B1%E4%BA%AC&area_small=%E6%B1%A0%E8%A2%8B&budget_max=7000
■ カテゴリー：ホテル・旅館，エリア小：新宿で料金の安い順で探す。
http://xml.accesstrade.net/at/ws.html?ws_ver=1&ws_type=searchreserve_atm&ws_id=****&category=400&area_small=%E6%96%B0%E5%AE%BF&sort=3
■ カテゴリー：ホテル・旅館，緯度：35.683047，経度：139.686935の地点から周範囲：1200M（概算）以内にある宿を探す。
http://xml.accesstrade.net/at/ws.html?ws_ver=1&ws_type=searchreserve_atm&ws_id=****&category=400&latitude=35.683047&longitude=139.686935&range=3