店舗スケジュールに表示される作業項目の店舗実施状況の取得を行うことができます。
呼び出し先URL
{your-domain} の部分をご利用の環境にあわせて変更してください。
https://{your-domain}/h2/STRScheduleManipurator.doリクエスト
| パラメータ | 意味 | 必須 | 制約 |
|---|---|---|---|
func | 動作モード | 〇 | 必ず status を指定します。 |
key | WebAPIキー | 〇 | スケジュール操作APIが利用可能なWebAPIキーを指定します。 |
id | 対象のスケジュールのID | 〇 | 実施状況を取得する対象となるスケジュールのIDを指定します。create / update 操作の結果として返された schedule-id の値を指定します。 |
レスポンス
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="task-status">
<xsd:sequence>
<xsd:element name="store" minOccurs="0">
<xsd:attribute name="code" type="xsd:string" use="required" />
<xsd:attribute name="date" type="xsd:string" use="optional" />
<xsd:attribute name="cost" type="xsd:float" use="optional" />
<xsd:attribute name="staff-name" type="xsd:string" use="optional" />
<xsd:attribute name="status" type="xsd:int" use="optional" />
</xsd:element>
</xsd:sequence>
</xsd:element>
</xsd:sequence>
</xsd:element>
</xsd:schema>
| 要素 | 意味 | 備考 |
|---|---|---|
//response/result | リザルトコード | 以下の値をとります。1: 成功4: 入力パラメータの内容にエラーがある8: その他のシステムエラーが発生 |
//response/errors | エラーメッセージ | エラーが発生した場合は、詳細なエラーメッセージが文字列として返されます。 |
//response/task-status | 実施状況 | |
//response/taskstatus/store | 店舗ごとの実施状況 | 送り先に指定された店舗の実施状況を以下の属性値で返します。code : 店舗コードdate : 実施状況の報告時刻status : 1=完了済み、2=未完了cost : 実績工数staff-name : スタッフ名補足事項 店舗グループや複数店舗が送り先に指定された場合は個別の店舗に展開します。 |
実施状況の取得操作に成功した場合のレスポンスXMLの例
<response>
<result>1</result>
<task-status>
<store code="40997"/><!-- このように店舗コードだけの行は未報告 -->
<store code="40999" date="2020-10-07 23:07:13" status="1"/><!-- status="1" となっている行は完了済 -->
<store code="0123"/>
<store code="40403"/>
<store code="40406" date="2020-10-09 08:28:00" status="2"/><!-- status="2" となっている行は報告したが完了チェックを入れていない -->
<store code="40998" cost="10.0000" date="2020-10-07 23:31:04" staff-name="スタッフ名" status="1"/><!-- 実績工数・スタッフ名を入れた場合 -->
<store code="40402"/>
<store code="40404"/>
<store code="40401"/>
</task-status>
</response>
上の例では、//response/result の値が 1 なので呼び出しは成功しています。//response/task-status に店舗ごとの実施状況が返されます。