Document toolboxDocument toolbox

Service Contract REST API

Owned by Andrew Hill (Deactivated)
Last updated: Oct 02, 2024 by Jason Andrew
2 min read

3.18.1

The Service Contract REST API is used to mange service contracts/extended warranty plans in the system. The service contracts protect assets against the failures or damages once manufacturer's warranty has expired. The extended warranty plans may be administered by extended warranty providers, manufacturers or the retailers.  

On this page:

Related pages:

Resource URL Summary

Retrieve the details of a specific Service Contract

GET /seiapi/v3/ServiceContract/${ServiceContractID}

Insert or Update the details of a specific Service Contract

PUT /seiapi/v3/ServiceContract/${ServiceContractID}

Delete a specific Service Contract

DELETE /seiapi/v3/ServiceContract/${ServiceContractID}

API Specific Parameters

Parameter
Description
${ServiceContractID}Identifies the Service Contract Object.

HTTP Headers

This API uses the default ServiceMobility HTTP Headers.


API Specifics

Retrieve the details of a specific Service Contract

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

URL

GET /seiapi/v3/ServiceContract/${ServiceContractID}

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

Service Contract Object

JSON Format 
{
	"_t" : "serviceContract",
	"_v" : "1.0",
	"BillToAccountNum": "",
	"Constraints": {
		"ExcludeOrderTypes": ["", ""],
		"IncludeOrderTypes": ["", ""],
		"ExcludeServiceCodes": [["", ""], ["", ""]],
		"IncludeServiceCodes": [["", ""], ["", ""]]
	},
	"ContactNumber": "",
	"ContractID": "",
	"ContractProvider": "",
	"Rules": {
		"AuthorizationNumPattern": "",
		"IsAuthorizationNumReq": true,
		"IsSerialNumReq": true,
		"SerialNumPattern": ""
	},
	"Warranty": {
		"InWarranty": true,
		"Copay": ""
	}
}

Insert or Update the details of a specific Service Contract

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

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

URL

PUT /seiapi/v3/ServiceContract/${ServiceContractID}

HTTP Request Body

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

HTTP Response

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

Delete a specific Service Contract

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

URL

DELETE /seiapi/v3/ServiceContract/${ServiceContractID}

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