Contests

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

Domain Object

Contest


Parameter

Type

Description



















Request


















Response
GETPUTPOSTDELETEGETPUTPOSTDELETE
accountId
StringUnique identifier of your account



YesYesYes
competitionId
StringA unique identifier of a Competition
YesYes
YesYesYes
number
IntegerThe row number for displaying the Contest in a table
YesYes
YesYesYes
label
StringA label for the Contest. Can be translated.
YesYes
YesYesYes
description
StringDescription of the Contest. Can be translated.
OptionalOptional
YesYesYes

termsConditions
StringTerms and conditions of a Contest. Can be translated.
OptionalOptional
YesYesYes
round
IntegerTo what round does the contest belong
YesYes
YesYesYes
roundType

Enum

  • TimeBound
The type of rounds in a contest
YesYes
Yes
YesYes
groupStage
IntegerIs used for more complex Competitions e.g. multi round competitions where round 1 group stage matched round 2
OptionalOptional

YesYesYes
groupStageLabel
StringThe label of the group stages e.g. Finals, Semi-finals
OptionalOptional
YesYesYes
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.


OptionalOptional
YesYesYes
options
ObjectOptions model contains all reference related information
YesYes
YesYesYes
metadata
Array [Object]A list of Metadata
OptionalOptional
YesYesYes
status

Enum

  • Preview


  • Unknown

  • 
Deleting

  • Deleted

  • NotStarted

  • Starting


  • Active


  • Finishing

  • 
Finished

  • 
Finalising


  • Finalised

  • Cancelling

  • 
Cancelled

A status of a contest
NoNo
YesYesYes
statusCode

Integer

  • -4 (Preview
)
  • -3 (Unknown
)

  • -2 (Deleting)

  • 
-1 (Deleted)

  • 
0 (NotStarted)

  • 1 (Starting)
  • 
2 (Active
)

  • 3 (Finishing)

  • 4 (Finished)

  • 
5 (Finalising
)

  • 6 (
Finalised)

  • 7 (Cancelling)

  • 8 (Cancelled)

Integer value representation of the "status" field
NoNo
YesYesYes
created
DateTimeISO8601 timestamp for when a Contest was created. All records are stored in UTC time zone.



YesYesYes

id
StringUnique system identifier of a Contest



YesYesYes
translations
ObjectIt is a key-value pair of language code and a list of translations. The translatable fields are "label", "description" and "termsConditions". Translation model
OptionalOptional
YesYesYes

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.