Sample - GET /api/:space/competitions/:competitionId/contests/sample

Description:

Returns a list of sample contests for a specified competition identifier.

Resource URL:

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

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

curl
--header "X-API-KEY: <your-api-key>"
--request GET https://app.competitionlabs.com/api/<your-space-name>/competitions/AnyId/contests/sample

Response

{
    "data": [
        {
            "jsonClass": "Contest",
            "competitionId": "VbNyw2UBOmEkXOJnPmO7",
            "number": 2,
            "label": "B",
            "round": 2,
            "roundType": "TargetBased",
            "groupStage": 1,
            "groupStageLabel": "A",
            "entrantsFromContest": [
                "1",
                "2"
            ],
            "options": {
                "numberOfEntrants": {
                    "jsonClass": "MaxMin",
                    "maximum": 1000,
                    "minimum": 2
                },
                "products": [
                    {
                        "jsonClass": "Product",
                        "name": "Poker",
                        "productType": "Cards",
                        "accountId": "SrNqw2UBOmEkXOJn4GOT",
                        "description": "1st product created.",
                        "adjustmentFactor": 4.12,
                        "productRefId": "ex-product-ref-sample-id-0",
                        "actionAdjustmentFactors": [],
                        "productGroups": [],
                        "created": "2018-09-10T14:18:06.101+02:00"
                    }
                ],
                "ruleSets": [
                    {
                        "jsonClass": "RuleSet",
                        "priority": 1,
                        "scope": "Competition",
                        "action": "start.competition",
                        "conditions": [
                            {
                                "jsonClass": "MainConditionSet",
                                "matchCondition": "All",
                                "mustEvaluateTo": true,
                                "rules": [
                                    {
                                        "jsonClass": "MainRule",
                                        "fact": "number.of.entrants.accepted",
                                        "operator": "equal.to",
                                        "constant": "1"
                                    },
                                    {
                                        "jsonClass": "MainRule",
                                        "fact": "competition.status",
                                        "operator": "equal.to",
                                        "constant": "Finished"
                                    }
                                ]
                            }
                        ]
                    }
                ],
                "isPublic": true,
                "autoStart": true,
                "autoStartRetryInterval": 60000,
                "autoStop": true,
                "autoStopRetryInterval": 60000,
                "scheduledDates": {
                    "jsonClass": "StartEndDate",
                    "start": "2018-09-10T14:22:03.816+02:00",
                    "end": "2018-09-10T16:22:03.816+02:00"
                },
                "actualDates": {
                    "jsonClass": "StartEndDate"
                },
                "limitEntrantsTo": [
                    "vip"
                ],
                "optinRequiredForEntrants": true,
                "useGlobalEvents": true
            },
            "created": "2018-09-10T14:26:08.955+02:00",
            "id": "XLN8w2UBOmEkXOJnKGPv",
            "translations": {
                "af": [
                    {
                        "jsonClass": "Translation",
                        "fieldName": "label",
                        "text": "My Constasie"
                    }
                ]
            },
            "status": "NotStarted",
            "statusCode": 0,
            "translatableFields": [
                "label",
                "description",
                "termsConditions"
            ]
        }
    ]
}

ERROR CODES

Code	HTTP Status	Description	Example
1007	404	Contest with CL-contestId not found for the CL-competitionId	Error Response 404 Expand source { "errors": [ { "message": "Contest with CL-contestId: samples not found for the CL-competitionId: .", "code": 1007, "status": 404 } ] }