Description:
Returns competition details for the ID specified.
Resource URL:
https://<apphost>.competitionlabs.com/api/<your-space-name>/competitions/<competitionId>
Request header
| 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
Request Expand source
curl --header "X-API-KEY: <your-api-key>" --request GET https://app.competitionlabs.com/api/<your-space-name>/competitions/6U71m2oBN4riPfvG12jT
Response Expand source
{
"data": {
"jsonClass": "Competition",
"accountId": "FuyNjGYBZ-qHKtWicfwh",
"competitionType": "Leaderboard",
"entrantMemberType": "Individual",
"allowMultipleEntriesPerRound": true,
"numberOfRounds": 1,
"label": "test by 2 rounds",
"description": "",
"termsConditions": "",
"options": {
"numberOfEntrants": {
"jsonClass": "MaxMin",
"minimum": 0
},
"products": [
{
"jsonClass": "Product",
"name": "test",
"productType": "test",
"accountId": "FuyNjGYBZ-qHKtWicfwh",
"description": "test",
"adjustmentFactor": 1.0,
"productRefId": "test",
"actionAdjustmentFactors": [
{
"ruleActionHelper": {
"jsonClass": "RuleActionHelper",
"name": "one",
"key": "3",
"description": "1",
"accountId": "FuyNjGYBZ-qHKtWicfwh",
"system": false,
"metadata": [
{
"jsonClass": "Metadata",
"key": "img",
"value": "https://game-images.isoftbet-aldn.com/symbols/4192/7.gif"
}
],
"created": "2019-05-06T20:23:46.871+00:00",
"id": "GH3RjmoBhII7yAb5D6u3"
},
"adjustmentFactor": 3.0
},
{
"ruleActionHelper": {
"jsonClass": "RuleActionHelper",
"name": "one",
"key": "3",
"description": "1",
"accountId": "FuyNjGYBZ-qHKtWicfwh",
"system": false,
"metadata": [
{
"jsonClass": "Metadata",
"key": "img",
"value": "https://game-images.isoftbet-aldn.com/symbols/4192/7.gif"
}
],
"created": "2019-05-06T20:23:46.871+00:00",
"id": "GH3RjmoBhII7yAb5D6u3"
},
"adjustmentFactor": 2.0
},
{
"ruleActionHelper": {
"jsonClass": "RuleActionHelper",
"name": "one",
"key": "3",
"description": "1",
"accountId": "FuyNjGYBZ-qHKtWicfwh",
"system": false,
"metadata": [
{
"jsonClass": "Metadata",
"key": "img",
"value": "https://game-images.isoftbet-aldn.com/symbols/4192/7.gif"
}
],
"created": "2019-05-06T20:23:46.871+00:00",
"id": "GH3RjmoBhII7yAb5D6u3"
},
"adjustmentFactor": 4.0
}
],
"productGroups": [
"test"
],
"metadata": [],
"created": "2019-05-06T20:31:31.855+00:00",
"id": "0ArYjmoBEMYIEIZyKDsP"
}
],
"ruleSets": [],
"isPublic": true,
"autoStart": true,
"autoStartRetryInterval": 1000,
"autoStop": true,
"autoStopRetryInterval": 1000,
"scheduledDates": {
"jsonClass": "StartEndDate",
"start": "2019-05-09T10:08:00.000+00:00",
"end": "2019-05-09T11:08:00.000+00:00"
},
"actualDates": {
"jsonClass": "StartEndDate",
"start": "2019-05-09T10:08:02.869+00:00",
"end": "2019-05-09T11:09:12.905+00:00"
},
"limitEntrantsTo": [
"$ALL"
],
"includeEntrantsWhere": {
"filters": [],
"shouldMatchAtLeast": 0
},
"optinRequiredForEntrants": false,
"useGlobalEvents": false
},
"metadata": [],
"created": "2019-05-09T09:39:01.203+00:00",
"id": "6U71m2oBN4riPfvG12jT",
"translations": {},
"status": "Finished",
"statusCode": 7,
"translatableFields": [
"label",
"description",
"termsConditions"
]
}
}
ERROR CODES
| Code | HTTP Status | Description | Example |
|---|---|---|---|
| 1007 | 404 | Competition with CL-compId not found for the accountId |
Error Response 404 Expand source
{
"errors": [
{
"message": "Competition with CL-compId: a not found for the account: FuyNjGYBZ-qHKtWicfwh.",
"code": 1007,
"status": 404
}
]
}
|