להלן API להוספת משמרת פתוחה במודל משמרות
No | key name | Mandatory | Description | Example Value | ||
1 | u | Required | admin account username | tessss | ||
2 | p | Required | admin account password | 123456778 | ||
3 | name | Required | open shift name | open-shift-1 | ||
4 | store | Required | Store Names with comma separated | store1,store2 | ||
5 | started_at | Required | open shift starting time | 13:00 | ||
6 | ended_at | Required | open shift ending time | 14:00 | ||
7 | role | Required | Employee role names with separated comma | role1,role2 | ||
8 | role_count | Required | max employee count per role with comma separated | 3,4 | ||
9 | location | Optional | open shift location | Tel aviv, 12st | ||
10 | note | Optional | note to employee | "Go party" | ||
11 | is_fixed | Optional | for fixed open shfit , its value 1 or 0 | 1 | ||
12 | open_at | If not set is_fixed , it should be required | open shift openning date | 2022-09-01 | ||
13 | week_at | if is_fixed = 1, it required | when set its open shift fixed | 1,2 (1 means Monday, 2 means Tuesday) | ||
14 | fixed_started | if is_fixed = 1, it required | open shift's static setting starting date | 2022-08-10 | ||
15 | fixed_ended | if is_fixed = 1, it required | open shift's static setting ending date | 2022-09-10 |
להלן תשובות אפשריות מהשרת:
Respones Case | ||||
Key name | value | Description | ||
status | TRUE | Success to create open shift | ||
FALSE | Failed | |||
msg | incorrect_role_name | role names are all incorrect | ||
invalid_param | Missed Required Fields | |||
required_value:open_at | <is_fixed> is not set but open_at missing | |||
required_value:static_setting_value | <is_fixed> =1 but any of week_at,fixed_started,fixed_end is missing | |||
incorrect_store_name | store names are all incorrect |