Returns a single use URL to access a class
- 11 Oct 2024
- 1 Minute to read
- Print
Returns a single use URL to access 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
/ClassAccessUrl
The ClassAccessUrl command returns a single use URL to access the class management page.
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.
Example4449999
Responses
200
OK Response.
Example of a successful response with a valid class
{
"Url": "https://labondemand.com/class/access/ab1c2345-6d7b-890e-f1gh-234ij5kl6m7n",
"Error": null,
"Status": 1
}
Example of an error response when class is not found
{
"Error": "Class not found",
"Status": 0
}
object
Url
string
The single use URL to access the class management page.
Min length1
Error
string | null
In the event of an error, this will contain a detailed error message.
Status
integer
Indicates the status of the API request.
0 = Error
1 = Success
Was this article helpful?