Search for Points Schemes

get

https://resources.uk.eagleeye.com/schemes/points

This method allows the calling application to retrieve all Schemes.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

reference

string

An external reference for the Campaign, unique to each client.

barcode

string

The value of a barcode.

status

string

enum

This is a status of the Campaign.

accountClientType

string

The default client type for an Account unless otherwise stated during individual Account creation.

endDate

date-time

When the campaign ends.

startDate

date-time

When the campaign starts.

tag[]

array of strings

This is a tag assigned to a Campaign.

tag[]

offset

integer

Offset allows you to skip a number of campaigns before returning data.

limit

integer

The number of campaigns to return up to a maximum of 100.

Headers

X-EES-AUTH-CLIENT-ID

string

required

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

X-EES-AUTH-HASH

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

string

enum

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.

Allowed:

X-EES-TRANSACTION-ID

string

Unique Reference for the API transaction within the calling company.

X-EES-RETRY

string

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

Responses

Language

URL

Loading…

Response

Choose an example:

application/json

200Result of Schemes.

400Bad Request.

401Unauthorized.

403Forbidden.

404Not Found.

405Method Not Allowed.