get https://api.alocity.com/v1/integration-management/schedules
This endpoint is used to get all base schedules on the account.
Response Payload Object
The response's payload will contain an array of objects containing the following values.
Property | Type | Description |
---|---|---|
description | string | The description of the schedule. |
hasCronSchedules | boolean | Whether or not the schedule has associated cron schedules. |
id | long | The Id of the schedule. |
isAutomatic | boolean | Whether or not the doors associated with the schedule will be opened during the schedules active hours. |
name | string | The name of the schedule. |
siteId | long | The Id of the associated site. |
hasGroup | boolean | Has at least one group association |
hasUser | boolean | Has at least one user association |
hasDevice | boolean | Has at least one device association |
hasZone | boolean | Has at least one zone association |
Any fields returned in the response's payload that are not listed here are "empty" fields that should be ignored as they will always be the same value or will not be filled in.
Note that if an error was found, then the payload will be null, however if no values were found and no error occurred, then an empty list will be returned instead.
Any status codes returned that are not provided here are generic status codes that can be found here.