店舗・店舗スタッフの指定した日付に予定されている作業をCSVファイルで取得します。
外部ポータルに、店舗・店舗スタッフごとの作業リストを表示することが可能です。
呼び出しURL
{your-domain} の部分をご利用の環境にあわせて変更してください。
https://{your-domain}/h2/STRTaskManipurator.doリクエスト
| パラメータ | 意味 | 必須 | 制約 |
|---|---|---|---|
func | 動作モード | 〇 | 必ず getTaskStatusOfDay を指定します。 |
key | WebAPIキー | 〇 | 作業操作APIが利用可能なWebAPIキーを指定します。 |
date | 対象の日付 | 〇 | 取得対象日を yyyy-MM-dd のフォーマットで指定することができます。 |
store | 対象店舗 | 特定の店舗・店舗グループに対して取得したい場合には、店舗の店舗コードもしくは店舗グループのグループコードを指定することができます。 補足事項 ・複数の店舗を指定する場合には同一パラメータ名を列挙し値を変えて指定してください。 ・パラメータの指定を省略した場合、または __$ALL（ハイフン2つに $ALL）という特殊コードを指定した場合は全ての店舗が指定されたものと解釈します。・指定したコードが店舗コードおよび店舗グループコードどちらにも存在する場合は、店舗コードが優先されます。 | |
target | 対象種別 | 店舗スタッフ機能が有効な環境の場合、店舗の情報を取得するのか、店舗スタッフの情報を取得するか指定することができます。store : 店舗staff : 店舗スタッフ補足事項 ・パラメータの指定を省略した場合、 store と staff の両方が指定されたものと解釈します。 |
レスポンス
APIの呼び出し結果は、以下のフォーマットのCSVファイルとして返されます。
CSVファイルの1行目には列名が含まれます。
注意事項
将来的に項目を拡張する可能性もあります。
CSVファイルをパースする処理では列数や列の順序を固定せず、1行目の列名を元に相当する値を各行から読み取るようにしてください。
| 列名 | 意味 | 備考 |
|---|---|---|
storeCode | 店舗コード | 店舗スタッフの場合には所属する店舗コードとなります。 |
staffCode | 店舗スタッフコード | 店舗スタッフ機能が有効で、かつ target に staff を指定した場合に出力されます。 |
numTasks | 予定されている実施作業件数 | 対象の日付に予定されている店舗／店舗スタッフの作業件数となります。 |
numDone | 実施済み作業件数 | 対象の日付に予定されている店舗／店舗スタッフの作業件数のうち実施済みの作業件数となります。 |
totalPlannedVolume | 予定されている実施作業の総工数 | 対象の日付に予定されている店舗／店舗スタッフの作業総工数となります。 |
totalResultVolume | 実施済み作業の総工数 | 対象の日付に予定されている店舗／店舗スタッフの作業件数のうち実施済み作業総工数となります。 |