リクエストパラメータで指定される検索条件を元に店舗データベースを検索し、該当する店舗データを返却します。
CGIへ通知するリクエストパラメータについて説明します。
cid | 企業ID ※必須項目 取得したい店舗データの企業IDを指定します。本項目は必須項目であるため、未指定の場合はエラーとなります。 | ||||||
freeword | フリーワード 検索したいフリーワードを指定します。 複数のフリーワードを指定する場合は、’東京 有楽町’のように、半角/全角スペースで区切って指定してください。半角/全角スペースは混在可能です。 複数指定されたフリーワードは、AND条件となります。 encパラメータに指定した文字コードの文字をURLエンコードして指定してください。 (例)「新宿 南口」をUTF-8で指定 freeword=%E6%96%B0%E5%AE%BF%20%E5%8D%97%E5%8F%A3 | ||||||
filter | 絞り込み条件 絞り込み検索条件を指定します。絞り込み条件に使用できる項目は「区分項目」と「フラグ項目」です。 「項目ID:値」の書式で条件を指定します。(例 'COL_01:101') ※項目IDは、弊社より別途お知らせいたします。 複数の条件を指定する場合は、' AND 'または' OR 'で連結し、必要に応じて'( )'で優先順位を指定してください。 (例)'COL_01:101 AND (COL_02:1 OR COL_03:1)' ※実際はURLエンコードして下記のように指定してください。 filter=COL_01%3A101%20AND%20%28COL_02%3A1%20OR%20COL_03%3A1%29 | ||||||
pos | 取得開始位置 該当するデータの取得開始位置を指定します。 デフォルト値:1 | ||||||
cnt | 取得件数 取得したいデータ件数を指定します。1〜1000の範囲で指定することが可能です。 デフォルト値:100 | ||||||
sort | ソート順 出力データのソート順を指定します。未指定の場合、店舗IDのみでソートされます。 複数のソート項目を指定する場合は、半角カンマで区切って、優先度順に指定してください。 ※項目IDは、弊社より別途お知らせいたします。 (例)sort=COL_01,COL_02,NAME | ||||||
enc | 文字コード 入出力データの文字コードを指定します。以下のいずれか1つの文字列を指定することができます。 デフォルト値:UTF8
| ||||||
pflg | ポイントフラグ 出力緯度経度の表記形式を指定します。以下のいずれか1つの番号を指定して下さい。 デフォルト値:2
| ||||||
datum | 測地系 出力緯度経度の測地系を指定します。以下のいずれか1つの文字列を指定して下さい。 デフォルト値:TOKYO
| ||||||
outf | 出力形式 出力データの形式を指定して下さい。 デフォルト値:JSON
|