Permits to load and save the macro scheduler's schedule at a given M&C.
When subscribing for a '.SYSTEM.schedule' parameter of a M&C, the front end receives a message which indicates 'an updated schedule is available' instead of sending the bulky schedule itself over the websocket connection.
After the front end received this message, it can use the /api/v1/schedule API call to retrieve the schedule as a Schedule data object.
Supported HTTP methods: GET, PUT, HEAD, OPTIONS
GET /api/v1/schedule/{mncName}
Returns a Schedule document containing the actual system schedule from this M&C.
Parameters:
| Parameter | Description |
|---|---|
| mncName | The name of the M&C from which the schedule shall be loaded. |
Return Codes:
| Code | Description |
|---|---|
| 200 | OK, returns a Schedule document containing the requested schedule. |
| 401 | not logged in. In this case a ApiError document is returned, describing details of the error. |
| 404 | no M&C with the given name exists. In this case a ApiError document is returned, describing details of the error. |
PUT /api/v1/schedule/{mncName}
Overwrites the system schedule at the given M&C. Expects a Schedule document containing new schedule to set.
Parameters:
| Parameter | Description |
|---|---|
| mncName | The name of the M&C on which the preset shall be saved. |
Return Codes:
| Code | Description |
|---|---|
| 200 | OK, returns the Schedule containing the saved schedule. |
| 401 | not logged in. In this case a ApiError document is returned, describing details of the error. |
| 404 | no M&C with the given name exists. In this case a ApiError document is returned, describing details of the error. |