Retrieve the details of a specific Service Area

GET /seiapi/v3/ServiceArea/${ServiceAreaID}    

Create a new Service Area

POST /seiapi/v3/ServiceArea 

Insert or Update the details of a specific Service Area

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

Delete a specific Service Area

DELETE /seiapi/v3/ServiceArea/${ServiceAreaID}    

Retrieve the details of a specific Service Area

This REST API will return a Service Area with the specified ID. The Service Area with the specified ID must already exist in the system.

URL

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 Area Object. Otherwise, on error, the response body will contain a descriptive reason for the error. 

 {
 	"Name": "",
 	"PriceListID": "",
	"PriceListName": "",
 	"ServiceAreaID": "",
 	"TimeZone": ""
}

Create a new Service Area

This REST API will insert a new Service Area, returning the ID for the created object.

URL

HTTP Request Body

The HTTP request body must contain a valid Service Area Object.

HTTP Response

On success, an HTTP response code of 201 will be returned, and the response body will contain the ID of the created Service Area object.

HTTP Response Body

{
    "ServiceAreaID": ""
}

Insert or Update the details of a specific Service Area

This REST API will insert a new Service Area with the specified ID into the system, if a Service Area with the specified ID does not already exist in the system.

If, however, the Service Area with the specified ID does already exist in the system, then this REST API will update (i.e. replace) the already existing Service Area with the specified ID with the details of the Service Area supplied in the HTTP Request Body.

URL

HTTP Request Body

The HTTP request body must contain a valid Service Area Object.

HTTP Response

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

Delete a specific Service Area

This REST API will delete a Service Area with the specified ID from the system. The Service Area with the specified ID must already exist in the system.

URL

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 Area Object.