お知らせの登録 – Shopらんサポートサイト

お知らせを登録できます。

呼び出し先URL

{your-domain} の部分は、ご利用の環境に合わせて変更してください。

https://{your-domain}/h2/STRNoticeManipurator.do

リクエスト

〇：必須
△：いずれか必須

パラメータ名	意味	必須	制約
func	動作モード	〇	必ず `create` を指定します。
key	WebAPIキー	〇	お知らせ操作APIが利用可能なWebAPIキーを指定します。
title	タイトル	〇	登録するお知らせのタイトルを指定します。 UTF-8エンコーディングで240バイト以内の文字列を指定できます。
priority	重要度		登録するお知らせの重要度を、次の値で指定できます。 `3`：通常 `4`：重要 `7`：緊急 ℹ 補足：パラメータを省略した場合は、通常のお知らせになります。
recvStore	送り先店舗		特定の店舗・店舗グループにのみ公開するお知らせを登録する場合は、店舗コードまたは店舗グループのグループコードを指定できます。 ℹ 補足：複数の店舗を指定する場合は、同じパラメータ名を複数回指定し、値を変えて指定してください。 ℹ 補足：パラメータを省略した場合、または `__$ALL`（アンダーバー2つに `$ALL`）という特殊コードを指定した場合は、すべての店舗に公開されます。 ℹ 補足：指定したコードが店舗コードと店舗グループコードの両方に存在する場合は、店舗コードが優先されます。
conjStore	送り先店舗の絞り込み条件		送り先店舗からさらに絞り込む場合は、店舗コードまたは店舗グループのグループコードを指定できます。 ℹ 補足：複数の店舗を指定する場合は、同じパラメータ名を複数回指定し、値を変えて指定してください。
colors	送り先の区分		環境の分割機能を利用している場合に、お知らせの公開先となる区分の識別コードを指定します。 ℹ 補足：パラメータを省略した場合は、すべての区分に公開されます。
targetStaff	送り先の対象		お知らせの公開先となる対象を、次の値で指定できます。 `0`：全てのスタッフ `1`：店長あて `3`：店長＋副店長あて ℹ 補足：パラメータを省略した場合は、全てのスタッフに公開されます。
usersConcerned	本部の関係者		お知らせの本部関係者設定を利用している場合に、お知らせの関係者として本部ユーザーのログインID、または本部グループのグループコードを指定できます。 ℹ 補足：複数の本部ユーザー、本部グループを指定する場合は、同じパラメータ名を複数回指定し、値を変えて指定してください。
pubGroup	発信部署		発信部署として指定する本部グループのグループコードを指定できます。
pubUser	発信者		発信者として指定する本部ユーザーのログインIDを指定できます。
openDate	公開期間の開始日	〇	公開期間の開始日を `yyyy-MM-dd` 形式で指定できます。
closeDate	公開期間の終了日		公開期間の終了日を `yyyy-MM-dd` 形式で指定できます。
beginDate	実施期間の開始日		実施期間の開始日を `yyyy-MM-dd` 形式で指定できます。
endDate	実施期間の終了日		実施期間の終了日を `yyyy-MM-dd` 形式で指定できます。
category(X)	カテゴリ項目		カテゴリ項目を指定します。パラメータ名の `X` の部分には、カテゴリグループのIDを指定します。たとえば、お知らせで使用すると指定されているカテゴリグループのIDが `123` の場合、パラメータ名は `category(123)` になります。パラメータの値には、そのカテゴリグループに属するカテゴリ項目の項目IDを指定します。 ℹ 補足：複数のカテゴリを指定する場合は、同じパラメータ名を複数回指定し、値を変えて指定してください。
calendarArea	カレンダー表示位置		登録するお知らせのカレンダー表示位置をエリアコードで指定できます。 ℹ 補足：パラメータを省略した場合は、`hidden` が指定されたものとして扱われ、「非表示」エリアに表示されます。 ℹ 補足：無効に設定されているカレンダー表示位置のエリアコードも指定できます。
weeklyScheduleArea	週間カレンダーのスケジュール表示位置		登録するお知らせの週間カレンダーのスケジュール表示位置をエリアコードで指定できます。 ℹ 補足：パラメータを省略した場合は、`notice` が指定されたものとして扱われます。
secureFlag	発信部署以外の本部ユーザーには公開しないフラグ		次の値を指定できます。 `0`：制限しない `0以外`：制限する ℹ 補足：発信部署、発信者が指定されていない場合はパラメータエラーになります。
libDocId	関連する書庫文書		関連する書庫文書として設定する書庫文書の文書番号を指定できます。 ℹ 補足：複数の書庫文書を指定する場合は、同じパラメータ名を複数回指定し、値を変えて指定してください。
pdf	添付PDF	△	お知らせに添付するPDFファイルを指定します。 ℹ 補足：複数のPDFファイルを指定する場合は、`pdf` パラメータを複数回指定するか、`pdfFile` パラメータを指定してください。`pdf` と `pdfFile` の両方を指定した場合は、`pdfFile` の指定が優先されます。
pdfFile[X]	添付PDF（複数指定するとき）	△	お知らせに添付するPDFファイルを複数指定するときに使用します。 `X` には、0から始まる整数値を指定できます。
taskDate(X)	作業予定日		実施する作業の実施予定日を `yyyy-MM-dd` 形式で指定します。`X` の部分には、0から始まる作業番号が入ります。 ℹ 補足：実施予定日を期間指定する場合は、`yyyy-MM-dd,yyyy-MM-dd` のように開始日と終了日をカンマ区切りで指定します。実施予定日が3つ以上指定されている場合はエラーになります。 ℹ 補足：作業を複数登録する場合は、`taskDate(0)`、`taskDate(1)`、`taskDate(2)` ... のように指定してください。
taskName(X)	作業名		お知らせに設定する作業名を指定します。 UTF-8エンコーディングで240バイト以内の文字列を指定できます。 `X` の部分には、`taskDate(X)` と同じ作業番号が入ります。
taskVolume(X)	作業の予定工数		お知らせに設定する作業の予定工数を指定します。 0～9999の整数値を指定できます。 `X` の部分には、`taskDate(X)` と同じ作業番号が入ります。
content	本文のテキスト	△	お知らせ本文となるテキストデータを指定できます。 `content` を指定した場合は、電子メールでのお知らせ登録と同様に、本文がお知らせ雛形部分に表示されたお知らせとして登録されます。 ℹ 補足：本文の先頭が `#!html` になっている場合は、それ以降をHTMLとして解釈し、文章入力エリア部品のリッチテキスト書式と同等の表示になります。利用できないタグや属性値を指定した場合は、それらは無視されます。
attachedFile[X]	添付ファイル	△	お知らせ本文の部分に表示する添付ファイルを指定できます。 `X` には0から始まる整数値を指定し、複数の添付ファイルを指定できます。
keyword	キーワード		キーワード機能を有効にしている場合に、お知らせに設定するキーワードを指定できます。キーワードには、UTF-8エンコーディングで120バイト以内の文字列を指定できます。 ℹ 補足：複数のキーワードを指定する場合は、同じパラメータ名を複数回指定し、値を変えて指定してください。
acceptComment	コメントの受付		お知らせのコメント機能を有効にしている場合に、コメントを受け付けるかどうかを指定できます。指定しない場合は、システム設定が反映されます。 `1`：コメントを受け付ける `0`：コメントを受け付けない
setRead	既読フラグのセット		お知らせ登録時に、初期状態での店舗・店舗スタッフの閲覧状況を既読に設定する場合は、`1` を指定します。 ℹ 補足：閲覧状況の設定はWebAPIの呼び出しとは非同期で行われるため、登録直後は未読で表示される場合があります。

ℹ 補足：ファイルをアップロードする場合、フォームデータのPOST時は必ず multipart/form-data 形式で送信する必要があります。

制限事項

お知らせ操作APIには、次の制約があります。

雛形を使ったお知らせは作成できません。
回答付きのお知らせは作成できません。
お知らせの更新はできません。
内容を修正する必要がある場合は、既存のお知らせを削除して再度登録してください。

HTMLによるリクエストサンプル

送り先店舗に複数店舗を指定する場合

<form method="POST"
    enctype="multipart/form-data">
    　：
    <input name="recvStore" value="STR00001" />
    <input name="recvStore" value="STR00007" />
    　：
</form>

作業を期間指定で複数指定する場合

<form method="POST"
    enctype="multipart/form-data">
    　：
    <input type="text" name="taskDate(0)" value="2023-03-27,2023-03-31"/>
    <input type="text" name="taskName(0)" value="棚卸作業"/>
    <input type="text" name="taskDate(1)" size="21" value="2023-04-03,2023-04-05"/>
    <input type="text" name="taskName(1)" value="集計作業"/>
    <input type="text" name="taskDate(2)" size="21" value="2023-04-06,2023-04-07"/>
    <input type="text" name="taskName(2)" value="まとめ・報告"/>
    　：
</form>

レスポンス

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="notice-id" type="xsd:int" minOccurs="0" maxOccurs="1" />
      <xsd:element name="errors" type="xsd:string" minOccurs="0" maxOccurs="1"/>
    </xsd:sequence>
  </xsd:element>
</xsd:schema>

要素	意味	備考
`//response/result`	リザルトコード	次の値を返します。 `1`：成功 `4`：入力パラメータの内容にエラーがある `8`：その他のシステムエラーが発生
`//response/notice-id`	お知らせNo.	お知らせの登録に成功した場合に、登録されたお知らせのお知らせNo.が返されます。
`//response/errors`	エラーメッセージ	エラーが発生した場合は、詳細なエラーメッセージが文字列で返されます。

お知らせの登録に成功した場合のレスポンスXML例

<response>
  <result>1</result>
  <notice-id>8727</notice-id>
</response>

上の例では、//response/result の値が 1 のため、呼び出しは成功しています。
//response/notice-id には、登録されたお知らせのお知らせNo.が返されます。

お知らせの登録に失敗した場合のレスポンスXML例

<response>
  <result>4</result>
  <errors><![CDATA[
    * 'category(177)' is required.
  ]]></errors>
</response>

上の例では、//response/result の値が 4 のため、呼び出しは失敗しています。
//response/errors には、カテゴリ項目 category(177) の指定が必須であることを示すエラーメッセージが返されます。