Login
    Contents x
    Search for classes
    • 16 Jul 2024
    • 5 Minutes to read
    • Print
    Contents

    Search for classes

    • Updated on 16 Jul 2024
    • 5 Minutes to read
    • Print
    Article summary

    Get
    /SearchClasses

    Allows you to search for classes belonging to your organization.

    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.

    courseId
    integer (int32)

    An optional parameter used to filter for classes for a particular course.

    startsAfter
    integer (int64)

    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.

    startsBefore
    integer (int64)

    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.

    endsAfter
    integer (int64)

    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.

    endsBefore
    integer (int64)

    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.

    lastModifiedAfter
    integer (int64)

    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.

    lastModifiedBefore
    integer (int64)

    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.

    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.

    customFields
    Array of object

    An optional parameter used to filter for classes based on custom field values.

    object
    Id
    integer (int32)

    The Id of the custom field you are searching against.

    Example1234
    ComparisonType
    integer (int32)

    The Compairson Type for the search filter. Will default to 0 if not included.
    0 - Equals
    5 - Not Equals

    Example0
    Value
    string

    The value you would like to filter that custom field by in string representation.

    ExampleSome Value
    Responses
    200

    OK Response

    Expand All
    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 (ClassSearchResult)

    See ClassSearchResult

    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
    CourseExternalId
    integer (int32)

    The courses's ExternalId identifier the class is based on.

    Example6789
    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 Name
    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

    IsPublic
    boolean | null

    Distinguishes if the class is public

    ExampleTrue
    Description
    string | null

    The class's Description

    ExampleSample Description
    ClassroomId
    integer (int32) | 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

    CustomFields
    Array of object (CustomField)

    See CustomField

    object
    Name
    string

    The name of the custom field.

    ExampleMyCustomText
    TexValue
    string

    The value of the custom field.

    ExampleWoohoo!
    DeliveryTypeId
    integer (int32)

    The class's delivery identifier

    Example34
    InstructorId
    integer (int32) | null

    The class's primary instructor identifier

    InstructorFirstName
    string | null

    The class's primary instructor first name

    InstructorLastName
    string | null

    The class's primary instructor last name

    InstructorIds
    Array of integer

    The internal user ids for all of the instructors assigned to the class, including the primary.

    Example[ "12345", "98765" ]
    integer (int32)
    EnableClassTrainingKey
    boolean

    Distinguishes if the class allows registration via a class training key

    ExampleFalse
    ClassTrainingKey
    string | null

    The class training key (if enabled) that will allow for self registration in the class

    ExampleABC1234
    SessionTimes
    Array of object (ClassSession)

    See SessionTimes

    object
    Start
    integer (int64)

    When the class starts (in Unix epoch time).

    Example1320876000
    End
    integer (int64)

    When the class ends (in Unix epoch time).

    Example1320876000
    Was this article helpful?
    What's Next
    Change password!
    Changing your password will log you out immediately. Use the new password to log back in.
    Change profile
    Success!
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.
    Logout