PMI Incentives API

PMI Incentives API

1.0.0OAS 3.0

API providing the functionality to retrieve a list of incentives applicable for a given Campaign Code or Scheme Code.

API Base URL
  • Server 1:https://ec2-18-202-229-190.eu-west-1.compute.amazonaws.com:8443
Security
oauth2 (oauth2)

Use ‘test-client’ as the client_id and client_secret to obtain a token to access this API.

API that returns the incentives associated with the campaign code.

Consumer must make a get request by passing parameters campaign code as per the Models and Examples below.

get
https://ec2-18-202-229-190.eu-west-1.compute.amazonaws.com:8443/v1/pmi/incentives/directDeals

Query Parameters

campaignCodestringrequired

campaign code for which incentives should be retrieved

Example:HSE

quoteCreationDatestringrequired

the quote creation date

Example:2023-04-17

Headers

Correlation-IDstring

Correlation Identifier is an unique identifier used to correlate requests across various systems. Is mandatory and can be consumer defined.

Allowed values:a1e4b301-351f-43aa-9bea-f5b62063829d

Requesting-Systemstringrequired

The name of the consumer

content-typestringrequired

used to indicate the media type of the resource.

Allowed values:application/json

Authorizationstringrequired

Bearer token for OAuth 2 Authorization

Default:Bearer 1e23wesryhb667h222hvndmojudsnhh45930044343

Response

application/json

Returns incentives associated with campaign code.

IncentivesResponse

Response comprising available incentives details.

Dealsarray[object]

Hold list of Deals array which consists of DealCode, Trigger and Incentives

Show Child Parameters
incentivesarray[object]

set of incentives within deal

Show Child Parameters
get/v1/pmi/incentives/directDeals
 
application/json

API that returns the incentives associated with the provided scheme code and quoteCreationDate.

Consumer must make a get request by passing parameters, scheme code and quoteCreationDate as per the Models and Examples below…

get
https://ec2-18-202-229-190.eu-west-1.compute.amazonaws.com:8443/v1/pmi/incentives/directSchemes

Query Parameters

schemeCodestringrequired

campaign code for which incentives should be retrieved

Example:HV0005

quoteCreationDatestringrequired

the quote creation date

Example:2012-03-04

Headers

Correlation-IDstring

Correlation Identifier is an unique identifier used to correlate requests across various systems. Is mandatory and can be consumer defined.

Allowed values:a1e4b301-351f-43aa-9bea-f5b62063829d

Requesting-Systemstringrequired

The name of the consumer

content-typestringrequired

used to indicate the media type of the resource.

Allowed values:application/json

Authorizationstringrequired

Bearer token for OAuth 2 Authorization

Default:Bearer 1e23wesryhb667h222hvndmojudsnhh45930044343

Response

application/json

Returns incentives associated with scheme code

IncentivesResponse

Response comprising available incentives details.

Dealsarray[object]

Hold list of Deals array which consists of DealCode, Trigger and Incentives

Show Child Parameters
incentivesarray[object]

set of incentives within deal

Show Child Parameters
get/v1/pmi/incentives/directSchemes
 
application/json