LTO REST API: vClassroom Schedule (Get, Create, Update)

vClassroom Schedule API (Get, Create, & Update)

Below will highlight the details of the APIs that have be created including what calls for these APIs look like as part of the process that a Litmos Training Operations customer might develop in order to get schedule information or add / update a schedule.

Get Schedule (vClassroom)

Provides the details of schedule via Litmos Training Operations API.

Note: All requests must be Authenticated.

Authentication and Authorization

Information used for API authentication and authorization is submitted in the request header. The following header name/values are required with each request.

Header	Description
CompanyLoginId	Company Login Id (provisioned by LTO account management)
ProductId	Product Id. 1=Learning Management, 2=Event Management
Username	User account username
Password	User account password

Request: Get details of all vClassroom schedules in Litmos Training Operations application (subscription listing and bundle are excluded)

URI: GET https://api.viewcentral.com/api/schedules/vClassroom

Response Codes:

HTTP Status	Description
200	Operation successful. schedule object returned in response
400	Operation not successful. Response contains error information
404	Operation not successful. schedule object not found

Response Example:

{
  "Success": true,
  "Error": null,
  "Data": [
    {
      "ID": "int[max length 4] ",
      "ApprovalStatus": "String [max length 50]",
      "CancelDate": "datetime [yyyy-mm-ddThh:mm:ssZ]"

      "CancelReason": "String [max length 50]",
      "DisplayStartDate": "datetime [yyyy-mm-ddThh:mm:ssZ]",
      "DisplayEndDate": "datetime [yyyy-mm-ddThh:mm:ssZ]",
      "DisplayInAttendeeView": "Bool",
      "DurationType": "String [max length 50]",
      "Duration": "Numeric [max length 7]",
      "StartDate": "datetime [yyyy-mm-ddThh:mm:ssZ]",
      "StartTime": "[Thh:mm:ssZ]",
      "EndDate": "datetime [yyyy-mm-ddThh:mm:ssZ]",
      "EndTime": "[hh:mm:ssZ]",
      "Url": "String [max length 255]",
      "ImageUrl": "String [max length 255]",
      "ImageUrl2": "String [max length 255]",
      "ForecastedSeats": "Int [max length 4]",
      "ForecastedExp": "String [max length 50]",
      "ForecastedRev": "String [max length 50]",
      "IsSubSchedule": "Bool",
      "Language": "String [max length 50]",
      "MinSeats": "Int [max length 4]",
      "MaxSeats": "Int [max length 4]",
      "NumberOfCredits": "Numeric [max length 13]",
      "RegistrationStartDate": "datetime [yyyy-mm-ddThh:mm:ssZ]",
      "RegistrationEndDate": "datetime [yyyy-mm-ddThh:mm:ssZ]",
      "RegistrationEndTime": "ddThh:mm:ssZ",
      "GroupId": "String [max length 50]",
      "Name": "String [max length 255]",
      "Status": "String [max length 50]",
      "SubStatus": "String [max length 50]",
      "AutoAttend": "Bool", //exist
      "SeatsTaken": 0,
      "TimeZone": "String [max length 72]",
      "TrainingHours": "Numeric [max length 8]",
      "CustomDetail1": "String [max length 1024]",
      "CustomDetail2": "String [max length 1024]",
      "CustomDetail3": "String [max length 1024]",
      "CustomDetail4": "String [max length 1024]",
      "CustomDetail5": "String [max length 1024]",
      "CustomDetail6": "String [max length 1024]",
      "InheritBusinessUnitFromCourse": "Bool",
      "UseCourseDuration": "Bool",
      "Active": "Bool", //added
      "CourseTypes": [
        "String",
        "String"
      ],
      "VirtualMeetingHost": "String [max length 50]",
      "VirtualMeetingUrl": "String [max length 1024]",
      "VirtualCustomText1": "String [max length 1024]",
      "VirtualCustomText2": "String [max length 1024]",
      "VirtualAudienceCustomText1": "String [max length 1024]",
      "Virtual Audience CustomText2": "String [max length 1024]",
      "VirtualHostCustomText1": "String [max length 1024]",
      "VirtualHostCustomText2": "String [max length 1024]",
      "JoinMeetingExpirationDate": "datetime [yyyy-mm-ddThh:mm:ssZ]",
      "JoinMeetingDuration": "Numeric [max length 10]",
      "BusinessUnit": {
        "ID": "Int [max length 4]"
      },
      "Location": {
        "ID": "Required Int [max length 4]"
      },
      "SubLocation": {
        "ID": " Optional Int [max length 4]"
      },
      "Course": {
        "ID": "Required Int [max length 4]"
      },
      "DeliveryMethod": "Required string [max length 1024]",
      "Modified": {
        "CreatedBy": "string [max length 50]",
        "CreatedDate": "datetime [yyyy-mm-ddThh:mm:ssZ]",
        "UpdatedBy": "string [max length 50]",
        "UpdatedDate": "datetime [yyyy-mm-ddThh:mm:ssZ]"
      },
      "Links": [
        {
          "Rel": "Self",
          "Href": "/schedules/vClassroom/{id}",
          "Method": "GET"
        },
        {
          "Rel": "Schedule Personnel",
          "Href": "/schedules/{id}/instructors",
          "Method": "GET"
        },
        {
          "Rel": "Schedule Equipments",
          "Href": "/schedules/{id}/equipments",
          "Method": "GET"
        },
        {
          "Rel": "Schedule Translations",
          "Href": "/schedules/{id}/translations",
          "Method": "GET"
        },
        {
          "Rel": "Schedule Pricing",
          "Href": "/schedules/{id}/price",
          "Method": "GET"
        }
      ]
    }
  ]
}

Request: Get details of a vClassroom schedule using filter in Litmos Training Operations application (subscription listing and bundle are excluded)

URI: GET https://api.viewcentral.com/api/schedules/vClassroom?name=

Request Filters : Name = schedule name.

Sl.No	Key	Value
1	Name	String [max length 255]

Response Codes:

HTTP Status	Description
200	Operation successful. schedule object returned in response
400	Operation not successful. Response contains error information
404	Operation not successful. schedule object not found

Request: Get details of a vClassroom schedule using schedule id in Litmos Training Operations application (subscription listing and bundle are excluded)

URI: GET https://api.viewcentral.com/api/schedules/vClassroom/{ID}

Response :

HTTP Status	Description
200	Operation successful. schedule object returned in response
400	Operation not successful. Response contains error information
404	Operation not successful. schedule object not found

Request: Get details of a vClassroom schedule using start date in Litmos Training Operations application (subscription listing and bundle are excluded)

URI: GET https://api.viewcentral.com/api/schedules/vClassroom?ScheduleStartDateFrom="datetime [yyyy-mm-ddThh:mm:ssZ]"&ScheduleStartDateTo="datetime [yyyy-mm-ddThh:mm:ssZ]"

Response :

HTTP Status	Description
200	Operation successful. schedule object returned in response
400	Operation not successful. Response contains error information
404	Operation not successful. schedule object not found

Create Schedule ( vClassroom)

Create a vClassroom schedule via Litmos Training Operations API. (Provide course object in request body).

Create vClassroom Schedule (“Virtual Meetings” type only)

Once the schedule is created, if a meeting provider is needed, a Litmos Training Operations administrator will need to manually update the vClassroom type and manually associate the meeting provider details within their Litmos Training Operations instance

Note: All requests must be Authenticated.

Authentication and Authorization

Information used for API authentication and authorization is submitted in the request header. The following header name/values are required with each request.

Header	Description
CompanyLoginId	Company Login Id (provisioned by LTO account management)
ProductId	Product Id. 1=Learning Management, 2=Event Management
Username	User account username
Password	User account password

Request: Provide created schedule object in request body

URI: POST https://api.viewcentral.com/api/Schedules/vClassroom

Request Example :

{
  "ID": "int[max length 4] ",
  "ApprovalStatus": "String [max length 50]",
  "CancelDate": "datetime [yyyy-mm-ddThh:mm:ssZ]",
  "CancelReason": "String [max length 50]",
  "DisplayStartDate": "datetime [yyyy-mm-ddThh:mm:ssZ]",
  "DisplayEndDate": "datetime [yyyy-mm-ddThh:mm:ssZ]",
  "DisplayInAttendeeView": "Bool",
  "DurationType": "String [max length 50]",
  "Duration": "Numeric [max length 7]",
  "StartDate": "datetime [yyyy-mm-ddThh:mm:ssZ]",
  "StartTime": "[Thh:mm:ssZ]",
  "EndDate": "datetime [yyyy-mm-ddThh:mm:ssZ]",
  "EndTime": "[hh:mm:ssZ]",
  "Url": "String [max length 255]",
  "ImageUrl": "String [max length 255]",
  "ImageUrl2": "String [max length 255]",
  "ForecastedSeats": "Int [max length 4]",
  "ForecastedExp": "String [max length 50]",
  "ForecastedRev": "String [max length 50]",
  "IsSubSchedule": "Bool",
  "Language": "String [max length 50]",
  "MinSeats": "Int [max length 4]",
  "MaxSeats": "Int [max length 4]",
  "NumberOfCredits": "Numeric [max length 13]",
  "RegistrationStartDate": "datetime [yyyy-mm-ddThh:mm:ssZ]",
  "RegistrationEndDate": "datetime [yyyy-mm-ddThh:mm:ssZ]",
  "RegistrationEndTime": "ddThh:mm:ssZ",
  "GroupId": "String [max length 50]",
  "Name": "String [max length 255]",
  "Status": "String [max length 50]",
  "SubStatus": "String [max length 50]",
  "AutoAttend": "Bool", //exist
  "SeatsTaken": 0,
  "TimeZone": "String [max length 72]",
  "TrainingHours": "Numeric [max length 8]",
  "CustomDetail1": "String [max length 1024]",
  "CustomDetail2": "String [max length 1024]",
  "CustomDetail3": "String [max length 1024]",
  "CustomDetail4": "String [max length 1024]",
  "CustomDetail5": "String [max length 1024]",
  "CustomDetail6": "String [max length 1024]",
  "InheritBusinessUnitFromCourse": "Bool",
  "UseCourseDuration": "Bool",
  "Active": "Bool", //added
  "CourseTypes": [
    "String",
    "String"
  ],
  "VirtualMeetingHost": "String [max length 50]",
  "VirtualMeetingUrl": "String [max length 1024]",
  "VirtualCustomText1": "String [max length 1024]",
  "VirtualCustomText2": "String [max length 1024]",
  "VirtualAudienceCustomText1": "String [max length 1024]",
  "Virtual Audience CustomText2": "String [max length 1024]",
  "VirtualHostCustomText1": "String [max length 1024]",
  "VirtualHostCustomText2": "String [max length 1024]",
  "JoinMeetingExpirationDate": "datetime [yyyy-mm-ddThh:mm:ssZ]",
  "JoinMeetingDuration": "Numeric [max length 10]",
  "BusinessUnit": {
    "ID": "Optional Int [max length 4]"
  },
  "Personnel": {
    "ID": "Optional Int [max length 4]"
  },
  "Equipment": {
    "ID": "Optional Int [max length 4]"
  },
  "Location": {
    "ID": "Required Int [max length 4]"
  },
  "SubLocation": {
    "ID": "Optional Int [max length 4]"
  },
  "Course": {
    "ID": "Required Int [max length 4]"
  },
  "DeliveryMethod": "Required String [max length 1024]"
}

Response Codes:

HTTP Status	Description
200	Operation successful. schedule object returned in response
400	Operation not successful. Response contains error information
404	Operation not successful. schedule object not found

Update Schedule (vClassroom)

Update a vClassroom schedule via Litmos Training Operations API. (Provide course object in request body).

Once the schedule is created, the vClassroom type as well as any provider details cannot be updated by the API, and will need to be manually updated by a Litmos Training Operations administrator within their Litmos Training Operations instance

Note: All requests must be Authenticated.

Authentication and Authorization

Information used for API authentication and authorization is submitted in the request header. The following header name/values are required with each request.

Header	Description
CompanyLoginId	Company Login Id (provisioned by LTO account management)
ProductId	Product Id. 1=Learning Management, 2=Event Management
Username	User account username
Password	User account password

Request: Provide updated schedule object in request body

URI: PUT https://api.viewcentral.com/api/schedules/vClassroom/{ID}

Request Example :

{
  "ID": "Int [max length 4]",
  "ApprovalStatus": "String [max length 50]",
  "CancelDate": "datetime [yyyy-mm-ddThh:mm:ssZ]",
  "CancelReason": "String [max length 50]",
  "DisplayStartDate": "datetime [yyyy-mm-ddThh:mm:ssZ]",
  "DisplayEndDate": "datetime [yyyy-mm-ddThh:mm:ssZ]",
  "DisplayInAttendeeView": "Bool",
  "DurationType": "String [max length 50]",
  "Duration": "Numeric [max length 7]",
  "StartDate": "datetime [yyyy-mm-ddThh:mm:ssZ]",
  "StartTime": "[Thh:mm:ssZ]",
  "EndDate": "datetime [yyyy-mm-ddThh:mm:ssZ]",
  "EndTime": "[hh:mm:ssZ]",
  "Url": "String [max length 255]",
  "ImageUrl": "String [max length 255]",
  "ImageUrl2": "String [max length 255]",
  "ForecastedSeats": "Int [max length 4]",
  "ForecastedExp": "String [max length 50]",
  "ForecastedRev": "String [max length 50]",
  "IsSubSchedule": "Bool",
  "Language": "String [max length 50]",
  "MinSeats": "Int [max length 4]",
  "MaxSeats": "Int [max length 4]",
  "NumberOfCredits": "Numeric [max length 13]",
  "RegistrationStartDate": "datetime [yyyy-mm-ddThh:mm:ssZ]",
  "RegistrationEndDate": "datetime [yyyy-mm-ddThh:mm:ssZ]",
  "RegistrationEndTime": "ddThh:mm:ssZ",
  "GroupId": "String [max length 50]",
  "Name": "String [max length 255]",
  "Status": "String [max length 50]",
  "SubStatus": "String [max length 50]",
  "AutoAttend": "Bool", //exist
  "SeatsTaken": 0,
  "TimeZone": "String [max length 72]",
  "TrainingHours": "Numeric [max length 8]",
  "CustomDetail1": "String [max length 1024]",
  "CustomDetail2": "String [max length 1024]",
  "CustomDetail3": "String [max length 1024]",
  "CustomDetail4": "String [max length 1024]",
  "CustomDetail5": "String [max length 1024]",
  "CustomDetail6": "String [max length 1024]",
  "InheritBusinessUnitFromCourse": "Bool",
  "UseCourseDuration": "Bool",
  "Active": "Bool", //added
  "CourseTypes": [
    "String",
    "String"
  ],
  "VirtualMeetingHost": "String [max length 50]",
  "VirtualMeetingUrl": "String [max length 1024]",
  "VirtualCustomText1": "String [max length 1024]",
  "VirtualCustomText2": "String [max length 1024]",
  "VirtualAudienceCustomText1": "String [max length 1024]",
  "Virtual Audience CustomText2": "String [max length 1024]",
  "VirtualHostCustomText1": "String [max length 1024]",
  "VirtualHostCustomText2": "String [max length 1024]",
  "JoinMeetingExpirationDate": "datetime [yyyy-mm-ddThh:mm:ssZ]",
  "JoinMeetingDuration": "Numeric [max length 10]",
  "BusinessUnit": {
    "ID": "Optional Int [max length 4]"
  },
  "Personnel": {
    "ID": "Optional Int [max length 4]"
  },
  "Equipment": {
    "ID": " Optional Int [max length 4]"
  },
  "Location": {
    "ID": "Required Int [max length 4]"
  },
  "SubLocation": {
    "ID": " Optional Int [max length 4]"
  },
  "Course": {
    "ID": "Required Int [max length 4]"
  },
  "DeliveryMethod": "Required string [max length 1024]"
}

Response Codes:

HTTP Status	Description
200	Operation successful. schedule object returned in response
400	Operation not successful. Response contains error information
404	Operation not successful. schedule object not found

Litmos Training Operations Documentation

APIs

LTO REST API: vClassroom Schedule (Get, Create, Update)

Useful Links

In this article

Related articles