GetTournamentConfigs

{
    "packetId": 1,
    "messages": [
        {
            "service": "tournament",
            "operation": "GET_TOURNAMENT_CONFIGS",
            "data": {
                "leaderboardId": "leaderboard1",
                "leaderboardVersionId": 1
            }
        }
    ]
}

Get tournament configs associated with a leaderboard.

Service	Operation
tournament	GET_TOURNAMENT_CONFIGS

Method Parameters

Parameter	Description
leaderboardId	The leaderboard to retrieve tournament info from.
leaderboardVersionId	The version of the leaderboard to retrieve tournament info from. Use -1 for current version.

Usage

http://localhost:3000

C#

// S2S call: to view example, switch to the Cloud Code or Raw tab.

C++

// S2S call: to view example, switch to the Cloud Code or Raw tab.

Objective-C

// S2S call: to view example, switch to the Cloud Code or Raw tab.

Java

// S2S call: to view example, switch to the Cloud Code or Raw tab.

JavaScript

// S2S call: to view example, switch to the Cloud Code or Raw tab.

Dart

// S2S call: to view example, switch to the Cloud Code or Raw tab.

Cloud Code

var leaderboardId = "the-leaderboard-id";
var leaderboardVersionId = 1;
var tournamentProxy = bridge.getTournamentServiceProxy();

var postResult = tournamentProxy.getTournamentConfigs(leaderboardId, leaderboardVersionId);
if (postResult.status == 200) {
    // Success!
}

Raw

{
    "service": "tournament",
    "operation": "GET_TOURNAMENT_CONFIGS",
    "data": {
        "leaderboardId": "the-leaderboard-id",
        "leaderboardVersionId": 1
    }
}

JSON Response

{
    "packetId": 1,
    "messageResponses": [
        {
            "status": 200,
            "data": {
                "tournamentConfigsCount": 1,
                "tournamentConfigs": [
                    {
                        "version": 8,
                        "gameId": "123456",
                        "tournamentCode": "testTournament",
                        "description": {
                            "name": {
                                "en": "Test Tournament"
                            },
                            "desc": {
                                "en": "Test Tournament"
                            }
                        },
                        "notifications": {
                            "startingSoon": {
                                "enabled": false,
                                "pushId": null,
                                "mail": null
                            },
                            "start": {
                                "enabled": false,
                                "pushId": null,
                                "mail": {}
                            },
                            "scorePassed": {
                                "enabled": false,
                                "pushId": null,
                                "mail": {}
                            },
                            "endingSoon": {
                                "enabled": false,
                                "pushId": null,
                                "mail": {}
                            },
                            "complete": {
                                "enabled": false,
                                "pushId": null,
                                "mail": {}
                            }
                        },
                        "calcScript": "",
                        "postScript": "",
                        "customJson": {},
                        "payoutRules": [
                            {
                                "reward": {
                                    "currency": {
                                        "credits": 1
                                    }
                                },
                                "rank": {
                                    "rankAbs": 1
                                }
                            },
                            {
                                "reward": {},
                                "rank": {
                                    "rankRemainder": -1
                                }
                            }
                        ],
                        "entryFee": {},
                        "createdAt": 1483479902614,
                        "updatedAt": 1483560895428
                    }
                ]
            }
        }
    ]
}