Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Status
colourGreen
title3.20.0

The Service Area Teams REST API is used to mange service teams associated with a specific service area. 

A service team can only be assigned to a single service area. Adding a service team to a service area will automatically remove them from the previously assigned service area. 

Panel
borderColorgrey
bgColorwhitesmoke

On this page:

Table of Contents
maxLevel2

Related pages:

Resource URL Summary

Panel
borderColorgrey
bgColorwhitesmoke

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

ParameterDescription

${ServiceAreaID}

Identifies the Service Area Object.

Include Page
_URI Default HTTP Headers
_URI Default HTTP Headers

 


API Specifics

Panel
borderColor#D3D3D3

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

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

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. 

Code Block
languagejs
titleJSON Format
firstline1
linenumberstrue
{
    "ServiceTeams" : [
        // A collection of ServiceTeamIDs
    ]
}
Panel
borderColor#D3D3D3

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

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

PUT /seiapi/v3/ServiceArea/${ServiceAreaID}/Teams

HTTP Request Body

The HTTP request body must contain a collection of valid service teams.

Code Block
languagejs
titleJSON Format
firstline1
linenumberstrue
{
    "ServiceTeams" : [
        // A collection of ServiceTeamIDs
    ]
}

HTTP Response Body

On success the API will return a response code of 200.