GET /api/v3/class/ID/students

Retrieves information about the students in a class

Request Path

GET /api/v3/class/{classId}/students?isFull={isFull}

Request Payload

None

Parameters

{classId} The ID of the class. To retrieve class IDs, use GET /api/v3/class
{isFull} Boolean.

  • true. Returns details of the VMs in each student’s environment as well as other details
  • false. Returns a shorter list of details, which does not include the VM details

Response Examples

IsFull=false


[
    {
        "status": 1,
        "envStatus": 5,
        "envCommands": [],
        "envId": "ENQi3ZoBEUCY5Kv3AA6wKo0w2",
        "firstName": "Hector",
        "lastName": "Pounders",
        "email": "hector@cloudshare.com",
        "id": "SDcJ5YHCfmKWXGgHJdiK0UEQ2"
    }
]

IsFull=true

[
    {
       "vms": [
           {
               "id": "MCenC7qMgpzbZMd9EP_fwfWA2",
               "name": "machine 1"
           }
       ],
       "status": 2,
       "envStatus": 2,
       "envCommands": [
           "Suspend",
           "RevertEnv",
           "Delete"
       ],
       "envId": "ENzoOVHhh0EcRbc6SrXsBQNg2",
       "firstName": "Hector",
       "lastName": "Pounders",
       "email": "hector@cloudshare.com",
       "id": "SDcJ5YHCfmKWXGgHJdiK0UEQ2"
    }
]

Response Parameters

{status} Student status:

  • 0 = None – The student was invited to the class
  • 1 = Participated – The student participated in the class
  • 2 = LoggedIn – The student is currently in the class
{envStatus} Environment status:

  • 2 = Ready – The environment is ready to be used
  • 3 = Suspended – The environment is suspended
  • 4 = Archived – The environment is awaiting deletion, can be recovered to be suspended by a user with appropriate permissions
  • 5 = Deleted – The environment was deleted
  • 7 = Publishing – Taking a snapshot
  • 8 = Preparing – Making necessary preparations to bring environment to Ready state
  • 9 = CreationFailed – There was an error trying to create an environment
  • 12 = EditingNetworks – Applying changes done in the environment network setting, potentially requiring machine reboots