| Header | Description | | X-EES-TRANSACTION-ID | Unique Reference for the API transaction within the calling company |
| X-CUSTOM-SUBSYSTEM-ID | Optional header provided by the calling application for EES AIR to identify what was the external Subsystem that made the request, this is passed through in the atomic events and used for clients for their own purposes |
| X-CUSTOM-KEY | Optional header(s) provided by the calling application to EES AIR. Please note this header name has to follow pattern X-CUSTOM-* and is passed through to the atomic events for clients own purposes |
",
"version": "2.170.0",
"contact": {
"name": "Eagle Eye Solutions",
"url": "https://www.eagleeye.com/"
}
},
"tags": [
{
"name": "Recommendations",
"description": "API endpoints for interacting with recommendations objects."
}
],
"paths": {
"/wallet/recommendations": {
"get": {
"summary": "Get Recommendations by Identity Value",
"operationId": "getWalletRecommendationsByIdentityValue",
"description": "This API method allows the calling application to retrieve of recommendations linked to the identity value given in the request. The validity of the identity value is not checked in this request.",
"parameters": [
{
"name": "identity-value",
"in": "query",
"required": true,
"description": "Wallet Identity value",
"schema": {
"type": "string",
"format": "string"
}
},
{
"name": "status",
"in": "query",
"required": true,
"description": "Search by Recommendation status",
"allowEmptyValue": false,
"schema": {
"type": "string",
"format": "string"
}
},
{
"name": "channel",
"in": "query",
"required": true,
"description": "Search by Recommendation channel",
"allowEmptyValue": false,
"schema": {
"type": "string",
"format": "string"
}
}
],
"tags": [
"Recommendations"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/recommendationEntity"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/unauthorized"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"415": {
"$ref": "#/components/responses/unsupportedMediaType"
},
"423": {
"$ref": "#/components/responses/locked"
},
"429": {
"$ref": "#/components/responses/tooManyRequests"
},
"500": {
"$ref": "#/components/responses/serverError"
}
}
}
}
},
"security": [
{
"eesAuthenticationClientId": [],
"eesAuthenticationHash": []
}
],
"components": {
"responses": {
"unauthorized": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/defaultErrorEntity"
},
"example": {
"errorCode": "AF",
"errorMessage": "Authentication Failure, Please check if required AUTH headers are present in your Request and if AUTH Hash is calculated correctly"
}
}
}
},
"forbidden": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/defaultErrorEntity"
}
],
"example": {
"errorCode": "P",
"errorMessage": "You don't have appropriate Privileges to perform this operation"
}
}
}
}
},
"unsupportedMediaType": {
"description": "Unsupported Media Type",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/defaultErrorEntity"
}
],
"example": {
"errorMessage": "Unsupported media type - Check the content type of your request",
"errorCode": "MP"
}
}
}
}
},
"locked": {
"description": "Locked",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/defaultErrorEntity"
}
],
"example": {
"errorMessage": "Transaction ID {transactionId} is not unique",
"errorCode": "ITID"
}
}
}
}
},
"tooManyRequests": {
"description": "Too Many Requests",
"headers": {
"Retry-after": {
"description": "The number of seconds after which to retry the request",
"schema": {
"type": "integer"
}
}
},
"content": {
"application/json": {
"schema": {
"properties": {
"errorCode": {
"type": "string",
"description": "The error code",
"enum": [
"CE"
]
},
"errorMessage": {
"type": "string",
"description": "The error message for this error",
"enum": [
"This request has been throttled. Please try again later."
]
}
}
}
}
}
},
"serverError": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/defaultErrorEntity"
}
],
"example": {
"errorMessage": "Internal Server Error"
}
}
}
}
}
},
"securitySchemes": {
"eesAuthenticationClientId": {
"type": "apiKey",
"in": "header",
"description": "Client ID, This will be provided by EES and is unique to the company calling the API. Please note the authentication mechanic requires the receipt of the full payload so any headers that would chunk the request up, such as transfer-encoding chunked could potentially cause authentication failures.",
"name": "X-EES-AUTH-CLIENT-ID"
},
"eesAuthenticationHash": {
"type": "apiKey",
"in": "header",
"description": "Request Security Hash, calculated using SHA-256 function from concatenated full Request URI Path with Query String(s), Payload and Client Secret. Please note the authentication mechanic requires the receipt of the full payload so any headers that would chunk the request up, such as transfer-encoding chunked could potentially cause authentication failures.",
"name": "X-EES-AUTH-HASH"
}
},
"schemas": {
"metaEntity": {
"type": "object",
"properties": {
"key1": {
"type": "string",
"description": "Meta 1 property, up to 255 characters; up to 255 characters for Key 1 Value"
},
"key2": {
"type": "string",
"description": "Meta 2 property, up to 255 characters; up to 255 characters for Key 2 Value"
}
}
},
"recommendationEntity": {
"type": "object",
"required": [
"guid",
"fileName",
"unitId",
"targetType",
"validTo",
"status",
"dateCreated",
"lastUpdated"
],
"properties": {
"guid": {
"type": "string",
"format": "string",
"description": "the unique reference for this file"
},
"catalogue": {
"type": "string",
"format": "string",
"description": "the unique reference for this file"
},
"subject": {
"type": "array",
"items": {
"type": "string",
"format": "string"
},
"description": "the unique reference for this file"
},
"target": {
"type": "array",
"items": {
"type": "string",
"format": "string"
}
},
"validFrom": {
"type": "string",
"format": "string",
"description": "ATOM formatted date time for the valid from",
"pattern": "^((((19|[2-9]\\d)(0[48]|[2468][048]|[13579][26])|(([2468][048]|[3579][26])00))\\-02\\-29|((19\\d{2}|[2-9]\\d{3})\\-((0[13578]|1[02])\\-31))|((19\\d{2}|[2-9]\\d{3})\\-(0[13-9]|1[0-2])\\-(29|30))|((19\\d{2}|[2-9]\\d{3})\\-(0[1-9]|1[0-2])\\-(0[1-9]|1[0-9]|2[0-8])))\\T([01][0-9]\\:[0-5][0-9]\\:[0-5][0-9]|2[0-3]\\:[0-5][0-9]\\:[0-5][0-9]))(\\+|\\-)([01][0-9]\\:[0-5][0-9]|2[0-3]\\:[0-5][0-9])$"
},
"validTo": {
"type": "string",
"format": "string",
"description": "ATOM formatted date time for the valid from",
"pattern": "^((((19|[2-9]\\d)(0[48]|[2468][048]|[13579][26])|(([2468][048]|[3579][26])00))\\-02\\-29|((19\\d{2}|[2-9]\\d{3})\\-((0[13578]|1[02])\\-31))|((19\\d{2}|[2-9]\\d{3})\\-(0[13-9]|1[0-2])\\-(29|30))|((19\\d{2}|[2-9]\\d{3})\\-(0[1-9]|1[0-2])\\-(0[1-9]|1[0-9]|2[0-8])))\\T([01][0-9]\\:[0-5][0-9]\\:[0-5][0-9]|2[0-3]\\:[0-5][0-9]\\:[0-5][0-9]))(\\+|\\-)([01][0-9]\\:[0-5][0-9]|2[0-3]\\:[0-5][0-9])$"
},
"channel": {
"type": "array",
"items": {
"type": "string"
}
},
"weight": {
"type": "number",
"format": "int32",
"description": "the weight of this recommendation"
},
"status": {
"type": "string",
"description": "The Catalogue status",
"enum": [
"ACTIVE",
"ACCEPTED",
"REJECTED",
"DELETED"
]
},
"meta": {
"$ref": "#/components/schemas/metaEntity"
},
"data": {
"type": "object"
},
"dateCreated": {
"type": "string",
"format": "string",
"description": "the date the record was created",
"pattern": "^((((19|[2-9]\\d)(0[48]|[2468][048]|[13579][26])|(([2468][048]|[3579][26])00))\\-02\\-29|((19\\d{2}|[2-9]\\d{3})\\-((0[13578]|1[02])\\-31))|((19\\d{2}|[2-9]\\d{3})\\-(0[13-9]|1[0-2])\\-(29|30))|((19\\d{2}|[2-9]\\d{3})\\-(0[1-9]|1[0-2])\\-(0[1-9]|1[0-9]|2[0-8])))\\T([01][0-9]\\:[0-5][0-9]\\:[0-5][0-9]|2[0-3]\\:[0-5][0-9]\\:[0-5][0-9]))(\\+|\\-)([01][0-9]\\:[0-5][0-9]|2[0-3]\\:[0-5][0-9])$"
},
"lastUpdated": {
"type": "string",
"format": "string",
"description": "the date the record was last updated",
"pattern": "^((((19|[2-9]\\d)(0[48]|[2468][048]|[13579][26])|(([2468][048]|[3579][26])00))\\-02\\-29|((19\\d{2}|[2-9]\\d{3})\\-((0[13578]|1[02])\\-31))|((19\\d{2}|[2-9]\\d{3})\\-(0[13-9]|1[0-2])\\-(29|30))|((19\\d{2}|[2-9]\\d{3})\\-(0[1-9]|1[0-2])\\-(0[1-9]|1[0-9]|2[0-8])))\\T([01][0-9]\\:[0-5][0-9]\\:[0-5][0-9]|2[0-3]\\:[0-5][0-9]\\:[0-5][0-9]))(\\+|\\-)([01][0-9]\\:[0-5][0-9]|2[0-3]\\:[0-5][0-9])$"
}
}
},
"defaultErrorEntity": {
"type": "object",
"required": [
"errorCode",
"errorMessage"
],
"properties": {
"errorCode": {
"type": "string",
"description": "Internal Error Code",
"enum": [
"AA",
"AF",
"ALR",
"AALR",
"AT",
"CE",
"CI",
"CLPPR",
"CILR",
"CORQ",
"CP",
"CR",
"CTNR",
"CU",
"CX",
"DSN",
"ELE",
"FES",
"IFU",
"IH",
"ILA",
"IOC",
"IP",
"IPR",
"IR",
"ITID",
"IW",
"LIR",
"LNA",
"LPR",
"MAC",
"MAR",
"MLV",
"MNA",
"MPA",
"MTLE",
"NF",
"OC",
"P",
"RF",
"RFL",
"RW",
"RWI",
"TBR",
"TBS",
"TEXP",
"TULR",
"U",
"UAS",
"UV",
"VA",
"VC",
"VI",
"VL",
"VNL",
"VPUF",
"VSM",
"VU",
"VUA",
"VURC",
"VURI",
"VXP",
"WLNF",
"WTF",
"WTNF"
]
},
"errorMessage": {
"type": "string",
"description": "Human Friendly Error Message"
}
},
"x-enum": [
{
"errorCode": "AA",
"errorMessage": "Invalid Access to API Method"
},
{
"errorCode": "AF",
"errorMessage": "Authorisation Failed"
},
{
"errorCode": "ALR",
"errorMessage": "Account Limit Reached"
},
{
"errorCode": "AT",
"errorMessage": "Account Type"
},
{
"errorCode": "CE",
"errorMessage": "Configuration Error"
},
{
"errorCode": "CI",
"errorMessage": "Campaign Inactive"
},
{
"errorCode": "CILR",
"errorMessage": "Campaign Issuance Limit Reached"
},
{
"errorCode": "CLPPR",
"errorMessage": "Campaign Limit Per Period Reached"
},
{
"errorCode": "CORQ",
"errorMessage": "Consumer Required"
},
{
"errorCode": "CP",
"errorMessage": "Campaign Pending"
},
{
"errorCode": "CR",
"errorMessage": "Campaign Removed"
},
{
"errorCode": "CTNR",
"errorMessage": "Consumer Type Not Recognized"
},
{
"errorCode": "CU",
"errorMessage": "Campaign Unknown"
},
{
"errorCode": "CX",
"errorMessage": "Campaign Expired"
},
{
"errorCode": "DSN",
"errorMessage": "Duplicated Serial Number"
},
{
"errorCode": "ELE",
"errorMessage": "Exchange Limit Exceeded"
},
{
"errorCode": "FES",
"errorMessage": "Scheduling Format Incorrect"
},
{
"errorCode": "IFU",
"errorMessage": "Insufficient Funds"
},
{
"errorCode": "IH",
"errorMessage": "Invalid Header set"
},
{
"errorCode": "ILA",
"errorMessage": "Invalid Load Amount"
},
{
"errorCode": "IOC",
"errorMessage": "Improper Offer Configuration"
},
{
"errorCode": "IP",
"errorMessage": "Invalid Parameter"
},
{
"errorCode": "IPR",
"errorMessage": "IP Address Rejected"
},
{
"errorCode": "IR",
"errorMessage": "Invalid Request"
},
{
"errorCode": "ITID",
"errorMessage": "Invalid Transaction ID"
},
{
"errorCode": "IW",
"errorMessage": "Voucher Can Not Be Created"
},
{
"errorCode": "LIR",
"errorMessage": "Outlet Identifier Required"
},
{
"errorCode": "LNA",
"errorMessage": "Outlet Not Allowed"
},
{
"errorCode": "LPR",
"errorMessage": "Outlet Prohibited by Campaign Settings"
},
{
"errorCode": "MAC",
"errorMessage": "Maximum Number of Code Variations"
},
{
"errorCode": "MAR",
"errorMessage": "Minimum Amount Required"
},
{
"errorCode": "MLV",
"errorMessage": "Maximum Voucher Value Exceeded"
},
{
"errorCode": "MNA",
"errorMessage": "Method Not Allowed"
},
{
"errorCode": "MPA",
"errorMessage": "Missing Parameter"
},
{
"errorCode": "MTLE",
"errorMessage": "Max Active Tokens Limit Exceeded"
},
{
"errorCode": "NF",
"errorMessage": "Not Found"
},
{
"errorCode": "NPP",
"errorMessage": "No Points Pending"
},
{
"errorCode": "OC",
"errorMessage": "Campaign has no Offer"
},
{
"errorCode": "P",
"errorMessage": "Privileges"
},
{
"errorCode": "RF",
"errorMessage": "Rollback Failure"
},
{
"errorCode": "RFL",
"errorMessage": "Redemption failed: Max redemption limit ... per period ... has been exceeded"
},
{
"errorCode": "RW",
"errorMessage": "Voucher Can Not Be Redeemed"
},
{
"errorCode": "RWI",
"errorMessage": "Token can not be Redeemed at this time. Blocked by redemption windows."
},
{
"errorCode": "TBR",
"errorMessage": "Minimum time since last redemption has not passed"
},
{
"errorCode": "TBS",
"errorMessage": "Minimum time since last stamp has not passed"
},
{
"errorCode": "TEXP",
"errorMessage": "Token Expired"
},
{
"errorCode": "TULR",
"errorMessage": "Token Usage Limit Reached"
},
{
"errorCode": "U",
"errorMessage": "Unknown Error"
},
{
"errorCode": "UAS",
"errorMessage": "Transaction Not Allowed by current account status"
},
{
"errorCode": "UV",
"errorMessage": "Voucher Unknown"
},
{
"errorCode": "VA",
"errorMessage": "Voucher already been sent"
},
{
"errorCode": "VC",
"errorMessage": "Voucher Cancelled"
},
{
"errorCode": "VI",
"errorMessage": "Voucher Invalid"
},
{
"errorCode": "VL",
"errorMessage": "Voucher Locked"
},
{
"errorCode": "VNL",
"errorMessage": "Voucher Not Locked"
},
{
"errorCode": "VPUF",
"errorMessage": "Voucher You don't have privileges to unlock this token"
},
{
"errorCode": "VSM",
"errorMessage": "Voucher Serial Mismatch"
},
{
"errorCode": "VU",
"errorMessage": "Voucher already redeemed"
},
{
"errorCode": "VUA",
"errorMessage": "No vouchers available for this campaign"
},
{
"errorCode": "VURC",
"errorMessage": "No Voucher Available to Redeem for Campaign"
},
{
"errorCode": "VURI",
"errorMessage": "No Voucher Available to Redeem for this Identity"
},
{
"errorCode": "VXP",
"errorMessage": "Voucher Expired"
},
{
"errorCode": "WLNF",
"errorMessage": "Wallet Link Not Found"
},
{
"errorCode": "WTF",
"errorMessage": "Wallet Transaction Failure"
},
{
"errorCode": "WTNF",
"errorMessage": "Wallet Transaction Not Found"
}
]
}
}
}
}
```