Service Team Users REST API
Resource URL Summary
Retrieve a list of Users associated with a specific Service Team
GET /seiapi/v3/ServiceTeam/${ServiceTeamID}/Users Â
Insert or Update a list of Users associated with a specific Service Team
PUT /seiapi/v3/ServiceTeam/${ServiceTeamID}/UsersÂ
API Specific Parameters
Parameter | Description |
---|---|
| Identifies the Service Team Object. |
HTTP Headers
This API uses the default ServiceMobility HTTP Headers.
API Specifics
Retrieve a list of Users associated with a specific Service Team
This REST API will return a list of Users currently assigned to the Service Team with the specified ID from the system. The Service Team with the specified ID must already exist in the system.
URL
GET /seiapi/v3/ServiceTeam/${ServiceTeamID}/Users
HTTP Request Body
This request does not require a request body.Â
HTTP Response Body
On success, an HTTP response code of 200 will be returned, and the response body will contain a collection of User IDs. Otherwise, on error, the response body will contain a descriptive reason for the error.Â
{ "Users" : [ // A collection of UserIDs ] }
Insert or Update a list of Users associated with a specific Service Team
This REST API will insert a new list of Users to be associated with the Service Team with the specified ID into the system, if a list of Users associated with the Service Team with the specified ID does not already exist in the system.
If, however, the Service Team with the specified ID already has a list of associated Users in the system, then this REST API will update (i.e. replace) the existing list of Users associated with the Service Team with the specified ID with the list of users supplied in the HTTP Request Body.
URL
PUT /seiapi/v3/ServiceTeam/${ServiceTeamID}/Users
HTTP Request Body
The HTTP request body must contain a collection of valid users.
{ "Users" : [ // A collection of UserIDs ] }
HTTP Response Body
On success the API will return a response code of 200.