The following requests relate to Assigning and Unassign Courses to a Team 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

Assign Courses

Add a list of courses to a Team. If the courses already exist in the team, or if the course Ids are invalid, they will be ignored. Emails will be sent notifying the users of the course assignments, providing they have previously logged into their account. It is possible to disable sending course invitation emails by adding the following querystring parameter to the end of the uri : &sendmessage=false.

Important Notes:

• A course is be added to a team or to the course team library using the same request. . To add the course to both the team and the course team library, make two separate requests with different values for <CourseTeamLibrary>true/false</CourseTeamLibrary> parameter.
• In order to assign a course to the Team Courses tab, CourseTeamLibrary>false</CourseTeamLibrary> must be passed in the request body. If the value is true, then the course will only be added to the Team Course library.

Access Level: Account Owners Only

Request Uri

POST /teams/{teamid}/courses

Request Body

<Courses> 
  <Course> 
   <Id>string [max length 50]</Id> 
   <CourseTeamLibrary>true/false</CourseTeamLibrary>
   </Course> 
   <Course> 
   <Id>string [max length 50]</Id> 
  </Course> 
</Courses>

Response

Returns a HTTP status code 201 on success

Assign to all sub-teams

Append this to the URI "&includesubteams=true"

Unassign Courses

Remove a list of courses from a Team. If the courses do not exist in the team, or if the course Ids are invalid, they will be ignored.

Important Notes:

• A course can’t be removed from the team and the course team library in one request. To remove the course from both the team and course team libraries, make two separate requests with different values for <CourseTeamLibrary>true/false</CourseTeamLibrary> field.
• In order to remove a course from the Team Course Library, <CourseTeamLibrary>true </CourseTeamLibrary> value must be passed. To remove the course from the Team Courses tab the value should be <CourseTeamLibrary>false</CourseTeamLibrary>.

Access Level: Trainers Only

Request Uri

DELETE /teams/{teamid}/courses

Request Body

<Courses> 
  <Course> 
   <Id>string [max length 50]</Id>
   <CourseTeamLibrary>true/false</CourseTeamLibrary>   
   </Course> 
   <Course> 
   <Id>string [max length 50]</Id> 
  </Course> 
</Courses>

Response

Returns a HTTP status code 201 on success

Assign Learning Paths

Add a list of learning paths to a Team. If the learning paths already exist in the team, or if the learning path Id's are invalid, they will be ignored. Emails will be sent notifying the users of the learning path assignments, providing they have previously logged into their account. It is possible to disable sending learning path invitation emails by adding the following querystring parameter to the end of the uri : &sendmessage=false.

Important Notes:

• A learning path is be added to a team or to the learning path team library using the same request. To add the learning path to both the team and the learning path team library, make two separate requests with different values for the <LearningPathTeamLibrary>true/false</LearningPathTeamLibrary> field.
• In order to assign a learning path to the Team Learning Paths tab, <LearningPathTeamLibrary>false</LearningPathLibrary> must be passed in the request body. If the value is true, then the learning path will only be added to the Team Learning Path library.

Access Level: Account Owners Only

Request Uri

POST /teams/{teamid}/learningpaths

Request Body

<LearningPaths> 
  <LearningPath> 
   <Id>string [max length 50]</Id> 
   <LearningPathTeamLibrary>true/false</LearningPathTeamLibrary>
   </LearningPath> 
   <LearningPath> 
   <Id>string [max length 50]</Id> 
  </LearningPath> 
</LearningPaths>

Response

Returns a HTTP status code 201 on success

Unassign Learning Paths

Remove a list of Learning Paths from a Team. If the learning paths do not exist in the team, or if the learning path Ids are invalid, they will be ignored.

Important Notes:

• A learning path can’t be removed from the team and the Learning Path Team Library in one request. To remove the course from both the Team Library and Learning Path Team libraries, make two separate requests with different values for the <LearningPathTeamLibrary>true/false</LearningPathTeamLibrary> field.
• In order to remove a learning path from the Team Learning Path Library, <LearningPathTeamLibrary>true </LearningPathTeamLibrary> value must be passed. To remove the learning path from the Team LearningPaths tab the value should be <CourseTeamLibrary>false</CourseTeamLibrary>.

Access Level: Trainers Only

Request Uri

DELETE /teams/{teamid}/learningpaths

Request Body

<LearningPaths> 
  <LearningPath> 
   <Id>string [max length 50]</Id>
   <LearningPathTeamLibrary>true/false</LearningPathTeamLibrary>   
   </LearningPath> 
   <LearningPath> 
   <Id>string [max length 50]</Id> 
  </LearningPath> 
</LearningPaths>

Response

Returns a HTTP status code 201 on success