リクエストパラメータで指定される検索条件を元に店舗データベースを検索し、該当する店舗データを返却します。
出力データのコンテントタイプは、outfパラメータの指定に応じてapplication/jsonまたはtext/xmlとなります。
Content-type: application/json または Content-type: text/xml
店舗条件検索の検索結果は、outfパラメータの指定に応じてJSONまたはXMLが「HTTPレスポンスボディ」に設定、返却されます。
XML返却時、「HTTPレスポンスボディ」の全体は、<store_select></store_select>で定義されます。
「HTTPレスポンスボディ」は、「ステータス部」と「検索データ部」で構成されます。更に、「検索データ部」は検索結果の行数分の「検索データ」で構成されます。
以下に出力データの構成イメージを示します。
{ "return_code":"y0300000", "rec_count":"1", "hit_count":"1", "store_list": [ { "store_id":"A0001", "lat":"128411880", "lon":"503149370", "new":"0", "icon_url":"http://(domain)/cgi/icon_select.cgi?cid=99999999&icon_id=101", "img_url":"http://(domain)/cgi/gif_select.cgi?cid=99999999&kid=A0001", "content": [ {"col":"NAME","name":"店舗名","type":"TEXT","text":"汐留支店"}, {"col":"COL_05","name":"店舗種別","type":"CODE","code":"02","text":"支店"}, {"col":"ADDR","name":"住所","type":"TEXT","text":"東京都港区東新橋1-6-1"}, {"col":"COL_02","name":"電話番号","type":"TEXT","text":"03-0000-0000"}, {"col":"COL_06","name":"禁煙","type":"FLAG","flag":"1","text":"禁煙"}, {"col":"COL_07","name":"分煙","type":"FLAG","flag":"0","text":""} ], "rd": { "group_count":"3", "group_list": [ { "group_id":"1", "item_count":"5", "item_list": [ {"item_id":"1","type":"TEXT","text":"期間限定クーポン!"}, {"item_id":"2","type":"IMG", "img_url":"http://(domain)/cgi/rd_img.cgi?cid=999999&kid=A0001&grp=1&itm=2", "img_w":"320","img_h":"180"}, {"item_id":"4","type":"FLAG","flag":"1","text":"人数制限あり"}, ... ] }, ... ] } }, ] }
(注)"rd":{}はリアルタイムデータをご契約いいただいている場合だけ出力されます。
<store_select> <status> <return_code>y0300000</return_code> <rec_count>1</rec_count> <hit_count>1</hit_count> </status> <store_list> <item id="1"> <store_id>A0001</store_id> <lat>128399440</lat> <lon>503131830</lon> <new>0</new> <icon_url>http://(domain)/cgi/icon_select.cgi?cid=99999999&icon_id=101</icon_url> <img_url>http://(domain)/cgi/gif_select.cgi?cid=99999999&kid=A0001</img_url> <content> <col id="item1_NAME"> <name>店舗名</name><type>TEXT</type> <text>汐留支店</text> </col> <col id="item1_COL_05"> <name>店舗種別</name><type>CODE</type> <code>02</code><text>支店</text> </col> <col id="item1_ADDR"> <name>住所</name><type>TEXT</type> <text>東京都港区東新橋1-6-1</text> </col> <col id="item1_COL_02"> <name>電話番号</name><type>TEXT</type> <text>03-0000-0000</text> </col> <col id="item1_COL_06"> <name>禁煙</name><type>FLAG</type> <flag>1</flag><text>禁煙</text> </col> <col id="item1_COL_07"> <name>分煙</name><type>FLAG</type> <flag>0</flag><text></text> </col> </content> <rd> <group_count>3</group_count> <group_list> <group id="1"> <group_id>1</group_id> <item_count>5</item_count> <item_list> <item id="1"> <item_id>1</item_id> <type>TEXT</type> <text>期間限定クーポン!</text> </item> <item id="2"> <item_id>2</item_id> <type>IMG</type> <img_url>http://(domain)/cgi/rd_img.cgi?cid=999999&kid=A0001&grp=1&itm=2 </img_url> <img_w>320</img_w> <img_h>180</img_h> </item> <item id="3"> <item_id>4</item_id> <type>FLAG</type> <flag>1</flag> <text>人数制限あり</text> </item> ... </item_list> </group> ... </group_list> </rd> </item> ... </store_list> </store_select>
(注)<rd>〜</rd>はリアルタイムデータをご契約いいただいている場合だけ出力されます。
ステータス部のフォーマットを以下に示します。
"return_code":"リターンコード", "rec_count":"取得レコード数", "hit_count":"ヒット件数",
ステータス部の全体は、<status> </status> で定義されます。
<status> <return_code>リターンコード</return_code> <rec_count>取得レコード数</rec_count> <hit_count>ヒット件数</hit_count> </status>
リターンコード | データ型:C8 入力に対し、一致するデータがあったかどうかを示します。出力されるリターンコードは以下の通りです。
| ||||||||||
取得レコード数 | データ型:VC8 入力された条件に対し、取得したレコード数を示します。 リターンコードが「y0300000」以外の場合、本フィールドには「0」が設定されます。 | ||||||||||
ヒット件数 | データ型:VC8 入力された条件に対し、ヒットしたレコード件数の総数を示します。 リターンコードが「y0300000」以外の場合、本フィールドには「0」が設定されます。 |
検索データ部のフォーマットを以下に示します。
尚、検索データ部はリターンコードが「y0300000」の場合のみ返却されます。
"store_list": [ { "store_id":"店舗ID", "lat":"緯度", "lon":"経度", "distance":"距離", "new":"NEW表示期間フラグ", "icon_url":"店舗アイコン画像URL", "img_url":"店舗画像URL", "content": [ {"col":"項目ID","name":"項目名","type":"型","text":"テキスト"}, {"col":"項目ID","name":"項目名","type":"型","code":"コード","text":"テキスト"}, {"col":"項目ID","name":"項目名","type":"型","flag":"フラグ","text":"テキスト"}, ... ], "rd": { "group_count":"グループ数(RD)", "group_list": [ { "group_id":"グループID(RD)", "item_count":"項目数(RD)", "item_list": [ {"item_id":"項目ID(RD)","type":"型(RD)","text":"テキスト(RD)"}, {"item_id":"項目ID(RD)","type":"型(RD)", "img_url":"画像URL(RD)", "img_w":"画像幅(ピクセル)(RD)","img_h":"画像高さ(ピクセル)(RD)"}, {"item_id":"項目ID(RD)","type":"型(RD)", "flag":"フラグ(RD)","text":"テキスト(RD)"}, ... ] }, ... ] } }, ... ]
(注)"rd":{}はリアルタイムデータをご契約いいただいている場合だけ出力されます。
検索データ部の全体は、<store_list></store_list>で定義されます。
<store_list> <item id="1"> <store_id>店舗ID</store_id> <lat>緯度</lat> <lon>経度</lon> <distance>距離</distance> <new>NEW表示期間フラグ</new> <icon_url>店舗アイコン画像URL<icon_url> <img_url>店舗画像URL</img_url> <content> <col id="item1_項目ID"> <name>項目名</name><type>型</type><text>テキスト</text> </col> <col id="item1_項目ID"> <name>項目名</name><type>型</type><code>コード</code><text>テキスト</text> </col> <col id="item1_項目ID"> <name>項目名</name><type>型</type><flag>フラグ</flag><text>テキスト</text> </col> ... </content> <rd> <group_count>グループ数(RD)</rd_count> <group_list> <group id="1"> <group_id>グループID(RD)</group_id> <item_count>項目数(RD)</item_count> <item_list> <item id="1"> <item_id>項目ID(RD)</item_id> <type>型(RD)</type><text>テキスト(RD)</text> </item> <item id="2"> <item_id>項目ID(RD)</item_id> <type>型(RD)</type><img_url>画像URL(RD)</img_url> <img_w>画像幅(ピクセル)(RD)</img_w><img_h>画像高さ(ピクセル)(RD)</img_h> </item> <item id="3"> <item_id>項目ID(RD)</item_id> <type>型(RD)</type><flag>フラグ(RD)</flag><text>テキスト(RD)</text> </item> ... </item_list> </group> ... </group_list> </rd> </item> ... </store_list>
(注)<rd>〜</rd>はリアルタイムデータをご契約いいただいている場合だけ出力されます。
店舗ID | データ型:VC15 該当店舗の店舗コードを返却します。 | ||||||
緯度 | データ型:VC9〜13(pflgパラメータによる) 該当店舗の緯度を返却します。表記形式は入力パラメータのポイントフラグ(pflg)で指定した形式となります。 | ||||||
経度 | データ型:VC9〜13(pflgパラメータによる) 該当店舗の経度を返却します。表記形式は入力パラメータのポイントフラグ(pflg)で指定した形式となります。 | ||||||
NEW表示期間 フラグ |
データ型:C1 店舗データのNEW表示期間が設定されている場合、現在日時が期間内かどうかを返却します。 NEW表示期間が未設定の場合は、常に0(期間外)を返却します。
| ||||||
店舗アイコン画像 URL |
データ型:VC100 店舗アイコン画像のURLを返却します。 ※URIスキーム(プロトコル)はhttp固定で返却します。httpsで参照したい場合は、返却値の’http:’を’https:’に置換して使用してください。 | ||||||
店舗画像URL | データ型:VC100 該当店舗に店舗画像が登録されている場合、店舗画像のURLを返却します。 ※URIスキーム(プロトコル)はhttp固定で返却します。httpsで参照したい場合は、返却値の’http:’を’https:’に置換して使用してください。 | ||||||
項目ID | データ型:VC7 該当項目の項目IDを返却します。
| ||||||
項目名 | データ型:VC100 該当項目の項目名を返却します。 | ||||||
型 | データ型:C4 該当項目の型を返却します。
| ||||||
テキスト | データ型:VC4000 該当項目のテキスト値を返却します。区分項目の場合、コードに対応するテキスト値を返却します。フラグ項目の場合、1の場合は項目名を、0の場合は空白値を返却します。 | ||||||
コード | データ型:VC10 該当項目のコード値を返却します。(区分項目の場合のみ) | ||||||
フラグ | データ型:C1 該当項目のフラグ値(0/1)を返却します。(フラグ項目の場合のみ) | ||||||
グループ数 (RD) |
データ型:VC1〜3 該当店舗に登録されているリアルタイムデータのグループ数を返却します。 ※リアルタイムデータをご契約いただいている場合だけ返却されます。 | ||||||
グループID (RD) |
データ型:VC1〜5 該当グループのグループIDを返却します。 ※リアルタイムデータをご契約いただいている場合だけ返却されます。 | ||||||
項目数(RD) | データ型:VC1〜3 該当グループに登録されているリアルタイムデータの項目数を返却します。 ※リアルタイムデータをご契約いただいている場合だけ返却されます。 | ||||||
項目ID(RD) | データ型:VC1〜5 該当項目の項目IDを返却します。 ※リアルタイムデータをご契約いただいている場合だけ返却されます。 | ||||||
型(RD) | データ型:VC1〜4 該当項目の型を返却します。 ※リアルタイムデータをご契約いただいている場合だけ返却されます。
| ||||||
テキスト(RD) | データ型:VC4000 該当項目のテキスト値を返却します。フラグ項目の場合、1の場合は項目名を、0の場合は空白値を返却します。(テキスト項目およびフラグ項目の場合のみ) ※リアルタイムデータをご契約いただいている場合だけ返却されます。 | ||||||
画像URL(RD) | データ型:VC100 該当項目の画像URLを返却します。(画像項目の場合のみ) ※URIスキーム(プロトコル)はhttp固定で返却します。httpsで参照したい場合は、返却値の’http:’を’https:’に置換して使用してください。 ※リアルタイムデータをご契約いただいている場合だけ返却されます。 | ||||||
画像幅(ピクセル) (RD) |
データ型:VC1〜4 該当項目の画像幅(ピクセル)を返却します。(画像項目の場合のみ) ※リアルタイムデータをご契約いただいている場合だけ返却されます。 | ||||||
画像高さ (ピクセル)(RD) |
データ型:VC1〜4 該当項目の画像高さ(ピクセル)を返却します。(画像項目の場合のみ) ※リアルタイムデータをご契約いただいている場合だけ返却されます。 | ||||||
フラグ(RD) | データ型:C1 該当項目のフラグ値(0/1)を返却します。(フラグ項目の場合のみ) ※リアルタイムデータをご契約いただいている場合だけ返却されます。 |