GET /api/v3/class/ID

Retrieves details of a specified class

Request Path

GET /api/v3/class/{classId}

Request Payload

None

Parameters

{classId} The id of the class. To retrieve class ids, use GET /api/v3/class
Example: COMcB7gdfab2DFm0WqklnX6Q2

Response Example

{
  "id": "COMcB7gdfab2DFm0WqklnX6Q2",
  "name": "My Class",
  "shortId": "2vs2t",
  "policyId": "POstwZpTbLpqpGR2yI4cbGOw2",
  "policyName": "2 hours",
  "isUsingClassTypes": false,
  "blueprintId": "BPvY9ME2CJ8dg-TyTeUvcKzw2",
  "blueprintName": "Testing Blueprint",
  "blueprintToken": "LZOGAB",
  "cloudName": "CloudShare",
  "timeZoneId": "Eastern Standard Time",
  "projectId": "PR_E3-ZqX0AvUr_p3TgD-wtg2",
  "projectName": "API Testing",
  "creatorName": "The Architect",
  "creatorEmail": "architect@cloudshare.com",
  "instructorVupId": "VPmIJNV_kFBDLrveM0Gmr5ug2",
  "instructorName": "john doe",
  "defaultDurationInMinutes": 480,
  "allowStartDateEditing": false,
  "limitEarlyAccess": 0,
  "studentPassphrase": "password",
  "useCustomInvitationEmail": false,
  "showCourseAddressField": true,
  "address": null,
  "customInvitationEmailSubject": null,
  "customInvitationEmailBody": null,
  "defaultInvitationEmailSubject": "${CourseName} - Virtual Lab Access",
  "defaultInvitationEmailBody": "You have been invited to access your own private ${BlueprintName} virtual lab (using CloudShare)",
  "showPermitAccessToNonRegisteredStudent": true,
  "allowEditDefaultsWhenPermitAccessToNonRegistered": true,
  "permitAccessToNonRegisteredStudent": true,
  "showMaxStudentsField": true,
  "maxStudents": 5,
  "maxLimitOnMaxStudentField": 60,
  "customFieldsValues": [
      {
          "id": "TFTQBKbIH5V2br3eiEdxW9-g2",
          "order": 1,
          "name": "clientId",
          "type": 0,
          "isRequired": false,
          "regex": "",
          "defaultValue": null,
          "value": null
      }
  ],
  "instructorEmail": "jd@cloudshare.com",
  "timeZoneName": "(UTC-05:00) Eastern Time (US & Canada)",
  "startDate": "01/01/2015 12:00 AM",
  "endDate": "01/31/2015 12:00 AM",
  "status": "expired"
}