Action 71:Search Free Spin Reward event info of a specified player
Function Description
- Search Free Spin Reward event info of a specified player.
- Free Spin Reward information is retained for 180 days after the free spin reward expires.
Parameter
Parameter | Format | Mandatory | Description |
---|---|---|---|
action | Integer | Y | 71 |
ts | Long | Y | Current system time |
parent | String(50) | Y | Agent ID |
uid | String(50) | Y | PlayerID |
startTime | String | N | Start time of the searching range for the event start time (Only conforming to the following format in ISO-8601) yyyy-MM-ddTHH:mm:ss.sss+|-hh:mm |
endTime | String | N | End time of the searching range for the event start time (Only conforming to the following format in ISO-8601) yyyy-MM-ddTHH:mm:ss.sss+|-hh:mm |
status | Integer | N | Free Spin Reward Evnet Status INACTIVE:0 ACTIVE:1 EXPIRED:2 TERMINATED:3 |
types | String Array | N | Free Spin Reward Type NORMAL: Normal Game FEATURE: Featured Game BONUSCHIPS: Bonus Chips Game |
mysteryTypes | String Array | N | Mystery types NONE: None (default) BLINDBOX: Blind box |
Example
{
"action": 71,
"ts": 1704790101741,
"parent": "testag",
"uid": "testplayer",
"startTime": "2024-07-22T04:05:33+01:00",
"endTime": "2024-07-23T04:05:33+01:00",
"status": 1,
"types": ["NORMAL", "FEATURE"],
"mysteryTypes": ["NONE", "BLINDBOX"]
}
Return Results
Parameter | Format | Description |
---|---|---|
status | String(4) | Success: 0000 Error: See Error Codes in Appendix No Data: 0000 |
data | JSON Array | The returned listed in the following table. |
err_text | String(255) | Error message |
Free Spin Reward Detail
Parameter | Format | Description |
---|---|---|
eventId | String | Free Spin Reward ID |
name | String | Free Spin Reward Name |
currency | String(10) | Currency Types See Currency Code |
type | String | Free Spin Reward Type NORMAL: Normal Game FEATURE: Featured Game BONUSCHIPS: Bonus Chips Game |
times | Long | Free Spin Reward Available TimesThis field is only used for normal game and feature game, otherwise it is null |
useTimes | Long | Player Used TimesThis field is only used for normal game and feature game, otherwise it is null |
requiredTurnover | String | Required TurnoverThis field is only used for bonus chips game, otherwise it is null |
accumulatedTurnover | String | Player Accumulated TurnoverThis field is only used for bonus chips game, otherwise it is null |
startTime | String | Free Spin Reward Start Time (Only conforming to the following format in ISO-8601) yyyy-MM-ddTHH:mm:ss.sss+|-hh:mm |
endTime | String | Free Spin Reward End Time (Only conforming to the following format in ISO-8601) yyyy-MM-ddTHH:mm:ss.sss+|-hh:mm |
status | String | Free Spin Reward Status INACTIVE: Inactive ACTIVE: Active EXPIRED: Expired TERMINATED: Terminated |
machineTypes | Integer Array | Machine Types See Game List (4.2) in appendix |
alreadySettle | Boolean | indicates whether the player has completed a cash-outFor normal games and featured games: true if the player has used up all available free spins, otherwise false For bonus chips games: true if the player has used up all bonus chips or met the turnover requirement, otherwise false |
cashout | String | Player Cash-Out Amount |
updateTime | String | Update Time (Only conforming to the following format in ISO-8601) yyyy-MM-ddTHH:mm:ss.sss+|-hh:mm |
mysteryType | String | Mystery types NONE: None BLINDBOX: Blind box |
visible | Boolean | Is the free spin reward visible to the playerIf the mystery type is NONE, this field defaults to true. If the mystery type is BLINDBOX, this field defaults to false. For BLINDBOX type, the free spin reward must be activated by the player through a draw in the game. |
Operation Sample
// Http Request
http://{API_Address}/apiRequest.do?dc=jb1&x=y1wayxScczy6ABfElfaVwb5CdfHxBN_JGtxyBSvpohLQakP8M2QSetJNojJBzvnrVChhq8YWWgBTdGeXFTH4vSNQQ66epf4NqYeQ-6bJ15pvHctQjQevulv7GHqOifuju_gY0H54FfVdQc9D5tKh1AZ-9KDh9dwcGSszZxU7JOOoHdYITlCO5LhvGmHxPBwZ
// Http Response (success)
{
"status": "0000",
"data": [
{
"eventId": "12345",
"name": "test normal event name",
"currency": "RB",
"times": 3,
"useTimes": 3,
"requiredTurnover": null,
"accumulatedTurnover": null,
"startTime": "2024-07-17T16:00:00.000+01:00",
"endTime": "2024-07-22T16:00:00.000+01:00",
"type": "NORMAL",
"status": "EXPIRED",
"machineTypes": [
14050,
14053
],
"alreadySettle": true,
"cashout": "1.000",
"updateTime": "2024-07-22T16:00:00.000+01:00",
"mysteryType": "NONE"
},
{
"eventId": "12346",
"name": "test bonus chips event name",
"currency": "RB",
"times": null,
"useTimes": null,
"requiredTurnover": 100,
"accumulatedTurnover": 50,
"startTime": "2024-07-17T16:00:00.000+01:00",
"endTime": "2024-07-22T16:00:00.000+01:00",
"type": "BONUSCHIPS",
"status": "EXPIRED",
"machineTypes": [
14041,
14087
],
"alreadySettle": true,
"cashout": "0",
"updateTime": "2024-07-22T16:00:00.000+01:00",
"mysteryType": "BLINDBOX"
}
]
}
// Http Response (failed)
1. If query player not downline of agent, will receive response:
{
"status": "7501",
"err_text": "User ID cannot be found."
}
2. If query startime is greater than endtime, will receive response:
{
"status": "8009",
"err_text": "Time interval exceeds the allowable range."
}