Step 1: Simple Competition settings

Fill out the Competitions and Contests Name, Availability and Description. Some fields are mandatory some are optional. You can check more about the Competitions model in our API documentation Competitions.

The Settings section consists the basic information about the competition name, when the competition is available, description and metadata. 

SETTINGS

EXAMPLES

Label

Required

String

The Name of the competition and contest that the player sees in the leaderboard. The name is the same for the competition and contest.

Availability
from

Required

DateTime

Select the date (day/month/year) and time (hour:minute) when the competition and contest will start in UTC time.

until

Required

DateTime

Select the date (day/month/year) and time (hour:minute) when the competition and contest will end in UTC time.* 

Container duration
N/A

An automatically calculated and implemented time that shows the time duration for how long the competition and contest will run.

Description

Optional

String

The competition and contest description visible to players on the leaderboard. 

Metadata

Optional

Array [Object]

Optional information you can use to store reference information. 

APP Example:

Label
End of the year Competition
Availability
from

31/12/2019, 00:00 UTC

until
31/12/2019, 23:59 UTC
Container duration
0days 23hours 59minutes
Description
A competition to commemorate the end of the year!
Metadata
KeyWinter
Value1

API Example:

{
    "jsonClass": "Competition",
    ...
    "label": "End of the year Competition",
    "options": {
        "autoStart": true,
        "autoStartRetryInterval": 1000,
        "autoStop": true,
        "autoStopRetryInterval": 1000,
        "scheduledDates": {
            "jsonClass": "StartEndDate",
            "start": "2019-12-31T00:00:00.000+0000",
            "end": "2019-12-31T23:59:00.000+0000"
        },
        "actualDates": {
            "jsonClass": "StartEndDate"
        },
    "description": "A competition to commemorate the end of the year!",
    "metadata": [
        {
            "jsonClass": "Metadata",
            "key": "Winter",
            "value": "1"
        }
    ],
    ...
}

A full example of POST Competition can be found in the Competitions APP API documentation here


CONTINUE Click Next and continue to the next step.

MISSING ENTRIES If any required information is missing, the field is shown in red as in the example below.