お知らせ番号を指定し、店舗・店舗スタッフの閲覧状況 を CSV ファイルで取得します。
外部のポータルに、お知らせごとの閲覧状況を表示させることができます。
呼び出し先URL
{your-domain} の部分をご利用の環境にあわせて変更してください。
https://{your-domain}/h2/STRNoticeFinder.doリクエスト
API で返される結果は すべて非同期 です。
呼び出し時点の 5分以内のデータであることは保証 しますが、最新の状態でない可能性があります。
| パラメータ名 | 意味 | 必須 | 制約 |
|---|---|---|---|
func | 動作モード | 〇 | 既読状況を取得したい対象の値を指定します。getReadStatusOfStore : 店舗getReadStatusOfStoreManager : 店長getReadStatusOfAssistantManager : 副店長getReadStatusOfAllStaff : すべてのスタッフgetReadStatusOfJoiningFc : FC法人 |
key | WebAPIキー | 〇 | お知らせ操作APIが利用可能な WebAPIキーを指定します。 |
id | お知らせのNo. | 〇 | お知らせの No. を指定します。 |
showDisabled | 無効の店舗・スタッフも対象に含める | 無効となった店舗・スタッフも対象に含めるか指定できます。 以下の値をとります。 1 : 含める0 : 含めない（デフォルト） | |
locale | ロケール言語 | CSV のヘッダー、店舗名などが国際化されているときに、指定したロケールの言語で CSV を生成します。 以下の値をとります。 ja_JP : 日本語en_US : 英語zh_CN : 中国語 |
レスポンス
API の呼び出し結果は、CSVファイル として返されます。
| 列名 | 備考 |
|---|---|
| スタッフコード | 店長・副店長・すべてのスタッフの閲覧状況を取得する場合に返されます。 |
| 名前 | 店長・副店長・すべてのスタッフの閲覧状況を取得する場合に返されます。 |
| 店舗コード/法人コード | |
| 店舗名/法人名 | |
| 店長 | 店舗の閲覧状況を取得する場合に返されます。 |
| 電話番号 | |
| FAX番号 | |
| メールアドレス | |
| 閲覧した日時 | yyyy-MM-dd HH:mm:ss 形式で返されます。補足事項 未読の場合は空欄となります。 |