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 Users in a Team
Returns a list of active users assigned to a Team.
Access Level: Account Owners Only
Request Uri
GET /teams/{team-id}/users?
Response
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> </User> <User> <Id>string [max length 50]</Id> <UserName>ignored</UserName> <FirstName>ignored</FirstName> <LastName>ignored</LastName> </User>
</Users>
Assign 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: Trainers Only
Request Uri
POST /teams/{team-id}/users
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: Trainers Only
Request Uri
DELETE /teams/{team-id}/users/{user-id}
Response
Returns a HTTP status code 200 on success
Comments
0 comments
Article is closed for comments.