• Index
• TOC

Custom Schedules Methods

Get and set a custom schedule. The following is a glossary of the fields available through the API.

Custom Schedule Data

• cs_id (string) - The custom schedule id
• name (string) - The name of the custom schedule
• on (boolean) - Whether the custom schedule is active or not

Table of Contents #

• GET /controllers/{controller_id}/custom.schedules
• GET /controllers/{controller_id}/custom.schedules/{cs_id}
• DEL /controllers/{controller_id}/custom.schedules/{cs_id}
• PUT /controllers/{controller_id}/custom.schedules/{cs_id}

GET /controllers/{controller_id}/custom.schedules #

Gets all the custom schedules for the given controller.

Query Fields

1. controller_id (string) - The public id for the controller

Response

Gets all the custom schedules for a given controller

$.ajax({
    type: 'GET',
    url: '[api url]/controllers/{controller_id}/custom.schedules'
});

GET /controllers/{controller_id}/custom.schedules/{cs_id} #

Gets a specific custom schedule

Query Fields

1. controller_id (string) - The public id for the controller
2. cs_id (string) - The custom schedule id

Response

The controller data for the specified custom schedule

$.ajax({
    type: 'GET',
    url: '[api url]/controllers/{controller_id}/custom.schedules/{cs_id}'
});

DEL /controllers/{controller_id}/custom.schedules/{cs_id} #

Delete a custom schedule

Query Fields

1. controller_id (string) - The public id for the controller
2. cs_id (string) - The custom schedules id

Response

1. success (boolean) - The success of the call

$.ajax({
    type: 'DELETE',
    url: '[api url]/controllers/{controller_id}/custom.schedules/{cs_id}'
});

PUT /controllers/{controller_id}/custom.schedules/{cs_id} #

Update a custom schedule

Query Fields

1. controller_id (string) - The public id for the controller
2. cs_id (string) - The custom schedules id

Post Fields

Any of the "Custom Schedule Data" listed above.

Response

1. success (boolean) - The success of the call

$.ajax({
    type: 'PUT',
    url: '[api url]/controllers/{controller_id}/custom.schedules/{cs_id}'
    data: {
        "name": "new name"
    }
});

---