Get a List of All the Users that are Assigned to a Team
Returns a list of active users assigned to a Team.
Request Uri:
GET /teams/{team-id}/users?
Response Body: (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>
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
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
201 Success
Remove a User from a Team
Users can only be removed from a Team one per request.
Request Uri:
DELETE /teams/{teamid}/users/{userid}?
Response Header:
200 OK
Comments
0 comments
Article is closed for comments.