Learning Paths (API) - Get a list of Learning Paths, Users Assigned, Courses and Assign

The following requests relate to creating, updating, and getting Learning Paths via the Litmos API.  

Note:  All requests must be Authenticated.

GET Learning Paths – returns a list of learning paths

GET /learningpaths

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

Response:

<LearningPaths>
<LearningPath>
  <Id></Id>
  <Name></Name>
  <Description></Description>
  <Active></Active>
  <OriginalId></OriginalId>
  <ForSale>true/false</ForSale>
  <EcommerceShortDescription>string</EcommerceShortDescription>              
  <EcommerceLongDescription>string</EcommerceLongDescription>  
  <AccessTillDate>YYYY-MM-DDTHH:MM:SS.SSS</AccessTillDate>
</LearningPath>
<LearningPath>
 ...
</LearningPath>
</LearningPaths>

GET a Learning Path – returns a single learning path

GET /learningpaths/[learningpathid]

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

Response:

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

 

GET Learning Path Courses – returns a list of courses associated to that learning path

GET/learningpaths/[learningpathid]/courses

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

Response:

<Courses>
<Course>
  <Id> </Id>
  <Code></Code>
  <Name> </Name>
  <Description/>
  <Active></Active>
  <ForSale></ForSale>
  <OriginalId></OriginalId>
  <Price></Price>
</Course>
<Course>
  ...
</Course> 
</Courses>

GET Learning Path Users – returns a list of users assigned to that learning path

GET/learningpaths/[learningpathid]/users

https://api.litmos.com/v1.svc/learningpaths/[learningpathid]/users?apikey=[apikey]&source=[source]

Response:

<Users>
<User>
  <Id></Id>
  <UserName></UserName>
  <FirstName></FirstName>
  <LastName></LastName>
  <Completed></Completed>
<PercentageComplete></PercentageComplete>
</User>
<User>
  ...
</User>
</Users>

 

GET Learnings paths assigned to a specific User – returns a list of learning paths assigned to a user

GET/users/[userid]/learningpaths

https://api.litmos.com/v1.svc/users/[userid]/learningpaths?apikey=[apikey]&source=[source]

Response:

<LearningPaths>
<LearningPath>
  <Id></Id>
  <Name></Name>
  <Active></Active>
  <OriginalId></OriginalId>
  <Complete></Complete>
  <PercentageComplete></PercentageComplete>
  <AssignedDate></AssignedDate>
  <StartDate></StartDate>
  <DateCompleted></DateCompleted>
  <ResultId></ResultId>
  <AccessTillDate></AccessTillDate>
</LearningPath>
<LearningPath>
  ...
</LearningPath>
</LearningPaths>

POST request to assign users to a Learning Path

POST/users/[userid]/learningpaths

https://api.litmos.com/v1.svc/ users /[userid]/learningpaths?apikey=[apikey]&source=[source]

Request:

<LearningPaths>
  <LearningPath>
    <Id>[LearningPathId]</Id>
  </LearningPath>
  <LearningPath>
    ...
  </LearningPath>
</LearningPaths>

 

Response: 201 Created

 

DELETE a user from a Learning Path

DELETE/users/[userid]/learningpaths/[learningpath-id]

https://api.litmos.com/v1.svc/ users /[userid]/learningpaths?apikey=[apikey]&source=[source]

Response: 201 Created

GET all Learning Paths assigned to a TEAM

GET/teams/[teamid]/learningpaths

https://api.litmos.com/v1.svc/teams/[teamid]/learningpaths?apikey=[apikey]&source=[source]

Response Body:

<LearningPaths>
<LearningPath>
  <Id></Id>
  <Name></Name>
  <Description></Description>
  <Active></Active>
  <OriginalId></OriginalId>
</LearningPath>
<LearningPath>
  ...

</LearningPath>
</LearningPaths>

 

Assign Learning Paths to a TEAM

POST/teams/[teamid]/learningpaths

https://api.litmos.com/v1.svc/teams/[teamid]/learningpaths?apikey=[apikey]&source=[source]

Request Body:

<LearningPaths>
<LearningPath>
  <Id>[LearningPathId]</Id>
</LearningPath>
</LearningPaths>

Response code - 201 Created

Delete Learning Paths from a TEAM

DELETE/teams/[teamid]/learningpaths

https://api.litmos.com/v1.svc/teams/[teamid]/learningpaths?apikey=[apikey]&source=[source]

Request Body:

<LearningPaths>
<LearningPath>
  <Id>[LearningPathId]</Id>
</LearningPath>
</LearningPaths>

Response code - 201 Created