Returns instructions for a specific lab
- 11 Oct 2024
- 1 Minute to read
- Print
Returns instructions for a specific lab
- Updated on 11 Oct 2024
- 1 Minute to read
- Print
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/GetLabInstructions
The GetLabInstructions command allows you to download the IDLx instructions of a lab as a string.
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
integer (int32) Required
The ID of the lab profile that will be the source of the instructions. The profile must be owned by the organization on the API consumer.
Example2393048
lang
string
Allows you to select the language of the Instruction Set. Using this in connection with instructionsId will allow you to select a specific lab Instruction Set in the specified language if they have been defined within the lab profile.
NOTE: If this parameter is omitted, or if the specified language is not specified on one of the Instruction sets in a lab profile, then the default language as defined in the Lab Profile âž” Manage Instructions Sets option will be used instead.
en = English
es = Spanish
fr = French
de = German
pt = Portuguese
ja = Japanese
zh-hans = Simplified Chinese
zh-hant = Traditional Chinese
ko = Korean
Valid values[ "en", "es", "fr", "de", "pt", "ja", "zh-hans", "zh-hant", "ko" ]
Exampleen
instructionsId
string
When specified, Skillable will attempt to retrieve the selected instructions. If not specified, or the instruction Id could not be found, the default instructions, as defined on the Lab Profile, will be used instead. This is a string that cannot contain spaces.
NOTE: To be able to see how to use this parameter, add the column "API Example" in the Manage Instruction Sets feature while editing the instructions.
ExampleBase-01
Responses
200
OK Response.
Example of retrieving the instructions from a lab
{
"Instructions": "##Welcome to the world of tomorrow!",
"Error": null,
"Status": 1
}Example when trying to retrieve instructions for a nonexistent lab profile
{
"Error": "Lab profile not found",
"Status": 0
}object
Instructions
string | null
The IDLx instructions of a lab.
Error
string | null
In the event of an error, this will contain a detailed error message.
Status
integer (int32)
0 = Error
1 = Success
Was this article helpful?