SysEditTournamentTemplate
Creates a new tournament template.
Service | Operation |
---|---|
tournament | SYS_EDIT_TOURNAMENT_TEMPLATE |
Method Parameters
Parameter | Description |
---|---|
tournamentCode | The unique tournament code to assign to the template |
configJson | Configuration data defining the tournament template |
version | Current version number of tournament template to update, use -1 to disable version checking |
applyChangesToLiveLeaderboards | If true, forces updates to all leaderboards with current version referencing that tournament code to set the new tournament template version. If false, new tournament template version is picked up on the leaderboards' next rotation. |
Usage
http://localhost:3000
- C#
- C++
- Objective-C
- Java
- JavaScript
- Dart
- Cloud Code
- Raw
// Cloud Code only. To view example, switch to the Cloud Code tab
// Cloud Code only. To view example, switch to the Cloud Code tab
// Cloud Code only. To view example, switch to the Cloud Code tab
// Cloud Code only. To view example, switch to the Cloud Code tab
// Cloud Code only. To view example, switch to the Cloud Code tab
// Cloud Code only. To view example, switch to the Cloud Code tab
var tournamentCode = "uniqueTournamentCode";
var configJson = {
"tournamentCode": "uniqueTournamentCode",
"configJson": {
"description": {
"name": {
"en": "tFree"
},
"desc": {
"en": "Free tournament. Pays out for rankings: 1st, 2nd and top 10%. Push notifications for start and complete."
}
},
"notifications": {
"startingSoon": {
"enabled": false,
"pushId": null,
"mail": {}
},
"start": {
"enabled": true,
"pushId": 2,
"mail": {}
},
"scorePassed": {
"enabled": false,
"pushId": null,
"mail": {}
},
"endingSoon": {
"enabled": false,
"pushId": null,
"mail": {}
},
"complete": {
"enabled": true,
"pushId": 3,
"mail": {}
}
},
"calcScript": "",
"postScript": "",
"customJson": {},
"payoutRules": [
{
"reward": {
"experiencePoints": 10,
"currency": {
"coins": 100
}
},
"rank": {
"rankAbs": 1
}
},
{
"reward": {
"experiencePoints": 5,
"currency": {
"coins": 50
}
},
"rank": {
"rankAbs": 2
}
},
{
"reward": {
"experiencePoints": 1,
"currency": {
"coins": 5
}
},
"rank": {
"rankToPercent": 10
}
}
],
"entryFee": {}
}
};
var version = 1;
var applyChangesToLiveLeaderboards = false;
var tournamentProxy = bridge.getTournamentServiceProxy();
var postResult = tournamentProxy.sysEditTournamentTemplate(tournamentCode, configJson, version, applyChangesToLiveLeaderboards);
if (postResult.status == 200) {
// Success!
}
{
"service": "tournament",
"operation": "SYS_EDIT_TOURNAMENT_TEMPLATE",
"data": {
"tournamentCode": "uniqueTournamentCode",
"configJson": {
"description": {
"name": {
"en": "tFree"
},
"desc": {
"en": "Free tournament. Pays out for rankings: 1st, 2nd and top 10%. Push notifications for start and complete."
}
},
"notifications": {
"startingSoon": {
"enabled": false,
"pushId": null,
"mail": {}
},
"start": {
"enabled": true,
"pushId": 2,
"mail": {}
},
"scorePassed": {
"enabled": false,
"pushId": null,
"mail": {}
},
"endingSoon": {
"enabled": false,
"pushId": null,
"mail": {}
},
"complete": {
"enabled": true,
"pushId": 3,
"mail": {}
}
},
"calcScript": "",
"postScript": "",
"customJson": {},
"payoutRules": [
{
"reward": {
"experiencePoints": 10,
"currency": {
"coins": 100
}
},
"rank": {
"rankAbs": 1
}
},
{
"reward": {
"experiencePoints": 5,
"currency": {
"coins": 50
}
},
"rank": {
"rankAbs": 2
}
},
{
"reward": {
"experiencePoints": 1,
"currency": {
"coins": 5
}
},
"rank": {
"rankToPercent": 10
}
}
],
"entryFee": {}
},
"version": -1,
"applyChangesToLiveLeaderboards": false
}
}
JSON Response
{
"data": {
"gameId": "23782",
"tournamentCode": "uniqueTournamentCode",
"version": 1,
"description": {
"name": {
"en": "tFree"
},
"desc": {
"en": "Free tournament. Pays out for rankings: 1st, 2nd and top 10%. Push notifications for start and complete."
}
},
"notifications": {
"startingSoon": {
"enabled": false,
"pushId": null,
"mail": {}
},
"start": {
"enabled": true,
"pushId": 2,
"mail": {}
},
"scorePassed": {
"enabled": false,
"pushId": null,
"mail": {}
},
"endingSoon": {
"enabled": false,
"pushId": null,
"mail": {}
},
"complete": {
"enabled": true,
"pushId": 3,
"mail": {}
}
},
"calcScript": "",
"postScript": "",
"customJson": {},
"payoutRules": [
{
"rank": {
"rankAbs": 1
},
"reward": {
"experiencePoints": 10,
"currency": {
"coins": 100
}
}
},
{
"rank": {
"rankAbs": 2
},
"reward": {
"experiencePoints": 5,
"currency": {
"coins": 50
}
}
},
{
"rank": {
"rankToPercent": 10
},
"reward": {
"experiencePoints": 1,
"currency": {
"coins": 5
}
}
}
],
"entryFee": {},
"createdAt": 1632511327924,
"updatedAt": 1632511327924
},
"status": 200
}