Create a class
    • 16 Jul 2024
    • 3 Minutes to read

    Create a class


    Article summary

    Get
    /CreateClass

    Allows you to create a class.

    Security
    API Key
    Header parameter nameapi_key
    Query parameters
    CourseId
    integer (int32) Required

    The internal Id of the course the class is based on

    Name
    string

    The name of the class

    Description
    string

    A short description of the class

    HtmlDescription
    string | null

    A description of the class in HTML

    ConfirmationStatusId
    integer (int32)

    The confirmation status of the class. If blank it will default to 0. Available statuses and their values are as follows:

    • Scheduled = 0
    • Guaranteed To Run = 1
    • Cancelled = 2
    • Rescheduled = 3
    • Tentative = 4
    • Requested = 5
    • Denied = 6
    • Completed = 7
    OrganizationId
    integer (int32)

    The internal Id of the Organization that is running the class. If blank it will default to the API Consumer.

    CompanyId
    integer (int32) | null

    The internal company Id if this class is to be dedicated to a specific company

    DeliveryTypeId
    integer (int32)

    The delivery type of the class. If blank, it will default to Physical unless other values are set to conflict with that setting. If set to Physical any virtual meeting host settings will be lost. Available delivery types are as follows:

    • Physical = 1
    • Virtual = 2
    • Mixed = 3
    VirtualMeetingHostId
    integer (int32) | null

    The internal Id of the virtual meeting host to use if a class is to be run virtually

    CustomVirtualClassroomUrl
    string | null

    The url of the custom virtual classroom used for the class

    PrimaryInstructorId
    integer (int32) | null

    The internal user id of the instructor for the class

    InstructorIds
    array of integer (int32) | null

    The internal user ids of all of the instructors for the class. If a PrimaryInstructorId is not provided, the first instructor in this collection will be set as primary.

    PrimaryClassroomId
    integer (int32) | null

    The internal id of the classroom that this class will take place in

    TimeZoneId
    string

    The .NET system timezone id that the class will be delivered in. If blank it will default to the organizations timezone setting. To get a complete list of supported timezones please use tzutil as timezones are constantly changing.

    MinStudents
    integer (int32)

    The minimum student enrollments for the class to be run. If blank this value will default to the setting at the API Consumer.

    MaxStudents
    integer (int32)

    The maximum student enrollments allowed for the class. If blank this value will default to either the course or API Consumer settings.

    AllowSelfEnrollment
    boolean

    Sets this class to allow students to self-enroll

    IsPublic
    boolean

    This sets if this class will be displayed on the Public Schedule

    DisableLabs
    boolean

    This sets if you would like to disable lab access for this class

    SurveyId
    integer (int32) | null

    The internal id of the student survey to associate with this class. If blank this value will default to the settings at the course or API Consumer.

    StudentSurveyAvailabilityStartTypeId
    integer (int32) | null

    The setting for when the students should begin to see that the survey is available to them. The following options are available:

    • Hours Before Event Ends = 0
    • Hours After Event Begins = 1
    SurveyAvailabilityStartHours
    integer (int32) | null

    The number of hours (either before the event ends, or after the event begins, depending on the setting of StudentSurveyAvailabilityStartTypeId) for when the student survey will become available. If blank it will default to the default settings of the API Consumer.

    SurveyAvailabilityEndDays
    integer (int32) | null

    The number of days that the student survey will be available to students after the event ends. If blank it will default to the default settings of the API Consumer.

    InstructorSurveyId
    integer (int32) | null

    The internal id of the survey to present to instructors of the class. If blank it will default to the default settings of the course or API Consumer.

    OrganizationSurveyId
    integer (int32) | null

    The internal id of the organization survey for the class. If blank it will default to the default settings of the course or API Consumer.

    ExternalId
    string | null

    The class's external ID, usually a unique identifier from the calling system.

    ClassMeetings
    Array of objectRequired

    A collection of ClassMeetings in JSON format.

    object
    Start
    integer (int64)

    When the class meeting starts UTC (in Unix epoch time).

    Example1320876000
    End
    integer (int64)

    When the class meeting ends UTC (in Unix epoch time).

    Example1320876000
    AvailableToOrganizationIds
    string

    A comma separated list of int organization Ids that this class should be available to.

    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).

    ClassId
    integer (int32)

    The ID of the created class.

    Example3456

    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    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.