Skip to content

Latest commit

 

History

History
24 lines (20 loc) · 2.26 KB

GetClassesRequest.md

File metadata and controls

24 lines (20 loc) · 2.26 KB

GetClassesRequest

Properties

Name Type Description Notes
class_description_ids int[] The requested class description IDs. [optional]
class_ids int[] The requested class IDs. [optional]
staff_ids int[] The requested IDs of the teaching staff members. [optional]
start_date_time \DateTime The requested start date for filtering. <br />Default: today’s date [optional]
end_date_time \DateTime The requested end date for filtering. <br />Default: today’s date [optional]
client_id string The client ID of the client who is viewing this class list. Based on identity, the client may be able to see additional information, such as membership specials. [optional]
program_ids int[] A list of program IDs on which to base the search. [optional]
session_type_ids int[] A list of session type IDs on which to base the search. [optional]
location_ids int[] A list of location IDs on which to base the search. [optional]
semester_ids int[] A list of semester IDs on which to base the search. [optional]
hide_canceled_classes bool When `true`, canceled classes are removed from the response.<br /> When `false`, canceled classes are included in the response.<br /> Default: false [optional]
scheduling_window bool When `true`, classes outside scheduling window are removed from the response.<br /> When `false`, classes are included in the response, regardless of the scheduling window.<br /> Default: false [optional]
last_modified_date \DateTime When included in the request, only records modified on or after the `LastModifiedDate` specified are included in the response. [optional]
limit int Number of results to include, defaults to 100 [optional]
offset int Page offset, defaults to 0. [optional]

[Back to Model list] [Back to API list] [Back to README]