Games List

Output representation of the list of games assigned to a member.

JSON example

Here’s an example of the details of an eligible Spin the Wheel game assigned to a member, and an already played Scratch Card game.

1{
2   "errorMessage":null,
3   "gameDefinitions":[
4      {
5         "description":"Play Spin The Wheel to get amazing rewards",
6         "endDate":"2024-07-31T19:00:00.000Z",
7         "gameRewards":[
8            {
9               "color":"FF5733",
10               "description":"Get 10%  Off Voucher",
11               "imageUrl":null,
12               "name":"10 % Off",
13               "rewardType":"Voucher",
14               "rewardValue":null
15            },
16            {
17               "color":"000000",
18               "description":"Loyalty Points",
19               "imageUrl":null,
20               "name":"1000 Reward Points",
21               "rewardType":"LoyaltyPoints",
22               "rewardValue":"100.0"
23            },
24            {
25               "color":"762E2E",
26               "description":"Better Luck Next Time",
27               "imageUrl":null,
28               "name":"No Reward",
29               "rewardType":"NoReward",
30               "rewardValue":null
31            }
32         ],
33         "participantGameRewards":[
34            {
35               "expirationDate":"2024-01-04T20:00:00.000Z",
36               "gameParticipantRewardId":"3PRSB0000000hjJ4AQ",
37               "gameRewardId":null,
38               "issuedRewardReference":null,
39               "sourceActivity":null,
40               "status":"YetToReward"
41            }
42         ],
43         "name":"Spin The Wheel",
44         "startDate":"2023-10-01T19:00:00.000Z",
45         "timeoutDuration":10,
46         "type":"SpintheWheel"
47      },
48      {
49         "description":"Play Scratch card to get amazing rewards",
50         "endDate":"2024-07-31T19:00:00.000Z",
51         "gameRewards":[
52                        {
53               "color":"",
54               "description":"Get 10%  Off Voucher",
55               "imageUrl":null,
56               "name":"10 % Off",
57               "rewardType":"Voucher",
58               "rewardValue":null
59            },
60            {
61               "color":"",
62               "description":"Better Luck Next Time",
63               "imageUrl":null,
64               "name":"No Reward",
65               "rewardType":"NoReward",
66               "rewardValue":null
67            }
68         ],
69         "participantGameRewards":[
70            {
71               "expirationDate":"2024-01-04T20:00:00.000Z",
72               "gameParticipantRewardId":"2ABSB0000000hjJ3AM",
73               "gameRewardId":"2GRSB0000000Caf4AB",
74               "issuedRewardReference":"0lVSB000000032j2AA",
75               "sourceActivity":"0c85i0000009c6D",
76               "status":"Rewarded"
77            }
78         ],
79         "name":"Scratch Card",
80         "startDate":"2023-10-01T19:00:00.000Z",
81         "timeoutDuration":20,
82         "type":"Scratchcard"
83      }
84   ],
85   "status":true
86}

Property Name	Type	Description	Filter Group and Version	Available Version
`errorMessage`	String	Message that provides the reason why a list of games weren't found for the participant.	Small, 60.0	60.0
`gameDefinitions`	Game Details []	List of game definitions associated with the games assigned to the member. A game definition has the details of a game, including: The list of possible rewards for the game. The participant game reward records that contain details of the game reward the participant has won for each game play, or can win after playing the game.	Small, 60.0	60.0
`status`	Boolean	Indicates whether the request succeeded (`true`) or failed (`false`).	Small, 60.0	60.0

Property Name

Type

Description

Filter Group and Version

Available Version

errorMessage

String

Message that provides the reason why a list of games weren't found for the participant.

Small, 60.0

60.0

gameDefinitions

Game Details []

List of game definitions associated with the games assigned to the member.

A game definition has the details of a game, including:

The list of possible rewards for the game.
The participant game reward records that contain details of the game reward the participant has won for each game play, or can win after playing the game.

Small, 60.0

60.0

status

Boolean

Indicates whether the request succeeded (true) or failed (false).

Small, 60.0

60.0

Loyalty Management Developer Guide

Games List