PHphorest
Break

Create a break

Create and return a break for the specified business id and branch id

post/api/business/{businessId}/branch/{branchId}/break

Request

Path parameters

businessIdstring required
branchIdstring required

Request body

breakDatestring date
startTimestring
endTimestring
staffIdstring
roomIdstring
machineIdstring
labelstring
paidBreakboolean
breakIdstring
versioninteger

Example request

{
  "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
}

Response

Break created successfully

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
}

Changes

No recorded changes to this operation across all 2 revisions of this API.