Data points passed in the request URL or post body portion of the API call that are used to filter the data being requested. Parameter | Type | Endpoints to be used with | Description |
|---|
staffIdList | integer arrayyear | integer | ALL | Parameter provided in the URL to limit the year that availability is being searched on. | month | integer | ALL | Parameter provided in the URL to limit the month that availability is being searched on. | day | integer | POST /cs/staffavailability/day/{year}/{month}/{day} | Parameter provided in the URL to limit the day that availability is being searched on. | staffIdList | integer array | ALL | List of Staff IDs to limit the availability search. | reasonIdList | integer array | POST /cs/staffALL | List of Reason IDs to limit the availability search. | locationIdList | integer array | POST /cs/staffALL | List of Reason IDs to limit the availability search. | locationGroupIdList | integer array | POST /cs/staffALL | List of Location Group IDs to limit the availability search. | reasonGroupIdList | integer array | POST /cs/staffALL | List of Reason Group IDs to limit the availability search. | classScheduleIdList | integer array | POST /cs/staffALL | List of Classs Schedule IDs to limit the availability search. | locationSuperGroupIdList | integer array | POST /cs/staffALL | List of Location Super Group IDs to limit the availability search. | reasonSuperGroupIdList | integer array | POST /cs/staffALL | List of Reason Super Group IDs to limit the availability search | locale | String | POST /cs/staffALL | Displays as general preferred country and language of specified staff person; by default this value is read from their browser settings - for more info, see Locale API page. | clientTimeZone | String | POST /cs/staffALL | The timezone of the client to search availability. | duration | Integer | POST /cs/staffALL | The duration of the appointment to search availability. |
|