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
Key | Value | Required |
X-API-KEY | Your unique API key | Yes |
Content-Type | application/json | Yes |
Request URL parameter
Parameter | Type | Required | Description |
---|
space | String | Yes | This is the space name which is linked to the account |
id | String | Yes | Competition identifier retrieved from GET Competitions resource |
EXAMPLE
curl
--header "X-API-KEY: <your-api-key>"
--request GET https://app.competitionlabs.com/api/your_space_name/comeptitions/3HgZs2UB8HzUh8MGPHAs/contests/enums/list
{
"data": {
"contestStatus": [
"Preview",
"Unknown",
"Deleting",
"Deleted",
"NotStarted",
"Starting",
"Active",
"Finishing",
"Finished",
"Finalising",
"Finalised",
"Cancelling",
"Cancelled"
]
}
}
ERROR CODES
Code | HTTP Status | Description | Example |
---|
1007 | 404 | Contest with CL-contestId not found for the CL-competitionId |
{
"errors": [
{
"message": "Contest with CL-contestId: enums not found for the CL-competitionId: 3HgZs2UB8HzUh8MGPHAs.",
"code": 1007,
"status": 404
}
]
}
|