Returns information about a class
- 11 Oct 2024
- 1 Minute to read
- Print
Returns information about a class
- Updated on 11 Oct 2024
- 1 Minute to read
- Print
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/class
The Class command returns information about a class.
Security
API Key
Header parameter nameapi_key
All methods require an API key, which must be obtained from Skillable. This key is used by Skillable to validate your account. The key can be passed as an HTTP request header with the header name "api_key".
Query parameters
id
stringRequired
The unique identifier of the class, as represented in your organization.
Example1223334444
Responses
200
OK Response.
Example of getting information about a specific class
{
"Id": "4449999",
"Name": "Sample Class",
"Start": 1333267200,
"StartTime": "/Date(1333267200000)/",
"End": 1333299600,
"EndTime": "/Date(1333299600000)/",
"Expires": 1335978000,
"ExpiresTime": "/Date(1335978000000)/",
"Instructor": {
"Id": "65214",
"FirstName": "Demo",
"LastName": "Instructor"
},
"Url": null,
"MaxActiveLabInstances": 20,
"AvailableLabs": [
"17390",
"17432"
],
"Error": null,
"Status": 1
}object
Id
string
The unique identifier of the class, as represented in your organization.
Min length1
Name
string
The name of the class.
Min length1
Start
integer (int64)
When the class starts (in Unix epoch time).
StartTime
string
When the class starts (in Unix epoch time).
End
integer (int64)
When the class ends (in Unix epoch time).
EndTime
string
When the class ends (in Unix epoch time).
Min length1
Expires
integer (int64)
When labs can no longer be associated with the class (in Unix epoch time).
ExpiresTime
string
When labs can no longer be associated with the class (in Unix epoch time).
Min length1
Instructor
object
The class instructor object.
Id
string
The unique identifier of the instructor, as represented in your external system.
Min length1
FirstName
string
The instructor's first name.
Min length1
LastName
string
The instructor's last name.
Min length1
Url
string | null Deprecated
This response property is deprecated. Unless explicitly allowed by Skillable, this field will always be null.
To obtain a class URL, use the ClassAccessUrl API command.
MaxActiveLabInstances
integer
The maximum amount of active lab instances from the class that can be running.
AvailableLabs
Array of integer
Array of Available Labs for the class.
integer
Error
string | null
In the event of an error, this will contain a detailed error message.
Status
integer (int32)
Indicates the status of the API request.
0 = Error
1 = Success
Was this article helpful?