呼び出し時点における、すべての店舗・店舗スタッフの未読お知らせ件数をCSVファイルで一括取得します。
外部ポータルに、店舗・店舗スタッフごとの未読お知らせ件数を表示できます。
呼び出し先URL
{your-domain} の部分は、ご利用の環境に合わせて変更してください。
https://{your-domain}/h2/STRNoticeFinder.doリクエスト
未読お知らせ件数の一括取得APIで返される結果は、すべて非同期です。
呼び出し時点から 5分以内のデータ であることは保証されますが、最新状態ではない場合があります。
| パラメータ名 | 意味 | 必須 | 制約 |
|---|---|---|---|
| func | 動作モード | 〇 | 必ず getNumUnreadEntire を指定します。 |
| key | WebAPIキー | 〇 | お知らせ操作APIが利用可能なWebAPIキーを指定します。 |
| days | 未読をカウントする日数 | 1～7 の値を指定します。前日から公開されたお知らせのうち、未読件数を取得する場合は 1 を指定します。前々日からの場合は 2 を指定します。ℹ 補足：店舗トップページでは、本日公開したお知らせに加えて、過去7日間の未読お知らせを表示します。パラメータを省略した場合は、過去7日間の未読お知らせ件数を取得します。 | |
| target | 取得対象の店舗・店舗スタッフ | 店舗スタッフ機能を利用している場合に指定します。store：店舗の行のみ返します。staff：店舗スタッフの行のみ返します。ℹ 補足：パラメータを省略した場合は、店舗と店舗スタッフの両方の行を返します。 |
レスポンス
APIの呼び出し結果は、次の形式のCSVファイルとして返されます。
CSVファイルの1行目には列名が含まれます。
⚠ 注意：将来的に項目が追加される可能性があります。
CSVファイルをパースする処理では、列数や列順を固定せず、1行目の列名をもとに対応する値を各行から読み取るようにしてください。
| 列名 | 意味 | 備考 |
|---|---|---|
| storeCode | 店舗コード | 店舗コードが出力されます。 店舗スタッフ機能を利用している場合は、店舗スタッフが所属する店舗コードが出力されます。 |
| staffCode | 店舗スタッフコード | 店舗スタッフ機能を利用している場合に、店舗スタッフコードが出力されます。 ℹ 補足：複数店舗に所属する店舗スタッフは、 storeCode と staffCode の組み合わせが、所属する店舗数分出力されます。ℹ 補足：店舗の行では空欄になります。 |
| numTotal | 既読を含むトータルのお知らせ件数 | 店舗・店舗スタッフのトップページに表示されているお知らせのうち、days 日以内の公開日のお知らせ総件数です。 |
| numUnread | 未読お知らせ件数 | 店舗・店舗スタッフのトップページに表示されているお知らせのうち、days 日以内の公開日のお知らせについて、未読件数を返します。 |
| critical | 重要度が緊急のお知らせのうち未読件数 | |
| important | 重要度が重要のお知らせのうち未読件数 | |
| normal | 重要度が通常のお知らせのうち未読件数 | |
| lastmodified | 既読を含めた、店舗・店舗スタッフで閲覧可能なすべてのお知らせのうち最新の最終更新日 | numTotal に含まれるお知らせのうち、最新の最終更新日が yyyy-MM-dd HH:mm:ss 形式のUTC時刻で返されます。トータル件数が 0 の場合は空欄になります。 |