Allows you to search for classes belonging to your organization.
A 0-based index of the paged results you wish to receive. In general, you should start with a value of zero and increment it as you need to retrieve additional results. If not supplied, a value of 0 is used (the first page of results).
Indicates how many results you want per page. if not supplied, a default value of 100 is used.
The value you want to sort by. If not supplied, a default value of "Start" will be used. You can append " DESC" after the sort value to sort descending. For example, "Start DESC" would sort by class start time in descending order. Possible values:
- Name
- Course
- ConfirmationStatus
- Start
- End
- Organization
An optional parameter used to filter for classes by name. When specified, only classes that have names that contain or match the this value will be returned.
An optional parameter used to filter for classes for a particular course.
An optional parameter used to filter for classes that start after a specified date. When used in conjunction with the "startsBefore" parameter, it becomes possible to filter for a given time range. This should be provided in unix epoch format, which is the number of seconds that have elapsed since midnight UTC January 1st, 1970.
An optional parameter used to filter for classes that start before a specified date. When used in conjunction with the "startsAfter" parameter, it becomes possible to filter for a given time range. This should be provided in unix epoch format, which is the number of seconds that have elapsed since midnight UTC January 1st, 1970.
An optional parameter used to filter for classes that end after a specified date. When used in conjunction with the "endsBefore" parameter, it becomes possible to filter for a given time range. This should be provided in unix epoch format, which is the number of seconds that have elapsed since midnight UTC January 1st, 1970.
An optional parameter used to filter for classes that end before a specified date. When used in conjunction with the "endsAfter" parameter, it becomes possible to filter for a given time range. This should be provided in unix epoch format, which is the number of seconds that have elapsed since midnight UTC January 1st, 1970.
An optional parameter used to filter for classes that were modified after a specified date. When used in conjunction with the "lastModifiedBefore" parameter, it becomes possible to filter for a given time range. This should be provided in unix epoch format, which is the number of seconds that have elapsed since midnight UTC January 1st, 1970.
An optional parameter used to filter for classes that were modified before a specified date. When used in conjunction with the "lastModifiedAfter" parameter, it becomes possible to filter for a given time range. This should be provided in unix epoch format, which is the number of seconds that have elapsed since midnight UTC January 1st, 1970.
An optional parameter used to filter for classes that have available labs. If true is passed, only classes with labs are returned. If false is passed, only classes without labs are returned.
An optional parameter used to filter for classes that are available online. If true is passed, only online classes are returned. If false is passed, only physically delivered classes are returned.
An optional parameter used to filter for classes based on custom field values.
The Id of the custom field you are searching against.
The Compairson Type for the search filter. Will default to 0 if not included.
0 - Equals
5 - Not Equals
The value you would like to filter that custom field by in string representation.
OK Response
Indicates the status of the API request.
0 = Success
10 = Error
20 = Not found
30 = Invalid integration key
Error details. This will only have a value if an error was encountered. The status property will also be set to Error (10).
The total number of results that match the search conditions, not all of which may be in the current result set.
The total number of result pages that match the search conditions.
See ClassSearchResult
The class's unique identifier
The unique identifier of the course the class is based on.
The courses's ExternalId identifier the class is based on.
The name of the course the class is based on.
Indicates the current status of whether the class will run.
- Scheduled = 0
- GuaranteedToRun = 1
- Cancelled = 2
- Rescheduled = 3
- Tentative = 4
- Requested = 5
- Denied = 6
- Completed = 7
When the class starts (in Unix epoch time).
When the class ends (in Unix epoch time).
The class's organization identifier
The class's organization name
The number of enrolled users in the class.
The minimum number of students the organization requires to be in the class to run it.
The minimum number of students enrolled
The maximum number of students enrolled
The class's virtual meeting host identifier
The class's VirtualMeeting identifier
The class's custom VirtualMeeting Url
Distinguishes if the class is public
The class's Description
The class's primary classroom identifier
Classroom address
Classroom address
Classroom address
Classroom address
Classroom address
Classroom address
The class's HTML Description
See CustomField
The name of the custom field.
The value of the custom field.
The class's delivery identifier
The class's primary instructor identifier
The class's primary instructor first name
The class's primary instructor last name
The internal user ids for all of the instructors assigned to the class, including the primary.
Distinguishes if the class allows registration via a class training key
The class training key (if enabled) that will allow for self registration in the class
See SessionTimes
When the class starts (in Unix epoch time).
When the class ends (in Unix epoch time).