get https://api.alocity.com/v1/integration-management/schedule/
This endpoint is used to get a base schedule by its Id.
Response Payload Object
| 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. |
| cronSchedules | An array of the CronSchedule object | All associated cron schedules (see below for a breakdown). |
| 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 |
CronSchedule Object
| Property | Type | Description |
|---|---|---|
| activeOnHolidays | boolean | Whether or not this schedule will be active on holidays. |
| cron_expression | string | The cron expression that is being used for the schedule. |
| end | Nullable DateTime | Date until when the schedule will be used, if any. |
| id | long | The Id of the cron schedule |
| scheduleId | long | Id of base schedule associated with cron-schedule. |
| start | DateTime | Date when the schedule had begun or will begin being used. |
| time_duration | integer | Time (in minutes) that the schedule remains active from the start time in cron expression. |
Controlled Errors
| Error Code | Error Message |
|---|---|
| error_schedule_not_found | No schedule found with the specified Id. |
Any status codes returned that are not provided here are generic status codes that can be found here.