GET /api/:space/competitions/:competitionId/contests/enums/list

Description:

Returns a list of possible enums for contests in a competition specified

Resource URL:

https://<apphost>.competitionlabs.com/api/<your-space-name>/competitions/<competitionId>/contests/enums/list

Request header

KeyValueRequired
X-API-KEY
Your unique API keyYes
Content-Type
application/jsonYes

Request URL parameter

ParameterTypeRequiredDescription
space
StringYesThis is the space name which is linked to the account
id
StringYesCompetition identifier retrieved from GET Competitions resource

EXAMPLE

Request
curl
--header "X-API-KEY: <your-api-key>"
--request GET https://app.competitionlabs.com/api/your_space_name/comeptitions/3HgZs2UB8HzUh8MGPHAs/contests/enums/list
Response
{
    "data": {
        "contestStatus": [
            "Preview",
            "Unknown",
            "Deleting",
            "Deleted",
            "NotStarted",
            "Starting",
            "Active",
            "Finishing",
            "Finished",
            "Finalising",
            "Finalised",
            "Cancelling",
            "Cancelled"
        ]
    }
}

ERROR CODES

CodeHTTP StatusDescriptionExample
1007404Contest with CL-contestId not found for the CL-competitionId
Error Response 404
{
    "errors": [
        {
            "message": "Contest with CL-contestId: enums not found for the CL-competitionId: 3HgZs2UB8HzUh8MGPHAs.",
            "code": 1007,
            "status": 404
        }
    ]
}