/
v3.0.11Get access

getLoyaltyAchievableWheelList

The getLoyaltyAchievableWheelList API fetches the list of interactive gaming wheels (such as "Wonder Wheel" or "Win Wheel") that a client can potentially unlock or spin based on their current loyalty tier and ecosystem status.

Request parameters:

The method works without parameters

Call example:

getLoyaltyAchievableWheelList()

Response examples:

{
  code: 0,
  rid: '0',
  data: {
    result: 0,
    details: {
      ErrorId: 0,
      ErrorDescription: '',
      HasError: false,
      Result: [{
        SourceId: 1,
        Name: 'Wonder Wheel',
        WheelId: 2125,
        DestinationLevel: 12,
        SpinCount: 3
      }, {
        Name: 'Wonder wheel 2',
        WheelId: 2126,
        DestinationLevel: 12,
        SpinCount: 5,
        SourceId: 1
      }, {
        DestinationLevel: 12,
        SpinCount: 2,
        SourceId: 1,
        Name: 'Wonder wheel 3',
        WheelId: 2127
      }]
    }
  }
}

Response parameters:

NameDescriptionTypeValues
WheelId
Primary Key. The unique structural identifier for the specific wheel configuration in the gaming database.number-
Name
Display Title. The localized name of the wheel shown directly to the user on their loyalty dashboard card.string-
SourceId
Origin Identifier. Links the wheel instance to its specific logical source, theme module, or gaming provider platform engine.number-
DestinationLevel
Target Tier Requirements. The numerical hierarchy rank (or order) a user must reach to unlock this wheel. It is checked against the user's currentLevelOrder to compute whether the wheel is locked or available.number-
SpinCount
Allocation Counter. The total number of interactive play chances or spins a client has earned/available to execute on this specific wheel.number-