Sign in

v1

latestOpenAPI 3.0.32026-07-243003151.2 MB
Schemes

Get Points Scheme

This method allows the calling application to retrieve a Scheme by Id.

get/schemes/points/{schemeId}

Path parameters

schemeIdstring int64 required

EES AIR Scheme ID.

Headers

X-EES-AUTH-CLIENT-IDstring string required

Client ID, This will be provided by EES and is unique to the company calling the API.

X-EES-AUTH-HASHstring string required

Request Security Hash, calculated using SHA-256 function from concatenated full Request URI Path with Query String(s), Payload and Client Secret

Accept-Encoding'' | 'gzip' | 'deflate' | 'gzip,deflate'

This request HTTP header advertises which content encoding (usually a compression algorithm) the calling application is able to understand. The server selects one of the proposals, use it and informs the client of its choice with the Content-Encoding response header. Currently supported gzip and deflate, if request header not present no compression will be used.

X-EES-TRANSACTION-IDstring string

Unique Reference for the API transaction within the calling company.

X-EES-RETRYstring string

This flag denotes the number of attempts that have been made for this request.

Response

OK.

idstring

The Id of a Scheme automatically generated and unique within Eagle Eye AIR.

type'LOYALTY'

The type of Scheme this is. These types are configured as part of implementation with a client.

accountClientTypestring nullable

The default client type for an Account unless otherwise stated during individual Account creation. The list of available options for this field are defined during client onboarding. (Not implemented for Schemes)

status'ACTIVE' | 'INACTIVE' | 'EXPIRED' | 'DELETED' | 'PENDING' | 'DRAFT' | 'REJECTED' | 'READY' | 'STOPPED' | 'SUSPENDED'

The status of the Scheme.

class'POINTS' | 'STAMP'

The class of this Scheme.

referencestring nullable

An external reference for this Scheme, unique to each client.

timeoutOverrideinteger nullable

Override value the length of time that points will be locked for before automatically being released.

customobject nullable

It contains objects of custom form json values.

dateCreatedstring date-time

The timestamp that the Scheme was created.

lastUpdatedstring date-time

The timestamp that the Scheme was last updated.

lastUpdateByinteger

The Eagle Eye generated ID of the user or API call that made the last update.

versioninteger

The version number of this Scheme that is automatically generated.