Search for public class schedules
- 16 Jul 2024
- 2 Minutes to read
- Print
Search for public class schedules
- Updated on 16 Jul 2024
- 2 Minutes to read
- Print
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/SearchPublicClassSchedule
Allows you to search the public class schedule for your organization, including classes made available to your organization by partner organizations.
Security
API Key
Header parameter nameapi_key
Query parameters
pageIndex
integer (int32)
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).
pageSize
integer (int32)
Indicates how many results you want per page. if not supplied, a default value of 100 is used.
sort
string
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
name
string | null
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.
hasLabs
boolean
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.
availableOnline
boolean
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.
Responses
200
OK Response
object
Status
integer (int32)
Indicates the status of the API request.
0 = Success
10 = Error
20 = Not found
30 = Invalid integration key
Example10
Error
string | null
Error details. This will only have a value if an error was encountered. The status property will also be set to Error (10).
TotalCount
integer (int32)
The total number of results that match the search conditions, not all of which may be in the current result set.
Example1
TotalPages
integer (int32)
The total number of result pages that match the search conditions.
Example1
Results
Array of object (PublicClassSearchResult)
See PublicClassSearchResult
object
Id
integer (int32)
The class's unique identifier
Example56794
CourseId
integer (int32)
The unique identifier of the course the class is based on.
Example5678
CourseName
string
The name of the course the class is based on.
ExampleSample course Name
ConfirmationStatusId
integer (int32)
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
Example2223
Start
integer (int64)
When the class starts (in Unix epoch time).
Example1320757200
End
integer (int64)
When the class ends (in Unix epoch time).
Example1320757200
OrganizationId
integer (int32)
The class's organization identifier
Example123
OrganizationName
string
The class's organization name
ExampleSample Organization Id
NumOpen
integer (int32) | null
The number of enrolled users in the class.
Example6
NumEnroll
integer (int32) | null
The minimum number of students the organization requires to be in the class to run it.
Example45
MinStudents
integer (int32)
The minimum number of students enrolled
Example2
MaxStudents
integer (int32)
The maximum number of students enrolled
Example5
VirtualMeetingHostId
integer (int32) | null
The class's virtual meeting host identifier
Example14
VirtualMeetingId
string | null
The class's VirtualMeeting identifier
CustomVirtualClassroomUrl
string | null
The class's custom VirtualMeeting Url
ClassroomId
string | null
The class's primary classroom identifier
Example12345
ClassroomAddress1
string | null
Classroom address
Example123 Sample Dr.
ClassroomAddress2
string | null
Classroom address
ClassroomCity
string | null
Classroom address
ExampleSample City
ClassroomState
string | null
Classroom address
ExampleFlorida
ClassroomCountry
string | null
Classroom address
ExampleSample County
ClassroomZip
string | null
Classroom address
Example12345
HtmlDescription
string | null
The class's HTML Description
DeliveryTypeId
integer (int32)
The class's delivery identifier
Example34
Was this article helpful?