PHphorest
Branch WorkTimeTable

Retrieve a branch timetable

Changed on

Get a branch timetable for the specified business id and branch id, with a maximum one month date range. Start and end date must be provided

get/api/business/{businessId}/branch/{branchId}/worktimetable

Request

Path parameters

businessIdstring required
branchIdstring required

Query parameters

from_datestring date required

from date to query from. yyyy-MM-dd

to_datestring date required

to date (inclusive) to query to. yyyy-MM-dd

activity_typestring

specifies a specific type of work activity to return

Response

Specified timetable retrieved

staffIdstring
branchIdstring

Example response

{
  "staffId": "staffid",
  "branchId": "branchid",
  "timeSlots": [
    {
      "date": "2018-01-01",
      "type": "NON_WORKING",
      "custom": "conference",
      "branchId": "branchid123",
      "workActivityId": "workActivityId123",
      "timeOffPolicyId": "k2Lh8QdRZq0Xv3NfYpWc1A"
    }
  ]
}

Changes