SysReadScenario

Reads a campaign scenario by campaign code and scenario code, and returns the full scenario configuration.

Service	Operation
campaign	SYS_READ_SCENARIO

Method Parameters

Parameter	Description
campaignCode	The campaign code that owns the scenario.
scenarioCode	The scenario code to read — for example A or B, or _ for the control scenario.

Usage

http://localhost:3000

C#

// Cloud Code only. To view example, switch to the Cloud Code tab

C++

// Cloud Code only. To view example, switch to the Cloud Code tab

Obj-C

// Cloud Code only. To view example, switch to the Cloud Code tab

Java

// Cloud Code only. To view example, switch to the Cloud Code tab

JavaScript

// Cloud Code only. To view example, switch to the Cloud Code tab

Dart

// Cloud Code only. To view example, switch to the Cloud Code tab

Roblox

-- N/A

GDScript

N/A

Lua

-- Cloud Code only. To view example, switch to the Cloud Code tab

Cloud Code

var campaignCode = "SUMMER2026";
var scenarioCode = "A";
var campaignProxy = bridge.getCampaignServiceProxy();

var postResult = campaignProxy.sysReadScenario(campaignCode, scenarioCode);

Raw

{
    "service": "campaign",
    "operation": "SYS_READ_SCENARIO",
    "data": {
        "campaignCode": "SUMMER2026",
        "scenarioCode": "A"
    }
}

JSON Response

{
    "data": {
        "campaignCode": "SUMMER2026",
        "scenarioCode": "A",
        "scenarioCampaignCode": "SUMMER2026:A",
        "description": "Beach",
        "overrides": {
            "globalProperties": {
                "xpMultiplier": {
                    "name": "xpMultiplier",
                    "value": "2"
                },
                "ThemeJson": {
                    "name": "ThemeJson",
                    "value": "{\"season\":\"Summer\",\"extra\":\"Beach\"}"
                }
            },
            "cashProducts": {
                "coinBundle10": {
                    "itemId": "coinBundle10",
                    "notForSale": false,
                    "priceId": 1,
                    "showAsListPrice": false
                }
            },
            "items": {
                "beachHat": {
                    "defId": "beachHat",
                    "buyPriceDisabled": false,
                    "buyPrice": {
                        "coin": 200
                    },
                    "showAsListPrice": false
                },
                "summerHat": {
                    "defId": "summerHat",
                    "buyPriceDisabled": true,
                    "buyPrice": null,
                    "showAsListPrice": false
                }
            }
        },
        "scenarioJson": {
            "customField1": "beach"
        },
        "version": 1,
        "createdAt": 1811725200000,
        "updatedAt": 1811725200000
    },
    "status": 200
}

Common Error Codes

Status Codes

Code	Name	Description
40345	MISSING_RECORD	No scenario exists for the specified campaignCode and scenarioCode.
40616	CLOUD_CODE_ONLY_METHOD	The method was called from a client. It can only be called from Cloud Code or S2S.
40731	FEATURE_NOT_SUPPORTED_BY_BILLING_PLAN	Billing plan does not include the Campaign feature. Requires a plan that includes Enterprise features.