Skip to main content

The type that defines the fields for a paginated result set of user schedules. The response consists of 0 or more sequenced pages where each page has 0 or more items.

Types that use UserScheduleCollection

Not used by any types.

Call that uses UserScheduleCollection

GET
/schedule

Fields

Field
Type
Description
href
string
The path to the call URI that produced the current page of results.
limit
integer
The value of the limit parameter submitted in the request, which is the maximum number of schedules to return per page, from the result set. A result set is the complete set of schedules returned by the method.

Note: Though this parameter is not required to be submitted in the request, the parameter defaults to 10 if omitted.

Note: If this is the last or only page of the result set, the page may contain fewer tasks than the limit value. To determine the number of pages in a result set, divide the total value (total number of tasks matching input criteria) by this limit value, and then round up to the next integer. For example, if the total value was 120 (120 total tasks) and the limit value was 50 (show 50 tasks per page), the total number of pages in the result set is three, so the seller would have to make three separate getSchedules calls to view all tasks matching the input criteria.

next
string
The path to the call URI for the next page of results. This value is returned if there is an additional page of results to return from the result set.
offset
integer
The number of results skipped in the result set before listing the first returned result. This value can be set in the request with the offset query parameter.

Note: The items in a paginated result set use a zero-based list where the first item in the list has an offset of 0.

prev
string
The path to the call URI for the previous page of results. This is returned if there is a previous page of results from the result set.
schedules
array of UserScheduleResponse
An array of the schedules on this page. An empty array is returned if the filter criteria excludes all tasks.
total
integer
The total number of schedules that match the input criteria.