v1

Swagger 2.02026-07-13107162315.5 KB
ScheduleAssignment

Gets list of Schedule Assignments.

Schedule assignments are per-day, and link to a parent Schedule Series.

get/api/ScheduleAssignment

Query parameters

UpdatedAfterstring date-time

Limit results to records updated after the specified date

ScheduleDateFromstring date-time

Filter for schedule assignement that are on or after a specific date

ScheduleDateTostring date-time

Filter for schedules that are on or before a specific date

ScheduleSeriesIDinteger

Filter to records for a particular Schedule Series

UserIDinteger

The UserID of a schedule user to filter assignments for. Only api users with Admin role can see all schedules across all users. Users with ScheduleUser role can access their own ScheduleSeries.

UserEmailstring

The email of the user who has been scheduled

pageSizeinteger

Number of items per page (max 1000)

pageNumberinteger

Page to display. Starts from 1.

Sortstring

Optional sorting instruction. Currently possible values: "DateUpdated", "DateCreated", "DateUpdated desc", "DateCreated desc"

Response

Returns a paginated list of per-day schedule assignments.

TotalCountinteger

Total number of records matching the query across all pages.

PageNumberinteger

The current page number (1-based).

PageSizeinteger

The number of records per page.