Service Team REST API
Resource URL Summary
Retrieve the details of a specific Service Team
GET /seiapi/v3/ServiceTeam/${ServiceTeamID}
Create a new Service Team
POST /seiapi/v3/ServiceTeam
Insert or Update the details of a specific Service Team
PUT /seiapi/v3/ServiceTeam/${ServiceTeamID}
Delete a specific Service Team
DELETE /seiapi/v3/ServiceTeam/${ServiceTeamID}
API Specific Parameters
Parameter | Description |
---|---|
| Identifies the Service Team Object. |
HTTP Headers
This API uses the default ServiceMobility HTTP Headers.
API Specifics
Retrieve the details of a specific Service Team
This REST API will return a Service Team with the specified ID. The Service Team with the specified ID must already exist in the system.
URL
GET /seiapi/v3/ServiceTeam/${ServiceTeamID}
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 Service Team Object. Otherwise, on error, the response body will contain a descriptive reason for the error.
Create a new Service Team
This REST API will insert a new Service Team, returning the ID for the created object.
URL
POST /seiapi/v3/ServiceTeam
HTTP Request Body
The HTTP request body must contain a valid Service Team Object.
HTTP Response Body
On success, an HTTP response code of 201 will be returned, and the response body will contain the ID of the created Service Team object.
HTTP Response Body
{ "ServiceTeamID": "" }
Insert or Update the details of a specific Service Team
This REST API will insert a new Service Team with the specified ID into the system, if a Service Team with the specified ID does not already exist in the system.
If, however, the Service Team with the specified ID does already exist in the system, then this REST API will update (i.e. replace) the already existing Service Team with the specified ID with the details of the Service Team supplied in the HTTP Request Body.
URL
PUT /seiapi/v3/ServiceTeam/${ServiceTeamID}
HTTP Request Body
The HTTP request body must contain a valid Service Team Object.
HTTP Response
On success the API will return a response code of 200.
Delete a specific Service Team
This REST API will delete a Service Team with the specified ID from the system. The Service Team with the specified ID must already exist in the system.
URL
DELETE /seiapi/v3/ServiceTeam/${ServiceTeamID}
HTTP Request Body
This request does not require a request body.
HTTP Response
On success an HTTP response code of 200 will be returned. The system will return HTTP response code 410 in case of non-existent Service Team Object.