Rethink Availability for Staff
- Sara Fetherson
Staff Availability
Outcome:
GET availability for all staff
Staff Availability should be sent as part of the Staff API. Multiple availabilities should be sent as an array of objects.
Field | Data Type | Max Length | Description | Req | Expected Values | Error Message | Message if API is successful | |
|---|---|---|---|---|---|---|---|---|
| 1 | Staff ID | integer | 20 | Rethink Staff ID returned in API response. If an existing Staff ID is transmitted, existing availability of the Staff will be updated. | Yes | 1234 | Invalid Staff ID | Return message: Staff Availability successfully updated. |
| 2 | Staff Availability ID | integer | 10 | Unique ID to identify a staff availability record. Can be blank when a staff availability is added. staff Availability ID needs to be sent when updates are being made to existing staff availability | No | 1 | Invalid Staff Availability ID | |
| 3 | DayofWeek | integer | 10 | Should be one of the following values in Appendix 12.0 Day Types
| Yes | 1 | Invalid Day of Week | |
| 4 | StartTime | Time | 10 | Time when availability of Staff begins | Yes | 16:00:00 | Invalid Start Time | |
| 5 | EndTime | Time | 10 | Time when availability of Staff ends | Yes | 17:00:00 | Invalid End Time |