Retrieve class information by id
- 16 Jul 2024
- 2 Minutes to read
- Print
Retrieve class information by id
- Updated on 16 Jul 2024
- 2 Minutes to read
- Print
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/GetClass/{id}
Allows you to get information about a class.
Security
API Key
Header parameter nameapi_key
Path parameters
id
integer (int32) Required
The ID of the class to retrieve
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).
Results
Array of object (Class)
See Class
object
Id
integer (int32)
The class's unique identifier
Example56794
ExternalId
integer (int32)
The class's ExternalId identifier
Name
string
The class's name
ExampleSample Class Name
Description
string | null
The class's Description
ExampleSample Description
HtmlDescription
string | null
The class's HTML Description
Enabled
boolean
Gives the class's status
ExampleTrue
ConfirmationStatusId
integer (int32)
Gives the class's ConfirmationStatusId
Example5634
CourseId
integer (int32)
The class's course identifier
Example5678
OrganizationId
integer (int32)
The class's organization identifier
Example123
OrganizationName
string
The class's organization name
ExampleSample Organization Id
CompanyId
integer (int32) | null
The class's company identifier
Example1235
DeliveryTypeId
integer (int32)
The class's delivery identifier
Example34
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
PrimaryInstructorId
integer (int32) | null
The class's primaryInstructor identifier
PrimaryInstructorFirstName
string | null
The class's primary instructor first name
PrimaryInstructorLastName
string | null
The class's primary instructor last name
PrimaryClassroomId
integer (int32) | null
The class's primary classroom identifier
Example4535
MaterialsListId
integer (int32) | null
The class's materials list identifier
Example45
Start
integer (int64)
When the class starts (in Unix epoch time).
Example1320757200
End
integer (int64)
When the class ends (in Unix epoch time).
Example1320757200
MinStudents
integer (int32)
The minimum number of students enrolled
Example2
MaxStudents
integer (int32)
The maximum number of students enrolled
Example5
AllowSelfEnrollment
boolean
Distinguishes if self enrollment is allowed
ExampleFalse
IsPublic
boolean
Distinguishes if the class is public
ExampleTrue
EnableClassTrainingKey
boolean
Distinguishes if the class allows registration via a class training key
ExampleTrue
ClassTrainingKey
string | null
The class training key (if enabled) that will allow for self registration in the class
ExampleABC1234
DisableLabs
boolean
Distinguishes if the class is disabled
ExampleFalse
EnableEnrollmentNotifications
boolean
Distinguishes if enrollment notifications are enabled
ExampleTrue
IsUniqueDelivery
boolean
Distinguishes if unique delivery is enabled
ExampleFalse
RecordingModeId
integer (int32)
The class's recording Mode identifier
Example6743
CustomText1
string
CustomText1
ExampleSample custom text 1
CustomText2
string
CustomText2
ExampleSample custom text 2
CustomText3
string | null
CustomText3
CustomText4
string | null
CustomText4
CustomText5
string | null
CustomText5
CustomBool1
boolean
CustomBool1
ExampleTrue
CustomBool2
boolean
CustomBool2
ExampleTrue
CustomBool3
boolean
CustomBool3
ExampleTrue
CustomBool4
boolean
CustomBool4
ExampleFalse
CustomBool5
boolean
CustomBool5
ExampleFalse
CustomDropdown1
string | null
CustomDropdown1
CustomDropdown2
string | null
CustomDropdown2
SurveyId
integer (int32) | null
The class's survey identifier
Example334523
StudentSurveyAvailabilityStartTypeId
integer (int32)
Identifies when Student survey is becomes available in relation to SurveyAvailabilityStartHours. 0 for hours before event ends; 1 for hours after event ends.
Example55534
SurveyAvailabilityStartHours
integer (int32)
Number of hours after class end that the survey is available
Example4
SurveyAvailabilityEndDays
integer (int32)
Number of days after class end that the survey is available
Example30
InstructorSurveyId
integer (int32) | null
The class's survey identifier for instructors
Example356
OrganizationSurveyId
integer (int32) | null
The class's survey identifier for organizations
Example1034
OrganizationSurveyResponseId
integer (int32) | null
The class's survey response identifier for organizations
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
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!
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?