Schedule

Retrieve the schedule for a given record schedule. The output will always be sorted on start.

This action requires a request with an active account.

Tokens

This action requires the following tokens:

  • recordschedule-read

Arguments

Required arguments are marked in bold, and optional arguments are marked in italics.

Argument Type Default Description
id Hash   Hash of the record schedule to fetch the schedule for
startdate DateTime   The start date/time of the window to fetch the schedule for
enddate DateTime   The end date/time of the window to fetch the schedule for
count Integer 1000 The number of items to fetch the schedule for. Maximum is 1000

Output

This action produces the following output on success:

An array containing zero or more elements, each one being an object containing the following fields:

Name Type Description
start DateTime Start date and time of this occurrence
end DateTime End date and time of this occurrence

Errors

This action can return one of the default status codes, or one of the following status codes on error:

STATUS_SCHEDULE_NOT_FOUND (320)
If the schedule specified by “ID” can not be found