Document toolboxDocument toolbox

Warranty Constraints REST API


3.43.0

The Warranty Constraints REST API is used to mange constraints/pre-conditions for warranties in the system. A single constraint definition can cover work order evaluation criteria based on asset's age or model number. Work Order has to satisfy all the eligible warranty constraints before mobile worker can change a work order to "In Warranty".

On this page:

Related pages:

Resource URL Summary

Retrieve the details of a specific Warranty Constraint

GET /seiapi/v3/WarrantyConstraints/${ConstraintID}

Insert or Update the details of a specific Warranty Constraint

PUT /seiapi/v3/WarrantyConstraints/${ConstraintID}

Bulk Insert or Update the details of Warranty Constraint

PUT /seiapi/v3/WarrantyConstraints/

Delete a specific Warranty Constraint

DELETE /seiapi/v3/WarrantyConstraints/${ConstraintID}

API Specific Parameters

Parameter
Description
${ConstraintID}Identifies the Warranty Constraint Object.

HTTP Headers

This API uses the default ServiceMobility HTTP Headers.



API Specifics

Retrieve the details of a specific Warranty Constraint

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

URL

GET /seiapi/v3/WarrantyConstraints/${ConstraintID}

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


Insert or Update the details of a specific Warranty Constraint

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

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

URL

PUT /seiapi/v3/WarrantyConstraints/${ConstraintID}

HTTP Request Body

The HTTP request body must contain a valid Warranty Constraint Object.

HTTP Response

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

Bulk Insert or Update the details of Warranty Constraints

This REST API will insert new Warranty Constraints with the specified IDs into the system, if the Warranty Constraints with the specified IDs do not already exist in the system.

If, however, the Warranty Constraints with the specified IDs do already exist in the system, then this REST API will update (i.e. replace) the already existing Warranty Constraints with the specified IDs with the details of the Warranty Constraints supplied in the HTTP Request Body.


URL

PUT /seiapi/v3/WarrantyConstraints

HTTP Request Body

The HTTP request body must be a JSON array of one or more Warranty Constraint Object definitions.

[
    {
        // WarrantyConstraint Object
    },
    {
        // WarrantyConstraint Object
    },
    {
        // WarrantyConstraint Object
    }
]

HTTP Response

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

Delete a specific Warranty Constraint

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

URL

DELETE /seiapi/v3/WarrantyConstraints/${ConstraintID}

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 Warranty Constraint Object.