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