The following requests relate to listing courses via the Litmos Training Engine API.

Note: All requests must be Authenticated. If you want to list,add & remove courses to a user see People – List, Add & Remove Courses

List Courses

Get a list of all courses within your organisation.

Access Level: Account Owners Only

Request Uri

GET /courses

Response

<Courses>  
  <Course>  
   <Id>string [max length 50]</Id> 
   <Code>string [max length 50]</Id>  
   <Name>string [max length 255]</Id>  
   <Active>true/false</Active>  
   <ForSale>true/false</ForSale>  
   <OriginalId>integer</OriginalId> 
   <Description>string</Description>  
   <EcommerceShortDescription>string</EcommerceShortDescription>               
   <EcommerceLongDescription>string</EcommerceLongDescription>  
   <CourseCodeForBulkImport>string [max length 255]</CourseCodeForBulkImport>
   <Price>integer</Price>
   <AccessTillDate>integer</AccessTillDate>
   <CourseTeamLibrary>true/false</CourseTeamLibrary>
  </Course>  
  <Course>  
   ...  
  </Course>  
</Course>

Note:

• OriginalId can be used as part of a single sign in process to take a user straight into a particular course.
• ForSale indicates if the course has been marked for sale via the Litmos UI

GET a Course – returns a single Course

GET /courses/[courseid]

https://api.litmos.com/v1.svc/courses/[courseid]?apikey=[apikey]&source=[source]

Response:

<Course xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> 
  <Id></Id> 
  <Name></Name>
  <Active></Active> 
  <ForSale>true/false</ForSale>
  <OriginalId></OriginalId>
  <Description></Description>
  <EcommerceShortDescription>string<EcommerceShortDescription>
  <CommerceLongDescription>string</EcommerceLongDescription>
  <CourseCodeForBulkImport></CourseCodeForBulkImport>
  <Price></Price>
  <AccessTillDate>datetime [iso 8601 format]</AccessTillDate>
  <CourseTeamLibrary>true/false</CourseTeamLibrary>
</LearningPath>