Versions Compared

Key

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

Status
colourGreen
title3.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.  


Panel
borderColorgrey
bgColorwhitesmoke

On this page:

Table of Contents
maxLevel2

Related pages:


Resource URL Summary

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

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 REST Object Definitions Configuration Related Objects Service Contract Object.

Include Page
_Default HTTP Headers
_Default HTTP Headers
 



API Specifics


Panel
borderColor#D3D3D3

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

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

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

Insert excerpt
REST Object Definitions Configuration Related Objects Service Contract ObjectREST Object Definitions Configuration Related Objects
Service Contract Object


Panel
borderColor#D3D3D3

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

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

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

HTTP Request Body

The HTTP request body must contain a valid REST Object Definitions Configuration Related Objects Service Contract Object.

HTTP Response

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


Panel
borderColor#D3D3D3

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

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

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 REST Object Definitions Configuration Related Objects Service Contract Object.