Scheduling API Overview

Common Parameters and Options

The services support common
parameters, modeled after the JSON API Specification, are as follows:

◊    Includes
parameter permits requesting compound documents - responses including resources related to
the requested resource.

•    Include may be a
comma-delimited list of valid resource names for which the resource supports includes.

•    For example,
/staffSchedules?include=calendar,shiftSchedule

◊    Sparse Field Sets permit
requesting which fields are returned by the service using the fields
or fields[resourceName]
(ex fields[calendar]) parameters. Paging permits requests for paged data using the pageSize
and pageNo
parameters.

•    The parameter
value must be a comma-delimited list of valid fields for the resource.

•    For example,
?fields=name,status. 

•    If specifying
sparse fields on an included resource, the include parameter is redundant and not required.

•    For
example,
?include=calendar&fields[calendar]=name can be simplified to
?fields[calendar]=name

◊    Sort permits sorting
list responses using the sort
parameter. Filters permit "querying" list responses using the filter[fieldName]
(ex filter[status]) parameter

•    The parameter
value must be a comma-delimited list of valid fields for the resource.

–    For example, ?sort=name,status.

•    The sort
direction may be specified using +,- for ascending, descending respectively. Ascending is the default
so + is not required.

Common Fields

The following fields are
common to Calendar, ShiftSchedule, StaffSchedule, StaffSubstitution and ShiftSubstitution configurations.