Retrieve all running or saved labs for a particular user account

  • Updated on Dec 13, 2024
  • 2 minute(s) read
Prev Next
Get
/userrunningandsavedlabs

The UserRunningAndSavedLabs command retrieves all labs that are currently running or saved for a particular user account.

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
userid
stringRequired

The unique identifier used to identify the user in within your organization.

Example555
Responses
200

OK Response.

Example of retrieving all labs that are currently running or saved for a particular user account
{
  "RunningLabs": [
    {
      "LabInstanceId": 3497,
      "LabProfileId": 5,
      "LabProfileName": "Demo Lab 1",
      "LabProfileNumber": "LAB001",
      "Start": 1338223121,
      "Expires": 1338244721,
      "Url": null,
      "IsExam": false
    }
  ],
  "SavedLabs": [
    {
      "LabInstanceId": 3493,
      "LabProfileId": 1,
      "LabProfileName": "Demo Lab 2",
      "LabProfileNumber": "LAB002",
      "MinutesRemaining": 359,
      "Saved": 1337987655,
      "Expires": 1338592455,
      "SaveInProgress": false,
      "IsExam": false,
      "SubmittedForGrading": false
    }
  ],
  "Status": 1,
  "Error": null
}
Expand All
object
RunningLabs
Array of object

Array of RunningLab objects.

object
LabInstanceId
integer (int64)

The unique identifier of the lab instance.

LabProfileId
integer (int32)

The unique identifier of the lab profile the lab instance is based on.

LabProfileName
string

The name of the lab profile the lab instance is based on.

LabProfileNumber
string

The number/code of the lab profile the lab instance is based on.

Start
integer (int64)

When the lab instance was started (in Unix epoch time).

Expires
integer (int64)

When the lab will expire (in Unix epoch time).

Url
string | null

This response property is deprecated. Unless explicitly allowed by Skillable, this field will always be null. To obtain an access URL, use the LabAccessUrl command.

IsExam
boolean

Indicates whether the lab is scored.

SavedLabs
Array of object

Array of SavedLab objects.

object
LabInstanceId
integer (int64)

The unique identifier of the lab instance.

LabProfileId
integer (int32)

The unique identifier of the lab profile the lab instance is based on.

LabProfileName
string

The name of the lab profile the lab instance is based on.

LabProfileNumber
string

The number/code of the lab profile the lab instance is based on.

MinutesRemaining
integer (int32)

The number of minutes remaining for the student to complete the lab (when resumed).

Saved
integer (int64)

When the lab was saved (in Unix epoch time).

Expires
integer (int64)

When the saved lab will expire (in Unix epoch time). The student must resume the lab for this date, or the lab will be deleted.

SaveInProgress
boolean

True/false indicating whether the lab is currently in the process of being saved.

IsExam
boolean

Indicates whether the lab is scored.

SubmittedForGrading
boolean

Indicates whether the lab has been submitted for grading and is in a saved state while awaiting scoring. This will only be true for scored labs.

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.