週間カレンダーのスケジュールに表示される店舗スケジュールの登録およびイベントの登録を行うことができます。
呼び出し先URL
{your-domain} の部分をご利用の環境にあわせて変更してください。
https://{your-domain}/h2/STRScheduleManipurator.doリクエスト
| パラメータ | 意味 | 必須 | 制約 |
|---|---|---|---|
func | 動作モード | 〇 | 必ず create を指定します。 |
key | WebAPIキー | 〇 | スケジュール操作APIが利用可能なWebAPIキーを指定します。 |
title | スケジュールタイトル | 〇 | 登録するスケジュールのタイトルを指定します。UTF-8エンコーディングで240バイト以内の文字列を指定することができます。 |
description | 説明 | 登録するスケジュールを説明する文章を指定します。UTF-8エンコーディングで2000バイト以内の文字列を指定することができます。 | |
recvStore | 送り先店舗 | 特定の店舗・店舗グループに対してのみ公開するスケジュールを登録するには、店舗の店舗コードもしくは店舗グループのグループコードを指定することができます。 補足事項 ・複数の店舗を指定する場合には同一パラメータ名を列挙し値を変えて指定してください。 ・パラメータの指定を省略した場合、または __$ALL（アンダーバー2つに $ALL）という特殊コードを指定した場合は全ての店舗に公開されます。・指定したコードが店舗コードおよび店舗グループコードどちらにも存在する場合は、店舗コードが優先されます。 | |
pubGroup | 発信部署 | 発信部署として指定する本部グループのグループコードを指定することができます。 | |
pubUser | 発信者 | 発信者として指定する本部ユーザーのログインIDを指定することができます。 | |
y4md | 登録日 | 〇 | スケジュールを登録する日付を yyyy-MM-dd 形式の文字列で指定します。 |
position | 登録先 | 週間スケジュール画面の表示列のコードを指定します。表示列のコードは「システムの管理＞カレンダーの設定＞店舗スケジュールの設定＞表示列の設定」を参照してください。task を指定した場合週間スケジュールの作業欄および、店舗トップページに表示されるようになります。 notice を指定した場合週間スケジュールのお知らせ欄にのみ表示されます。 補足事項 ・表示列を追加した場合は、その表示列のコードを指定することもできます。 ・イベントを登録したい場合は、表示エリアコードを指定します。週間スケジュールの表示列のコードと重複する場合には週間スケジュールが優先されます。 | |
volume | 予定工数 | 作業として登録する場合、予定工数を数値で指定することができます。 | |
keyword | キーワード | キーワード機能を有効にしているとき、スケジュールにセットするキーワードを指定することができます。キーワードには、UTF-8エンコーディングで120バイト以内の文字列を指定することができます。 補足事項 複数のキーワードを指定する場合には同一パラメータ名を列挙し値を変えて指定してください。 | |
file | 添付ファイル | スケジュールに表示する添付ファイルを指定します。 補足事項 添付ファイルが1つの場合、このパラメータを利用します。複数の場合は、 attachmentFile[X] を利用します。 | |
attachmentFile[x] | 添付ファイル（複数） | スケジュールに表示する添付ファイルを複数指定することができます。X には0から始まる整数値を指定して複数の添付ファイルを指定することができます。 |
レスポンス
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="schedule-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/schedule-id | スケジュールID | スケジュールの登録に成功した場合は、登録されたスケジュール項目のIDが返されます。 スケジュールIDは最長36文字からなる文字列です。後で更新・削除・実施状況の取得を行うためにデータベース等に保存するときには、文字列の長さに注意してください。 |
//response/errors | エラーメッセージ | エラーが発生した場合は、詳細なエラーメッセージが文字列として返されます。 |
登録操作に成功した場合のレスポンスXMLの例
<response>
<result>1</result>
<schedule-id>b764014b-bd05-489d-844e-34a23b79725c</schedule-id>
</response>
上の例では、//response/result の値が 1 なので呼び出しは成功しています。//response/schedule-id に追加されたスケジュールのスケジュールIDが返されます。
登録操作に失敗した場合のレスポンスXMLの例
<response>
<result>4</result>
<errors><![CDATA[
* 'recvStore' (store0) is not found. * 'recvStore' does not contain valid store code(s) or group code(s).
]]></errors>
</response>
上の例では、//response/result の値が 4 なので呼び出しは失敗しています。//response/errors に送り先店舗に指定した店舗コードもしくは店舗グループコードが存在しない旨のエラーメッセージが返されます。