Contests are discreet competitive events in the context of a competition. Members compete in contests to win the overall competition.
What can you do?
Available Resources
- Get a list of contests in a specified competition;
- Find a specific contest by passing various query parameters;
- Edit a contests information;
- Create a contest;
- Cancel a contest;
- Get a Sample of a contest;
- Retrieve Contest status enums.
Domain Object
Parameter | Type | Description | Request | Response | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| GET | PUT | POST | DELETE | GET | PUT | POST | DELETE | |||||
accountId | String | Unique identifier of your account | Yes | Yes | Yes | |||||||
competitionId | String | A unique identifier of a Competition | Yes | Yes | Yes | Yes | Yes | |||||
number | Integer | The row number for displaying the Contest in a table | Yes | Yes | Yes | Yes | Yes | |||||
label | String | A label for the Contest. Can be translated. | Yes | Yes | Yes | Yes | Yes | |||||
description | String | Description of the Contest. Can be translated. | Optional | Optional | Yes | Yes | Yes | |||||
termsConditions | String | Terms and conditions of a Contest. Can be translated. | Optional | Optional | Yes | Yes | Yes | |||||
round | Integer | To what round does the contest belong | Yes | Yes | Yes | Yes | Yes | |||||
roundType | Enum
| The type of rounds in a contest | Yes | Yes | Yes | Yes | Yes | |||||
groupStage | Integer | Is used for more complex Competitions e.g. multi round competitions where round 1 group stage matched round 2 | Optional | Optional | Yes | Yes | Yes | |||||
groupStageLabel | String | The label of the group stages e.g. Finals, Semi-finals | Optional | Optional | Yes | Yes | Yes | |||||
entrantsFromContest | Array [String] | A list of CompetitionLabs contest identifiers. When a Progression competition is active and you have a 2 round competition the first round has to reference the second round then this parameter becomes mandatory instead of Optional. | Optional | Optional | Yes | Yes | Yes | |||||
options | Object | Options model contains all reference related information | Yes | Yes | Yes | Yes | Yes | |||||
metadata | Array [Object] | A list of Metadata | Optional | Optional | Yes | Yes | Yes | |||||
status | Enum
| A status of a contest | No | No | Yes | Yes | Yes | |||||
statusCode | Integer
| Integer value representation of the "status" field | No | No | Yes | Yes | Yes | |||||
created | DateTime | ISO8601 timestamp for when a Contest was created. All records are stored in UTC time zone. | Yes | Yes | Yes | |||||||
id | String | Unique system identifier of a Contest | Yes | Yes | Yes | |||||||
translations | Object | It is a key-value pair of language code and a list of translations. The translatable fields are "label", "description" and "termsConditions". Translation model | Optional | Optional | Yes | Yes | Yes | |||||
Contest Status values - Deleting, Preparing , Starting, Finishing, Cancelling and Finalising are a type of transient status used by the system. Please do not use them for testing.