vClassroom Course 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 course information or add / update a course.
Get Course (vClassroom)
Provides the details (all list/by id/by filter) of a vClassroom course 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 courses in Litmos Training Operations application (subscription package and bundle are excluded)
URI: GET https://api.viewcentral.com/api/courses/vClassroom
Response Codes:
HTTP Status | Description |
200 | Operation successful. course object returned in response |
400 | Operation not successful. Response contains error information |
404 | Operation not successful. course object not found |
Response Example:
{ "Success": true, "Error": null, "Data": [ { "Active": "Bool", "BusinessUnit": { "ID": "Optional int [max length 4]" }, "ID": "int[max length 4] ", "Name": "string [max length 255]", "DurationType": "Optional string [max length 50]", "Duration": " int [max length 7]", "CourseDisplayName": "Optional String [max length 255]", "Url": "Optional string [max length 255]", "ImageUrl": "Optional string [max length 255]", "ImageUrl2": "Optional string [max length 255]", "NumberOfCredits": "Optional numeric[max length 13]", "ProductId": "Optional string[max length 50]", "RosterDescription": "Optional string[max length 255]", "SummaryDescription": "Optional string[max length Unlimited]", "FullDescription": "Optional string[max length Unlimited]", "TrainingHours": "Optional numeric[max length 8]", "CustomDetail1": "Optional string [max length 2048]", "CustomDetail2": "Optional string [max length 2048]", "CustomDetail3": "Optional string [max length 2048]", "CustomDetail4": "Optional string [max length 2048]", "CustomDetail5": "Optional string [max length 2048]", "CustomDetail6": "Optional string [max length 2048]", "Units": "Optional numeric[max length 7]", "DeliveryMethod": " Required string [max length 1024]", "SortOrder": "Optional int[max length 4]", "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": "/courses/vClassroom/{id}", "Method": "GET" }, { "Rel": "AttendeeGroup", "Href": "/courses/{id}/attendee-groups", "Method": "GET" }, { "Rel": "Prerequisites", "Href": "/courses/{id}/prerequisites", "Method": "GET" }, { "Rel": "Categories", "Href": "/courses/{id}/categories", "Method": "GET" }, { "Rel": "Translations", "Href": "courses/{id}/translations", "Method": "GET" } ] } ] }
Request: Get details of a vClassroom course using the course name as a filter in Litmos Training Operations application (subscription package and bundle are excluded)
URI: GET https://api.viewcentral.com/api/courses/vClassroom?name=
Request Filters : Name = Course name.
Sl.No | Key | Value |
1 | Name | String [max length 255] |
Response Codes:
HTTP Status | Description |
200 | Operation successful. course object returned in response |
400 | Operation not successful. Response contains error information |
404 | Operation not successful. course object not found |
Request: Get details of a vClassrom course using the course id in Litmos Training Operations application (subscription package and bundle are excluded)
URI: GET https://api.viewcentral.com/api/courses/vClassroom/{ID}
Response Codes :
HTTP Status | Description |
200 | Operation successful. course object returned in response |
400 | Operation not successful. Response contains error information |
404 | Operation not successful. course object not found |
Create Course ( vClassroom)
Create a vClassroom course via Litmos Training Operations API. (Provide course object in request body).
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 ViewCentral account management) |
ProductId | Product Id. 1=Learning Management, 2=Event Management |
Username | User account username |
Password | User account password |
Request: Provide created course object in request body
URI: POST https://api.viewcentral.com/api/Courses/vClassroom
Request Example :
{ "Active": "Bool", "BusinessUnit": { "ID": "Optional int [max length 4]" }, "ID": "int[max length 4] ", "Name": "string [max length 255]", "DurationType": "Optional string [max length 50]", "Duration": "Optional string [max length 7]", "CourseDisplayName": "Optional String [max length 255]", "Url": "Optional string [max length 255]", "ImageUrl": "Optional string [max length 255]", "ImageUrl2": "Optional string [max length 255]", "NumberOfCredits": "Optional numeric[max length 13]", "ProductId": "Optional string[max length 50]", "RosterDescription": "Optional string[max length 255]", "SummaryDescription": "Optional string[max length Unlimited]", "FullDescription": "Optional string[max length Unlimited]", "TrainingHours": "Optional numeric[max length 8]", "CustomDetail1": "Optional string [max length 2048]", "CustomDetail2": "Optional string [max length 2048]", "CustomDetail3": "Optional string [max length 2048]", "CustomDetail4": "Optional string [max length 2048]", "CustomDetail5": "Optional string [max length 2048]", "CustomDetail6": "Optional string [max length 2048]", "Units": "Optional numeric[max length 7]", "DeliveryMethod": "Required string [max length 1024]", "SortOrder": "Optional int[max length 4]" }
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 Course ( vClassroom)
Update a vClassroom course via Litmos Training Operations API. (Provide course object in request body).
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 course object in request body
URI: PUT https://api.viewcentral.com/api/Courses/vClassroom/{ID}
Request Example :
{ "Active": "Bool", "BusinessUnit": { "ID": "Optional int [max length 4]" }, "ID": "int[max length 4] ", "Name": "string [max length 255]", "DurationType": "Optional string [max length 50]", "Duration": "Optional int [max length 7]", "CourseDisplayName": "Optional String [max length 255]", "Url": "Optional string [max length 255]", "ImageUrl": "Optional string [max length 255]", "ImageUrl2": "Optional string [max length 255]", "NumberOfCredits": "Optional numeric[max length 13]", "ProductId": "Optional string[max length 50]", "RosterDescription": "Optional string[max length 255]", "SummaryDescription": "Optional string[max length Unlimited]", "FullDescription": "Optional string[max length Unlimited]", "TrainingHours": "Optional numeric[max length 8]", "CustomDetail1": "Optional string [max length 2048]", "CustomDetail2": "Optional string [max length 2048]", "CustomDetail3": "Optional string [max length 2048]", "CustomDetail4": "Optional string [max length 2048]", "CustomDetail5": "Optional string [max length 2048]", "CustomDetail6": "Optional string [max length 2048]", "Units": "Optional numeric[max length 7]", "DeliveryMethod": "Required string [max length 1024]", "SortOrder": "Optional int[max length 4]" }
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 |