Versions Compared

Key

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


Status
colourGreen
title3.35.0

The Concessions REST API is used to mange concessions/special promotion campaigns in the system. A single concession definition can cover multiple product types and sub-types. Purchase price concessions or discounts for products will reflect in the invoice for a work order.


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 Concession

GET /seiapi/v3/Concessions/${ConcessionID}

Insert or Update the details of a specific Concession

PUT /seiapi/v3/Concessions/${ConcessionID}

Bulk Insert or of Update the details of Concessions

PUT /seiapi/v3/Concessions/

Delete a specific Concession

DELETE /seiapi/v3/Concessions/${ConcessionID}

API Specific Parameters

Parameter
Description
${ConcessionID}Identifies the REST Object Definitions Work Order Activity Related Objects Concession Object.

Include Page
_Default HTTP Headers
_Default HTTP Headers



API Specifics


Panel
borderColor#D3D3D3

Retrieve the details of a specific Concession

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

URL

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

GET /seiapi/v3/Concessions/${ConcessionID}

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 Work Order Activity Related Objects Concession Object. Otherwise, on error, the response body will contain a descriptive reason for the error. 



Panel
borderColor#D3D3D3

Insert or Update the details of a specific Concession

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

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

URL

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

PUT /seiapi/v3/Concessions/${ConcessionID}

HTTP Request Body

The HTTP request body must contain a valid REST Object Definitions Work Order Activity Related Objects Concession Object.

HTTP Response

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


Panel
borderColor#D3D3D3

Bulk Insert or Update the details of

Concessions

a specific Concession

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

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


URL

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

PUT /seiapi/v3/Concessions

HTTP Request Body

The HTTP request body must be a JSON array of one or more REST Object Definitions Work Order Activity Related Objects Concession Object definitions.

[
    {
        // Concession Object
    },
    {
        // Concession Object
    },
    {
        // Concession Object
    }
]

HTTP Response

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


Panel
borderColor#D3D3D3

Delete a

specific Concession

specific Service Contract

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

URL

Panel
borderColorgrey
bgColorwhitesmoke
borderStylesolid

DELETE /seiapi/v3/Concessions/${ConcessionID}

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 Work Order Activity Related Objects Concession Object.