店舗ごとのセッションで、店舗トップページに表示されているお知らせのうち、未読件数を取得します。
外部ポータルに、店舗の未読件数を表示できます。
呼び出し先URL
{your-domain} の部分は、ご利用の環境に合わせて変更してください。
https://{your-domain}/h2/STRNoticeFinder.doリクエスト
未読お知らせ件数APIの呼び出し回数に制限はありません。
ただし、セッション操作APIには呼び出し回数の制限があるため、ポーリングする場合は、セッション操作APIで取得したセッションキーをキャッシュして使い回してください。
| パラメータ名 | 意味 | 必須 | 制約 |
|---|---|---|---|
| func | 動作モード | 〇 | 必ず getNumUnread を指定します。 |
| key | WebAPIキー | 〇 | お知らせ操作APIが利用可能なWebAPIキーを指定します。 |
| sessionKey | 対象となる店舗、店舗スタッフのセッションキー | 〇 | セッション操作APIで生成した有効なセッションキーを指定します。 |
| days | 未読をカウントする日数 | 1～7 の値を指定します。前日から公開されたお知らせのうち未読件数を取得する場合は 1 を指定します。前々日からの場合は 2 を指定します。ℹ 補足：店舗トップページでは、本日公開したお知らせに加えて、過去7日間の未読お知らせを表示します。パラメータを省略した場合は、過去7日間の未読お知らせ件数を取得します。 |
レスポンス
APIの呼び出し結果は、次のスキーマのXML文書として返されます。
<?xml version="1.0"?>
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<xsd:element name="response">
<xsd:sequence>
<xsd:element name="result" type="xsd:int" minOccurs="1" maxOccurs="1" />
<xsd:element name="errors" type="xsd:string" minOccurs="0" maxOccurs="1"/>
<xsd:element name="num-total" type="xsd:int" minOccurs="1" maxOccurs="1" />
<xsd:element name="num-unread" type="xsd:int" minOccurs="1" maxOccurs="1" />
<xsd:element name="critical" type="xsd:int" minOccurs="1" maxOccurs="1" />
<xsd:element name="important" type="xsd:int" minOccurs="1" maxOccurs="1" />
<xsd:element name="normal" type="xsd:int" minOccurs="1" maxOccurs="1" />
<xsd:element name="last-modified" type="xsd:string" minOccurs="0" maxOccurs="1" />
</xsd:sequence>
</xsd:element>
</xsd:schema>
| 要素 | 意味 | 備考 |
|---|---|---|
//response/result | リザルトコード | 次の値を返します。1：成功4：入力パラメータの内容にエラーがある8：その他のシステムエラーが発生 |
//response/errors | エラーメッセージ | エラーが発生した場合は、詳細なエラーメッセージが文字列で返されます。 |
//response/num-total | 既読を含むトータル件数 | 店舗・店舗スタッフのトップページに表示されているお知らせのうち、days 日以内の公開日のお知らせ総件数です。 |
//response/num-unread | 未読お知らせ件数 | 店舗・店舗スタッフのトップページに表示されているお知らせのうち、days 日以内の公開日のお知らせについて、未読件数を返します。 |
//response/critical | 重要度が緊急のお知らせのうち未読件数 | |
//response/important | 重要度が重要のお知らせのうち未読件数 | |
//response/normal | 重要度が通常のお知らせのうち未読件数 | |
//response/last-modified | 既読を含めた、店舗・店舗スタッフで閲覧可能なすべてのお知らせのうち最新の最終更新日 | num-total に含まれるお知らせのうち、最新の最終更新日が yyyy-MM-dd HH:mm:ss 形式のUTC時刻で返されます。 |
未読お知らせ件数の取得に成功した場合のレスポンスXML例
<response>
<result>1</result>
<num-total>20</num-total>
<num-unread>4</num-unread>
<critical>1</critical>
<important>0</important>
<normal>3</normal>
<last-modified>2020-11-30 00:00:00</last-modified>
</response>
上の例では、//response/result の値が 1 のため、呼び出しは成功しています。//response/num-unread には未読のお知らせが 4件 あることが返されています。
その内訳は、緊急が1件、通常が3件 です。
未読お知らせ件数の取得に失敗した場合のレスポンスXML例
<response>
<result>8</result>
<errors><![CDATA[
* not for a store / staff account.
]]></errors>
</response>
上の例では、//response/result の値が 8 のため、呼び出しは失敗しています。//response/errors には、指定したセッションキーが店舗・店舗スタッフ用のセッションキーではなかったことを示すエラーメッセージが返されます。