Update IDLx instructions of a lab profile

Prev Next
Post
/updatelabinstructions

The UpdateLabInstructions command allows you to update the IDLx instructions of a lab. In order to support longer instructions lengths, this method requires an HTTP POST. The Content-Type of your post should be set to application/x-www-form-urlencoded.

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 to update.

Example2393048
lang
string

Allows you to select the language of the Instruction Set. Using this in connection with instructionsId will allow you to update 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 update 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 updated 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
instructions
stringRequired

The IDLx instructions. This should included in the body of the post.

ExampleUpdated from the API
Responses
200

OK Response.

Example of successfully updating the lab instructions
{
  "Status": 1,
  "Error": null
}
object
Status
integer (int32)

Indicates the status of the API request.
0 = Error
1 = Success

Error
string | null

In the event of an error, this will contain a detailed error message.