v1

latestOpenAPI 3.0.1Apache 2.02026-07-2473111182.6 KB
Break

Retrieve a break

Get a break for the specified business id, branch id and break id

get/api/business/{businessId}/branch/{branchId}/break/{breakId}

Path parameters

businessIdstring required
branchIdstring required
breakIdstring required

Response

Specified break retrieved

breakDatestring date
startTimestring
endTimestring
staffIdstring
roomIdstring
machineIdstring
labelstring
paidBreakboolean
breakIdstring
versioninteger

Example response

{
  "breakDate": "2018-01-01",
  "startTime": "12:30:00",
  "endTime": "13:00:00",
  "staffId": "staffid",
  "roomId": "roomid",
  "machineId": "machineid",
  "label": "lunch break",
  "paidBreak": true,
  "breakId": "ab123",
  "version": 1
}