Competitions/promotions/tournaments are a collection of contests, which consists of multiple products or event types for which individual events are collected for all participating members.
Competitions endpoints allows you to get information about your competitions which enables a developer to integrate with CompetitionLabs eco-system, determine which competitions are active and perform actions for members or events accordingly.
A single competition can consist of one or many contests.
What can you do?
Available Resources
- Get a list of Competitions;
- Find a specific Competition by passing various query parameters;
- Manage Competition statuses;
- Create a Competition;
- Preview a sample Competition;
- Preview Competition Types, Competition statuses, Round Types and so on.
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 | |||||||
competitionType | Enum
| Competition Type | Yes | Yes | Yes | Yes | Yes | |||||
entrantMemberType | Enum
| Member type that is either Individual or Team | Yes | Yes | Yes | Yes | Yes | |||||
numberOfRounds | Integer | Number of rounds to be played in a competition | Yes | Yes | Yes | Yes | Yes | |||||
label | String | A label or a name of a competition. Can be translated. | Yes | Yes | Yes | Yes | Yes | |||||
description | String | Description of the competition. Can be translated. | Optional | Optional | Yes | Yes | Yes | |||||
termsConditions | String | Terms and conditions of a competition. Can be translated. | 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 competition | 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 Competition was created. All records are stored in UTC time zone. | Yes | Yes | Yes | |||||||
id | String | Unique system identifier of a Competition | 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 | |||||
Note!
Competition Status values - Deleting, Preparing , Starting, Finishing, and Cancelling are a type of transient status used by the system. Please do not use them for testing.