The following requests relate to adding users to and removing users from Teams via the Litmos Training Engine API.

Note: All requests must be Authenticated.

Get a List of Users that are Assigned to a Team

Returns a list of active users assigned to a Team.

Access Level: Account Owners Only

Request Uri (XML)

GET /teams/{team-id}/users?source=My-App

Response (XML)

Returns a HTTP status code 200 on success with the following body.

<Users>  
 <User>  
  <Id>string [max length 50]</Id>  
  <UserName>ignored</UserName>  
  <FirstName>ignored</FirstName>  
  <LastName>ignored</LastName>
  <Active>true/false</Active> 
  <Email></Email>
  <AccessLevel i:nil="true"/>
  <Brand i:nil="true"/>
 </User>   
 <User>  
  <Id>string [max length 50]</Id> 
  <UserName>ignored</UserName> 
  <FirstName>ignored</FirstName> 
  <LastName>ignored</LastName>
  <Active>true/false</Active> 
  <Email></Email>
  <AccessLevel i:nil="true"/>
  <Brand i:nil="true"/> 
 </User>
</Users>

Get a List of All Teams a User is Assigned to

Returns a list of the Teams a user is assigned to.

Access Level: Account Owners Only

Request Uri

GET /users/{user_id}/teams?source=My-App&format=json

Response

Returns a HTTP status code 200 on success with the following body.

[
    {
        "Id": "",
        "Name": "",
        "TeamCodeForBulkImport": "",
        "ParentTeamId": ""
    }
]

Assign A User to a List of Teams

Add a user to multiple teams. If the user is already assigned to one or more teams in the request, the request will be ignored.

By default, no emails will be sent when the user is added to a team. To have an email sent to the user when they are added to a team, the following query string parameter needs to be added to the request: &sendmessage=true

Access Level: Account Owners Only

Request Uri

POST /users/{user-id}/teams?source=My-App

Request Body (XML)

<Teams> 
   <Team>  
    <Id>string [max length 50]</Id>  
   </Team>  
   <Team>  
    <Id>string [max length 50]</Id>  
   </Team> 
   <Team>  
    <Id>string [max length 50]</Id>  
   </Team>  
   <Team>  
    <Id>string [max length 50]</Id>  
   </Team> 
</Teams>

Request Body (JSON)

[
     {"Id":"string [max length 50]"},
     {"Id":"string [max length 50]"},
     {"Id":"string [max length 50]"},
     {"Id":"string [max length 50]"}
]

Assign A List of Users to a Team

Add a list of users to a Team. If the users already exist in the team or if the user ids are invalid they will be ignored.

By default, no emails will be sent when the user is added to a team. To have an email sent to the user when they are added to a team, the following query string parameter needs to be added to the request: &sendmessage=true

Access Level: Account Owners Only

Request Uri

POST /teams/{team-id}/users?source=My-App

Request Body (XML)

<Users> 
   <User>  
   <Id>string [max length 50]</Id>  
   <UserName>ignored</UserName>  
   <FirstName>ignored</FirstName>  
   <LastName>ignored</LastName>  
   </User>  
   <User>  
   <Id>string [max length 50]</Id>  
   <UserName>ignored</UserName>  
   <FirstName>ignored</FirstName>  
   <LastName>ignored</LastName>  
   </User>  
</Users>

Request Body (JSON)

[
 {
 "Id":"string [max length 50]",
 "UserName": "ignored",
 "FirstName": "ignored",
 "LastName": "ignored"
 }
]

Response

Returns a HTTP status code 201 on success

Remove a User from a Team

Users can only be removed from a Team one per request.

Access Level: Account Owners Only

Request Uri

DELETE /teams/{team-id}/users/{user-id}?source=My-App

Response

Returns a HTTP status code 200 on success

Remove a User from All Teams the User is Assigned to

A User will be removed from all teams the user is assigned to with this request.

Access Level: Account Owners Only

Request Uri

DELETE /users/{{user_id}}/teams?source=My-App

Response

Returns a HTTP status code 200 on success