Search
K
PMI Incentives 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

IncentivesResponse

object

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
Example

Incentives

object

set of incentives within deal

codestring

incentive code

Allowed values:PriceLoader5Pct1NCDUpliftMulti5Pct2NCDUpliftRedSwitchDecMonthsFree02FamilyDisc10PctMonthsFree01LIFEMonthsFree011NCDUpliftLIFEDiscount10PctLIFE

namestring

name of the incentive

Allowed values:2 NCD Uplift5% Aviva Multi Policy Discount5% Price Loader1 NCD UpliftReduced Switch Dec2 Months FreeFriends & Family - 10% Discount1 MONTH FREE - Lifestyle1 MONTH FREE1 NCD Uplift - Lifestyle10% Discount - Lifestyle

descriptionsstring

description of the incentive

Allowed values:5% Discount2 NCD Uplift1 NCD UpliftReduced Switch DecMonthsFree0Friends & Family - 10% DiscountMonthsFree011 MONTH FREE - Lifestyle10% Discount - Lifestyle

triggerstring

trigger value of the incentive

Allowed values:ConversionResponse

paymentTypesarray

Frequency & Mode of payments

Allowed values:accaddmccmdd

typestring

type of incentive

Allowed values:NCD UpliftpsDiscountPrice BeaterSwitchDecmonthsFree

valueinteger(int32)

value of incentive

Allowed values:15-5210

Example

ProblemDetail

object

Problem detail exception.

typestring

An absolute URI [RFC3986] that identifies the problem type. When dereferenced, it SHOULD provide human-readable documentation for the problem type.

titlestring

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localisation.

statusstring

The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.

detailstring

An human readable explanation specific to this occurrence of the problem.

instancestring

An absolute URI that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

codestring

This is an Aviva extension type that could be used for sending common mapped business error codes back to the consumer

Example