The GetLabInstructions command allows you to download the IDLx instructions of a lab as a string.
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".
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.
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
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.
OK Response.
{
"Instructions": "##Welcome to the world of tomorrow!",
"Error": null,
"Status": 1
}{
"Error": "Lab profile not found",
"Status": 0
}The IDLx instructions of a lab.
In the event of an error, this will contain a detailed error message.
0 = Error
1 = Success