• Free Trial
  • Products
    • LMSThe world’s easiest-to-use learning management system.
    • CoursesA robust library of off-the-shelf learning content.
  • Solutions
    • By Use Case
      • Employee Training
      • Sales Training
      • Customer Training
      • Partner Training
      • Compliance Training
      • View all
    • By Industry
      • Technology
      • Nonprofit
      • Retail
      • Hospitality
      • Healthcare
      • View all
  • Customers
    • Learn more about Litmos customer success stories.
      • Case Studies
      • Video Testimonials
      • I Love Litmos
      • Lenny Awards
    • Featured Customer
      • Sabre, a global travel technology provider, increases revenue by using Litmos to train their sales and technical teams.
  • Pricing
  • Resources
    • Ebooks & Infographics
    • Webinars & Podcasts
    • Events
    • Integrations
    • Blog
  • About
    • Awards
    • Careers
    • Sustainability
  • Free Trial
Litmos
Choose language EN
  • Deutsch
  • English
  • Español
  • Français
  • Italiano
  • Português
  • 中国
  • 日本
  • 한국어
Log in
Contact us
Support
Search
  • Free Trial
  • Products
    • LMSThe world’s easiest-to-use learning management system.
    • CoursesA robust library of off-the-shelf learning content.
  • Solutions
    • By Use Case
      • Employee Training
      • Sales Training
      • Customer Training
      • Partner Training
      • Compliance Training
      • View all
    • By Industry
      • Technology
      • Nonprofit
      • Retail
      • Hospitality
      • Healthcare
      • View all
  • Customers
    • Learn more about Litmos customer success stories.
      • Case Studies
      • Video Testimonials
      • I Love Litmos
      • Lenny Awards
    • Featured Customer
      • Sabre, a global travel technology provider, increases revenue by using Litmos to train their sales and technical teams.
  • Pricing
  • Resources
    • Ebooks & Infographics
    • Webinars & Podcasts
    • Events
    • Integrations
    • Blog
  • About
    • Awards
    • Careers
    • Sustainability
  • Free Trial

Litmos Training Operations Documentation

APIs

Home › Litmos Training Operations Documentation › LTO REST API: eLearning Course (Get, Create, Update)

LTO REST API: eLearning Course (Get, Create, Update)

ELearning 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 (eLearning) 

Provides the details (all list/by id/by filter) of an eLearning 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 eLearning courses in Litmos Training Operations application (subscription package and bundle are excluded)  

URI: GET https://api.viewcentral.com/api/courses/eLearning 

 

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”: true/false, 

  “BusinessUnit”: { 

  “ID”: “Optional int [max length 4]”, 

  }, 

“AccessDuration”:”int[max length 6]”, 

 “AccessLimit”: “int[max length 6]”, 

“ContentProvider”: “int[max length 4]”, 

“LitmosId”: “int[max length 4]”,// Applicable for eLearning  Litmos course 

“ID”: “int[max length 4] “, 

 “Name”: “string [max length 255]”, 

“DurationType”:”string [max length 50]”, 

 “Duration”: “int [max length 7]”, 

“CourseDisplayName”:“String [max length 255]”, 

“HostCourseId”:“String [max length 50]”, // Applicable for eLearning Scorm course 

“Url”:  “string [max length 255]”, 

 “ImageUrl”: “string [max length 255]” , 

 “ImageUrl2”:  “string [max length 255]”, 

 “NumberOfCredits”: “numeric[max length 13]”, 

 “ProductId”: “string[max length 50]”, 

“Units”: “int[max length 7]”, 

 “SummaryDescription”: “string[max length unlimited]”,  

  “FullDescription”: “string[max length unlimited]”,  

 “TrainingHours”: “numeric[max length 8]”, 

 “CustomDetail1”: “string [max length 2048]”, 

 “CustomDetail2”: “string [max length 2048]”, 

 “CustomDetail3”: “string [max length 2048]”, 

 “CustomDetail4”: “string [max length 2048]”, 

 “CustomDetail5”: “string [max length 2048]”, 

 “CustomDetail6”: “string [max length 2048]”, 

“DeliveryMethod”: “string [max length 1024]”, 

              “ScormHighScoreFeature”: true/false,  // Applicable for eLearning Scorm course 

 “SortOrder”: “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/eLearning/{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 an eLearning 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/eLearning?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 an eLearning course using the course id in Litmos Training Operations application (subscription package and bundle are excluded) 

URI:   GET :      https://api.viewcentral.com/api/courses/eLearning/{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 ( eLearning) 

Create an eLearning course via Litmos Training Operations API. (Provide course object in request body). 

Once the course is created, content will need to be manually added to the created course 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 created course object in request body  

URI : POST  :: https://api.viewcentral.com/api/Courses/eLearning 

  

Request Example : 

{ 

  “Active”: true/false, 

 “BusinessUnit”: { 

  “ID”: “Optional int [max length 4]”, 

  }, 

“AccessDuration”:”Optional int[max length 6]”, 

 “AccessLimit”: “Optional int[max length 6]”, 

“ContentProvider”: “Required int[max length 4]”, 

“LitmosId”: “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]”, 

“HostCourseId”:“ String [max length 50]”, 

“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]”, 

“Units”: “Optional int [max length7]”, 

 “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]”, 

“DeliveryMethod”: “Required string [max length 1024]”, 

“ScormHighScoreFeature”: true/false, 

 “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 ( eLearning) 

Update an eLearning course via Litmos Training Operations API. (Provide course object in request body). 

Once the course is created, the eLearning “ContentProvider” cannot be updated by the API, and will need to be manually updated (as needed) 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 course object in request body  

URI : PUT:: https://api.viewcentral.com/api/Courses/eLearning/{ID]} 

  

Request Example : 

{ 

  “Active”: true/false, 

 “BusinessUnit”: { 

 “ID”: “Optional int [max length 4]”, 

 }, 

“AccessDuration”:”Optional int[max length 6]”, 

 “AccessLimit”: “Optional int[max length 6]”, 

“LitmosId”: “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]”, 

 “Summary Description”: “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]”, 

“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 

No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of Litmos.

The information contained herein may be changed without prior notice. Some software products marketed by Litmos and its distributors contain proprietary software components of other software vendors. National product specifications may vary.

These materials are provided by Litmos for informational purposes only, without representation or warranty of any kind, and Litmos or its affiliated companies shall not be liable for errors or omissions with respect to the materials. The only warranties for Litmos company products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.

In particular Litmos or its affiliated companies have no obligation to pursue any course of business outlined in this document or any related presentation, or to develop or release any functionality mentioned therein. This document, or any related presentation, and Litmos or its affiliated companies’ strategy and possible future developments, products, and/or platform directions and functionality are all subject to change and may be changed by Litmos or its affiliated companies at any time for any reason without notice.

The information in this document is not a commitment, promise, or legal obligation to deliver any material, code, or functionality. All forward-looking statements are subject to various risks and uncertainties that could cause actual results to differ materially from expectations. Readers are cautioned not to place undue reliance on these forward-looking statements, and they should not be relied upon in making purchasing decisions.

© 2022 Litmos or a Litmos affiliate company. All rights reserved.

Litmos and other Litmos products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of Litmos (or a Litmos affiliate company) in the United States and other countries. All other product and service names mentioned are the trademarks of their respective companies.

In this article

Related articles

  1. LTO REST API: Attendee (Get Create, Update, Delete)
  2. LTO REST API: Location (Get, Create, Update)
  3. LTO REST API: Vendor (Get, Create, Update)

Also of Interest

  • Multilingual Content Training
  • Online Learning Tools
  • Training for Customers and Consumers
  • Compare e-learning Platforms
  • Hotel Management Training
  • LMS
  • eLearning Platform
  • What is a learning management system?
  • See Additional Resources

Solutions by Use Case

  • Employee Training
  • Customer Training
  • Sales Training
  • Operations Training
  • Gig Worker Training
  • Contractor Training
  • Supplier Training

Solutions by Industry

  • Technology
  • Nonprofit
  • Retail
  • Hospitality
  • Healthcare

Contact Us

Contact
USA: +1 925 490 0401
AUS: +61 3 7066 4851
Email
sales@litmos.com
Support
Address
Contact Us
Litmos Reviews Litmos Reviews
Litmos Careers Careers

© 2023 Litmos US, L.P. and affiliates. All rights reserved.

  • Privacy Statement
  • Terms & Conditions
  • Website Terms