Endpoint | Description |
|---|---|
GET /appointments/report | Returns an array of appointments. To get time offs to return, set the excludeTimeOff parameter to false and set the onlyTimeOff parameter to 1. |
| GET /timeOff/{timeOffId} | Returns a JSON object for specified time off. |
| POST /timeOffBulk | Creates a new time off object on a business' account. Request body/payload: Must pass a full appointment object. |
| PUT /timeOff/{timeOffId} | Updates an existing time off object. Request body/payload: Must pass an appointment with the desired changes made. |
| DELETE /timeOff/{timeOffId} | Deletes a timeOff object from your business' account. |
To aid with page load time, we have included pageNumber and pageSize parameters for server side pagination. The pageSize parameter will be the number of items shown per page.
Parameter | Type | Endpoints to be used with | Description |
|---|---|---|---|
clientId | integer | GET /appointments/report | Displays unique numeric ID of client of appointment to be returned following a GET report call. |
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"businessId": 43111,
"color":
"createdDate": "2018-08-03 14:39:38",
"createdUser": "JoeSchmo",
"description": "Need a break!",
"endDate": "2018-10-01",
"endTime": 1200,
"modifiedDate": "2018-08-07 15:10:27",
"modifiedUser": "JoeSchmo",
"reason": {Reason object for reason of time off-see services API page},
"recurringAppointmentId": null,
"staff": {Staff object for staff with time off-see staff API page},
"startDate": "2018-10-01",
"startTime": 1100,
"status": "Open",
"timeOffId": 17360947
} |
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"appliesTo": "staff",
"businessId": 43111,
"color": null,
"createdDate": "2018-08-03 14:39:38",
"createdUser": "JoeSchmo",
"description": "Need a longer break!",
"endDate": "2018-10-01",
"endTime": "1400",
"modifiedDate": "2018-08-07 11:34:56",
"modifiedUser": "JoeSchmo",
"note": "Need a longer break!",
"originalStartDate": "2018-10-01",
"reason": {Reason object for reason of time off-see services API page},
"recurringAppointmentId": null,
"staff": {Staff object for staff with time off-see staff API page},
"staffId": 80891,
"startDate": "2018-10-01",
"startTime": "1100",
"status": "1100",
"timeOffId": 17360947
} |
| Property name | Type | Description |
|---|---|---|
| businessId | integer | Provides unique numeric ID of the business offering availability. (Required) |
| color | string | Displays any color chosen to override specified time off on the backoffice calendar. |
| createdDate | string | Displays as date specified time off was created as YYYY-MM-DD with time after. (Required) |
| createdUser | string | Displays the username of user who created specified time off. (Required) |
| description | string | Displays any description that was added to time off profile. |
| endDate | string | Displays the date that specified time off is set to end. |
| endTime | integer | Displays as military time that specified session ends. (Required) |
| modifiedDate | string | Displays as date specified time off was last modified as YYYY-MM-DD with time after. |
| modifiedUser | string | Displays the username of user who last modified specified time off. |
| reason | object | Displays the reason object connected to specified time off. |
| recurringAppointmentId | integer | If specified time off is part of a repeating appointment series, then this provides unique numeric ID of that repeating appointment series. |
| staff | object | Displays the staff object connected to specified time off. |
| startDate | string | Displays the date that specified time off is set to begin. |
| startTime | integer | Displays as military time that specified session is set to begin. (Required) |
| status | string | Displays the status of time off. Possible values include Open, Closed, or Cancelled. |
| timeOffId | integer | Provides unique numeric ID for specified time off. |