Admin Panel

SCILLClient

Use this class to initiate the client side API.

Constructor

Initiate an instance of the SCILLClient class with the access token previously generated in the backend or in safe environments with the SCILLBackend class instance.

Use the getters to get a shared instance of the API classes. SCILLClient sets them up correctly for production use and with the correct authentication system.

Please note: You can implement the backend in any programming language you like, for example with NodeJS you can implement the backend side with a couple of lines of code.

public SCILLClient(string accessToken, string appId);
Parameters

accessToken string

You need to provide an access token that you previously generated with the EventsApi. Please check out the documentation about access tokens for more info.

appId string

This is the app id of your application. Use the Admin Panel to reveal the app id for your application.

EventsApi (Getter)

Returns a shared, lazy loaded instance of the EventsApi. It’s used to send events required for challenges and battle passes.

public EventsApi EventsApi;

ChallengesApi (Getter)

Returns a shared, lazy loaded instance of the ChallengesApi. It’s used to handle challenges.

static ChallengesApi ChallengesApi;

BattlePassesApi (Getter)

Returns a shared, lazy loaded instance of the BattlePassesApi. It’s used to handle battle passes.

static BattlePassesApi BattlePassesApi;

StartChallengeUpdateNotifications

Connects to SCILLs MQTT server and forwards incoming payloads to the provided handler function.

public void StartChallengeUpdateNotifications(ChallengeChangedNotificationHandler handler)
Parameters

handler ChallengeChangedNotificationHandler

Provide a handler function that is called whenever new payloads are sent from the SCILL backend. The function is defined like this:

public delegate void ChallengeChangedNotificationHandler(ChallengeWebhookPayload payload);
Warning

The payload is called from a worker thread to prevent blocking the main thread. However, as MQTT updates often have direct implication on the user interface make sure, that your User Interface supports updates from worker thread. Unity, for example does not support that, and you need to make sure, that you dispatch changes to the user interface in a way that it works with Unity. Please have a look in our Unity example code to understand how to do that.

StopChallengeUpdateNotifications

Disconnects from the MQTT server and stops receiving notifications.

public void StopChallengeUpdateNotifications(ChallengeChangedNotificationHandler handler)

StartBattlePassUpdateNotifications

Connects to SCILLs MQTT server and forwards incoming payloads to the provided handler function.

public void StartBattlePassUpdateNotifications(string battlePassId, BattlePassChangedNotificationHandler handler)
Parameters

battlePassId ChallengeChangedNotificationHandler

Provide the battle pass id. This is the same as the battle_pass_id property in the BattlePass object.

handler BattlePassChangedNotificationHandler

Provide a handler function that is called whenever new payloads are sent from the SCILL backend. The function is defined like this:

public delegate void BattlePassChangedNotificationHandler(BattlePassChallengeChangedPayload payload);
Warning

The payload is called from a worker thread to prevent blocking the main thread. However, as MQTT updates often have direct implication on the user interface make sure, that your User Interface supports updates from worker thread. Unity, for example does not support that, and you need to make sure, that you dispatch changes to the user interface in a way that it works with Unity. Please have a look in our Unity example code to understand how to do that.

StopChallengeUpdateNotifications

Disconnects from the MQTT server and stops receiving notifications.

public void StopChallengeUpdateNotifications(ChallengeChangedNotificationHandler handler)

GenerateAccessToken

public Array|Array GenerateAccessToken(ForeignUserIdentifier body);
Parameters

body ForeignUserIdentifier

Foreign user identifier.

Returns

In case of a success, this function returns an instance of [Array](./models.html# Warning: mb_strtolower() expects parameter 1 to be string, array given in /Users/pschuster/Documents/4Players/scill/developer-documentation/docs/smarty/templates_c/38e702377cf77a882280b7758c839c37abec261c_0.file.csharp-scillclient.tpl.php on line 255 ). In case of a failure, this function returns an instance of [Array](./models.html# Warning: mb_strtolower() expects parameter 1 to be string, array given in /Users/pschuster/Documents/4Players/scill/developer-documentation/docs/smarty/templates_c/38e702377cf77a882280b7758c839c37abec261c_0.file.csharp-scillclient.tpl.php on line 270 ) or [Array](./models.html# Warning: mb_strtolower() expects parameter 1 to be string, array given in /Users/pschuster/Documents/4Players/scill/developer-documentation/docs/smarty/templates_c/38e702377cf77a882280b7758c839c37abec261c_0.file.csharp-scillclient.tpl.php on line 270 ).

GetUserChallengeNotificationTopic

public Array|Array GetUserChallengeNotificationTopic(string challenge_id);

Get a topic to be used with an MQTT client to receive real time updates whenever the challenge changes.

Parameters

challenge_id string

The challenge id you want to get notified

Returns

In case of a success, this function returns an instance of [Array](./models.html# Warning: mb_strtolower() expects parameter 1 to be string, array given in /Users/pschuster/Documents/4Players/scill/developer-documentation/docs/smarty/templates_c/38e702377cf77a882280b7758c839c37abec261c_0.file.csharp-scillclient.tpl.php on line 255 ). In case of a failure, this function returns an instance of [Array](./models.html# Warning: mb_strtolower() expects parameter 1 to be string, array given in /Users/pschuster/Documents/4Players/scill/developer-documentation/docs/smarty/templates_c/38e702377cf77a882280b7758c839c37abec261c_0.file.csharp-scillclient.tpl.php on line 270 ).

GetUserChallengesNotificationTopic

public Array|Array GetUserChallengesNotificationTopic();

Get a topic to be used with an MQTT client to receive real time updates whenever challenges for the user provided by the access token change.

Returns

In case of a success, this function returns an instance of [Array](./models.html# Warning: mb_strtolower() expects parameter 1 to be string, array given in /Users/pschuster/Documents/4Players/scill/developer-documentation/docs/smarty/templates_c/38e702377cf77a882280b7758c839c37abec261c_0.file.csharp-scillclient.tpl.php on line 255 ). In case of a failure, this function returns an instance of [Array](./models.html# Warning: mb_strtolower() expects parameter 1 to be string, array given in /Users/pschuster/Documents/4Players/scill/developer-documentation/docs/smarty/templates_c/38e702377cf77a882280b7758c839c37abec261c_0.file.csharp-scillclient.tpl.php on line 270 ).

GetUserBattlePassNotificationTopic

public Array|Array GetUserBattlePassNotificationTopic(string battle_pass_id);

Get a topic to be used with an MQTT client to receive real time updates whenever a battle pass changes.

Parameters

battle_pass_id string

The battle pass you want to get notified

Returns

In case of a success, this function returns an instance of [Array](./models.html# Warning: mb_strtolower() expects parameter 1 to be string, array given in /Users/pschuster/Documents/4Players/scill/developer-documentation/docs/smarty/templates_c/38e702377cf77a882280b7758c839c37abec261c_0.file.csharp-scillclient.tpl.php on line 255 ). In case of a failure, this function returns an instance of [Array](./models.html# Warning: mb_strtolower() expects parameter 1 to be string, array given in /Users/pschuster/Documents/4Players/scill/developer-documentation/docs/smarty/templates_c/38e702377cf77a882280b7758c839c37abec261c_0.file.csharp-scillclient.tpl.php on line 270 ).

GetUserInfo

public Array|Array GetUserInfo();

Returns additional info object with usernames and avatar image for a user which is used in the leaderboard system

Returns

In case of a success, this function returns an instance of [Array](./models.html# Warning: mb_strtolower() expects parameter 1 to be string, array given in /Users/pschuster/Documents/4Players/scill/developer-documentation/docs/smarty/templates_c/38e702377cf77a882280b7758c839c37abec261c_0.file.csharp-scillclient.tpl.php on line 255 ). In case of a failure, this function returns an instance of [Array](./models.html# Warning: mb_strtolower() expects parameter 1 to be string, array given in /Users/pschuster/Documents/4Players/scill/developer-documentation/docs/smarty/templates_c/38e702377cf77a882280b7758c839c37abec261c_0.file.csharp-scillclient.tpl.php on line 270 ).

SetUserInfo

public Array|Array SetUserInfo(UserInfo body);

Sets user info like username and avatar image which is returned as part of the user rankings in leaderboards.

Parameters

body UserInfo

UserInfo object stored in the SCILL database for the user

Returns

In case of a success, this function returns an instance of [Array](./models.html# Warning: mb_strtolower() expects parameter 1 to be string, array given in /Users/pschuster/Documents/4Players/scill/developer-documentation/docs/smarty/templates_c/38e702377cf77a882280b7758c839c37abec261c_0.file.csharp-scillclient.tpl.php on line 255 ). In case of a failure, this function returns an instance of [Array](./models.html# Warning: mb_strtolower() expects parameter 1 to be string, array given in /Users/pschuster/Documents/4Players/scill/developer-documentation/docs/smarty/templates_c/38e702377cf77a882280b7758c839c37abec261c_0.file.csharp-scillclient.tpl.php on line 270 ).

SendEvent

public Array|Array SendEvent(EventPayload body);

Post an event to the SCILL backend

Parameters

body EventPayload

Event payload or team event payload

Returns

In case of a success, this function returns an instance of [Array](./models.html# Warning: mb_strtolower() expects parameter 1 to be string, array given in /Users/pschuster/Documents/4Players/scill/developer-documentation/docs/smarty/templates_c/38e702377cf77a882280b7758c839c37abec261c_0.file.csharp-scillclient.tpl.php on line 255 ). In case of a failure, this function returns an instance of [Array](./models.html# Warning: mb_strtolower() expects parameter 1 to be string, array given in /Users/pschuster/Documents/4Players/scill/developer-documentation/docs/smarty/templates_c/38e702377cf77a882280b7758c839c37abec261c_0.file.csharp-scillclient.tpl.php on line 270 ) or [Array](./models.html# Warning: mb_strtolower() expects parameter 1 to be string, array given in /Users/pschuster/Documents/4Players/scill/developer-documentation/docs/smarty/templates_c/38e702377cf77a882280b7758c839c37abec261c_0.file.csharp-scillclient.tpl.php on line 270 ).

GetAvailableEvents

public Array GetAvailableEvents();

Get all available events and required and optional properties

Returns

In case of a success, this function returns an instance of [Array](./models.html# Warning: mb_strtolower() expects parameter 1 to be string, array given in /Users/pschuster/Documents/4Players/scill/developer-documentation/docs/smarty/templates_c/38e702377cf77a882280b7758c839c37abec261c_0.file.csharp-scillclient.tpl.php on line 255 ). In case of a failure, this function returns an instance of [Array](./models.html# Warning: mb_strtolower() expects parameter 1 to be string, array given in /Users/pschuster/Documents/4Players/scill/developer-documentation/docs/smarty/templates_c/38e702377cf77a882280b7758c839c37abec261c_0.file.csharp-scillclient.tpl.php on line 270 ).

GetPersonalChallenges

public Array|Array GetPersonalChallenges(array include_categories?, array exclude_categories?, string language?);

Get personal challenges organized in categories

Parameters

appId string

The app id

include_categories array OPTIONAL

A list of categories that should be included in the response. Only the categories provided will be returned

exclude_categories array OPTIONAL

A list of categories that should be excluded from the response. All categories except those listed here will be returned

language string OPTIONAL

Set the language. Content can be translated in the Admin Panel. Values can be international language codes like de, en, fr, it, …

Returns

In case of a success, this function returns an instance of [Array](./models.html# Warning: mb_strtolower() expects parameter 1 to be string, array given in /Users/pschuster/Documents/4Players/scill/developer-documentation/docs/smarty/templates_c/38e702377cf77a882280b7758c839c37abec261c_0.file.csharp-scillclient.tpl.php on line 255 ). In case of a failure, this function returns an instance of [Array](./models.html# Warning: mb_strtolower() expects parameter 1 to be string, array given in /Users/pschuster/Documents/4Players/scill/developer-documentation/docs/smarty/templates_c/38e702377cf77a882280b7758c839c37abec261c_0.file.csharp-scillclient.tpl.php on line 270 ).

GetUnresolvedPersonalChallenges

public Array|Array GetUnresolvedPersonalChallenges(array include_categories?, array exclude_categories?, string language?);

Get personal challenges organized in categories that are not yet finished

Parameters

appId string

The app id

include_categories array OPTIONAL

A list of categories that should be included in the response. Only the categories provided will be returned

exclude_categories array OPTIONAL

A list of categories that should be excluded from the response. All categories except those listed here will be returned

language string OPTIONAL

Set the language. Content can be translated in the Admin Panel. Values can be international language codes like de, en, fr, it, …

Returns

In case of a success, this function returns an instance of [Array](./models.html# Warning: mb_strtolower() expects parameter 1 to be string, array given in /Users/pschuster/Documents/4Players/scill/developer-documentation/docs/smarty/templates_c/38e702377cf77a882280b7758c839c37abec261c_0.file.csharp-scillclient.tpl.php on line 255 ). In case of a failure, this function returns an instance of [Array](./models.html# Warning: mb_strtolower() expects parameter 1 to be string, array given in /Users/pschuster/Documents/4Players/scill/developer-documentation/docs/smarty/templates_c/38e702377cf77a882280b7758c839c37abec261c_0.file.csharp-scillclient.tpl.php on line 270 ).

GetAllPersonalChallenges

public Array|Array GetAllPersonalChallenges(array include_categories?, array exclude_categories?, string language?);

Get personal challenges organized in categories that are not yet finished

Parameters

appId string

The app id

include_categories array OPTIONAL

A list of categories that should be included in the response. Only the categories provided will be returned

exclude_categories array OPTIONAL

A list of categories that should be excluded from the response. All categories except those listed here will be returned

language string OPTIONAL

Set the language. Content can be translated in the Admin Panel. Values can be international language codes like de, en, fr, it, …

Returns

In case of a success, this function returns an instance of [Array](./models.html# Warning: mb_strtolower() expects parameter 1 to be string, array given in /Users/pschuster/Documents/4Players/scill/developer-documentation/docs/smarty/templates_c/38e702377cf77a882280b7758c839c37abec261c_0.file.csharp-scillclient.tpl.php on line 255 ). In case of a failure, this function returns an instance of [Array](./models.html# Warning: mb_strtolower() expects parameter 1 to be string, array given in /Users/pschuster/Documents/4Players/scill/developer-documentation/docs/smarty/templates_c/38e702377cf77a882280b7758c839c37abec261c_0.file.csharp-scillclient.tpl.php on line 270 ).

GetPersonalChallengeById

public Array|Array GetPersonalChallengeById(string challengeId, string language?);

Get personal challenges organized in categories

Parameters

appId string

The app id

challengeId string

The challenge id (see challenge_id of Challenge object)

language string OPTIONAL

Set the language. Content can be translated in the Admin Panel. Values can be international language codes like de, en, fr, it, …

Returns

In case of a success, this function returns an instance of [Array](./models.html# Warning: mb_strtolower() expects parameter 1 to be string, array given in /Users/pschuster/Documents/4Players/scill/developer-documentation/docs/smarty/templates_c/38e702377cf77a882280b7758c839c37abec261c_0.file.csharp-scillclient.tpl.php on line 255 ). In case of a failure, this function returns an instance of [Array](./models.html# Warning: mb_strtolower() expects parameter 1 to be string, array given in /Users/pschuster/Documents/4Players/scill/developer-documentation/docs/smarty/templates_c/38e702377cf77a882280b7758c839c37abec261c_0.file.csharp-scillclient.tpl.php on line 270 ).

GetActivePersonalChallenges

public Array|Array GetActivePersonalChallenges(string language?);

Get active personal challenges organized in categories

Parameters

appId string

The app id

language string OPTIONAL

Set the language. Content can be translated in the Admin Panel. Values can be international language codes like de, en, fr, it, …

Returns

In case of a success, this function returns an instance of [Array](./models.html# Warning: mb_strtolower() expects parameter 1 to be string, array given in /Users/pschuster/Documents/4Players/scill/developer-documentation/docs/smarty/templates_c/38e702377cf77a882280b7758c839c37abec261c_0.file.csharp-scillclient.tpl.php on line 255 ). In case of a failure, this function returns an instance of [Array](./models.html# Warning: mb_strtolower() expects parameter 1 to be string, array given in /Users/pschuster/Documents/4Players/scill/developer-documentation/docs/smarty/templates_c/38e702377cf77a882280b7758c839c37abec261c_0.file.csharp-scillclient.tpl.php on line 270 ).

UnlockPersonalChallenge

public Array|Array UnlockPersonalChallenge(string challengeId, string language?);

Unlock a personal challenge by product id and challenge id

Parameters

appId string

The app id

challengeId string

The challenge id (see challenge_id of Challenge object)

language string OPTIONAL

Set the language. Content can be translated in the Admin Panel. Values can be international language codes like de, en, fr, it, …

Returns

In case of a success, this function returns an instance of [Array](./models.html# Warning: mb_strtolower() expects parameter 1 to be string, array given in /Users/pschuster/Documents/4Players/scill/developer-documentation/docs/smarty/templates_c/38e702377cf77a882280b7758c839c37abec261c_0.file.csharp-scillclient.tpl.php on line 255 ). In case of a failure, this function returns an instance of [Array](./models.html# Warning: mb_strtolower() expects parameter 1 to be string, array given in /Users/pschuster/Documents/4Players/scill/developer-documentation/docs/smarty/templates_c/38e702377cf77a882280b7758c839c37abec261c_0.file.csharp-scillclient.tpl.php on line 270 ).

ActivatePersonalChallenge

public Array|Array ActivatePersonalChallenge(string challengeId, string language?);

Activate a personal challenge by product id and user challenge id

Parameters

appId string

The app id

challengeId string

The challenge id (see challenge_id of Challenge object)

language string OPTIONAL

Set the language. Content can be translated in the Admin Panel. Values can be international language codes like de, en, fr, it, …

Returns

In case of a success, this function returns an instance of [Array](./models.html# Warning: mb_strtolower() expects parameter 1 to be string, array given in /Users/pschuster/Documents/4Players/scill/developer-documentation/docs/smarty/templates_c/38e702377cf77a882280b7758c839c37abec261c_0.file.csharp-scillclient.tpl.php on line 255 ). In case of a failure, this function returns an instance of [Array](./models.html# Warning: mb_strtolower() expects parameter 1 to be string, array given in /Users/pschuster/Documents/4Players/scill/developer-documentation/docs/smarty/templates_c/38e702377cf77a882280b7758c839c37abec261c_0.file.csharp-scillclient.tpl.php on line 270 ).

CancelPersonalChallenge

public Array|Array CancelPersonalChallenge(string challengeId, string language?);

Cancel an active personal challenge by product id and user challenge id

Parameters

appId string

The app id

challengeId string

The challenge id (see challenge_id of Challenge object)

language string OPTIONAL

Set the language. Content can be translated in the Admin Panel. Values can be international language codes like de, en, fr, it, …

Returns

In case of a success, this function returns an instance of [Array](./models.html# Warning: mb_strtolower() expects parameter 1 to be string, array given in /Users/pschuster/Documents/4Players/scill/developer-documentation/docs/smarty/templates_c/38e702377cf77a882280b7758c839c37abec261c_0.file.csharp-scillclient.tpl.php on line 255 ). In case of a failure, this function returns an instance of [Array](./models.html# Warning: mb_strtolower() expects parameter 1 to be string, array given in /Users/pschuster/Documents/4Players/scill/developer-documentation/docs/smarty/templates_c/38e702377cf77a882280b7758c839c37abec261c_0.file.csharp-scillclient.tpl.php on line 270 ).

ClaimPersonalChallengeReward

public Array|Array ClaimPersonalChallengeReward(string challengeId, string language?);

Claim the reward of a finished personal challenge by product id and user challenge id

Parameters

appId string

The app id

challengeId string

The challenge id (see challenge_id of Challenge object)

language string OPTIONAL

Set the language. Content can be translated in the Admin Panel. Values can be international language codes like de, en, fr, it, …

Returns

In case of a success, this function returns an instance of [Array](./models.html# Warning: mb_strtolower() expects parameter 1 to be string, array given in /Users/pschuster/Documents/4Players/scill/developer-documentation/docs/smarty/templates_c/38e702377cf77a882280b7758c839c37abec261c_0.file.csharp-scillclient.tpl.php on line 255 ). In case of a failure, this function returns an instance of [Array](./models.html# Warning: mb_strtolower() expects parameter 1 to be string, array given in /Users/pschuster/Documents/4Players/scill/developer-documentation/docs/smarty/templates_c/38e702377cf77a882280b7758c839c37abec261c_0.file.csharp-scillclient.tpl.php on line 270 ).

GenerateWebsocketAccessToken

public Array|Array GenerateWebsocketAccessToken();

Get an access token for the Websockets server notifying of updates in real time

Returns

In case of a success, this function returns an instance of [Array](./models.html# Warning: mb_strtolower() expects parameter 1 to be string, array given in /Users/pschuster/Documents/4Players/scill/developer-documentation/docs/smarty/templates_c/38e702377cf77a882280b7758c839c37abec261c_0.file.csharp-scillclient.tpl.php on line 255 ). In case of a failure, this function returns an instance of [Array](./models.html# Warning: mb_strtolower() expects parameter 1 to be string, array given in /Users/pschuster/Documents/4Players/scill/developer-documentation/docs/smarty/templates_c/38e702377cf77a882280b7758c839c37abec261c_0.file.csharp-scillclient.tpl.php on line 270 ).

GetBattlePasses

public Array|Array GetBattlePasses(string language?);

Get battle passes for the product

Parameters

appId string

The app id

language string OPTIONAL

Set the language. Content can be translated in the Admin Panel. Values can be international language codes like de, en, fr, it, …

Returns

In case of a success, this function returns an instance of [Array](./models.html# Warning: mb_strtolower() expects parameter 1 to be string, array given in /Users/pschuster/Documents/4Players/scill/developer-documentation/docs/smarty/templates_c/38e702377cf77a882280b7758c839c37abec261c_0.file.csharp-scillclient.tpl.php on line 255 ). In case of a failure, this function returns an instance of [Array](./models.html# Warning: mb_strtolower() expects parameter 1 to be string, array given in /Users/pschuster/Documents/4Players/scill/developer-documentation/docs/smarty/templates_c/38e702377cf77a882280b7758c839c37abec261c_0.file.csharp-scillclient.tpl.php on line 270 ).

GetActiveBattlePasses

public Array|Array GetActiveBattlePasses(string language?);

Get active battle passes for the app

Parameters

appId string

The app id

language string OPTIONAL

Set the language. Content can be translated in the Admin Panel. Values can be international language codes like de, en, fr, it, …

Returns

In case of a success, this function returns an instance of [Array](./models.html# Warning: mb_strtolower() expects parameter 1 to be string, array given in /Users/pschuster/Documents/4Players/scill/developer-documentation/docs/smarty/templates_c/38e702377cf77a882280b7758c839c37abec261c_0.file.csharp-scillclient.tpl.php on line 255 ). In case of a failure, this function returns an instance of [Array](./models.html# Warning: mb_strtolower() expects parameter 1 to be string, array given in /Users/pschuster/Documents/4Players/scill/developer-documentation/docs/smarty/templates_c/38e702377cf77a882280b7758c839c37abec261c_0.file.csharp-scillclient.tpl.php on line 270 ).

GetUnlockedBattlePasses

public Array|Array GetUnlockedBattlePasses(string language?);

Get unlocked battle passes for the user encoded in the access token

Parameters

appId string

The app id

language string OPTIONAL

Set the language. Content can be translated in the Admin Panel. Values can be international language codes like de, en, fr, it, …

Returns

In case of a success, this function returns an instance of [Array](./models.html# Warning: mb_strtolower() expects parameter 1 to be string, array given in /Users/pschuster/Documents/4Players/scill/developer-documentation/docs/smarty/templates_c/38e702377cf77a882280b7758c839c37abec261c_0.file.csharp-scillclient.tpl.php on line 255 ). In case of a failure, this function returns an instance of [Array](./models.html# Warning: mb_strtolower() expects parameter 1 to be string, array given in /Users/pschuster/Documents/4Players/scill/developer-documentation/docs/smarty/templates_c/38e702377cf77a882280b7758c839c37abec261c_0.file.csharp-scillclient.tpl.php on line 270 ).

GetBattlePass

public Array|Array GetBattlePass(string battlePassId, string language?);

Get battle pass for the product with id

Parameters

appId string

The app id

battlePassId string

The id of the battle pass. It’s the same as in battle_pass_id you received in earlier requests (i.e. getting all active battle passes for a product).

language string OPTIONAL

Set the language. Content can be translated in the Admin Panel. Values can be international language codes like de, en, fr, it, …

Returns

In case of a success, this function returns an instance of [Array](./models.html# Warning: mb_strtolower() expects parameter 1 to be string, array given in /Users/pschuster/Documents/4Players/scill/developer-documentation/docs/smarty/templates_c/38e702377cf77a882280b7758c839c37abec261c_0.file.csharp-scillclient.tpl.php on line 255 ). In case of a failure, this function returns an instance of [Array](./models.html# Warning: mb_strtolower() expects parameter 1 to be string, array given in /Users/pschuster/Documents/4Players/scill/developer-documentation/docs/smarty/templates_c/38e702377cf77a882280b7758c839c37abec261c_0.file.csharp-scillclient.tpl.php on line 270 ).

GetBattlePassLevels

public Array|Array GetBattlePassLevels(string battlePassId, string language?);

Get battle pass levels for a battle pass

Parameters

appId string

The app id

battlePassId string

The id of the battle pass. It’s the same as in battle_pass_id you received in earlier requests (i.e. getting all active battle passes for a product).

language string OPTIONAL

Set the language. Content can be translated in the Admin Panel. Values can be international language codes like de, en, fr, it, …

Returns

In case of a success, this function returns an instance of [Array](./models.html# Warning: mb_strtolower() expects parameter 1 to be string, array given in /Users/pschuster/Documents/4Players/scill/developer-documentation/docs/smarty/templates_c/38e702377cf77a882280b7758c839c37abec261c_0.file.csharp-scillclient.tpl.php on line 255 ). In case of a failure, this function returns an instance of [Array](./models.html# Warning: mb_strtolower() expects parameter 1 to be string, array given in /Users/pschuster/Documents/4Players/scill/developer-documentation/docs/smarty/templates_c/38e702377cf77a882280b7758c839c37abec261c_0.file.csharp-scillclient.tpl.php on line 270 ).

GetAllBattlePassLevels

public Array|Array GetAllBattlePassLevels(string language?);

Get all battle pass levels for an app

Parameters

appId string

The app id

language string OPTIONAL

Set the language. Content can be translated in the Admin Panel. Values can be international language codes like de, en, fr, it, …

Returns

In case of a success, this function returns an instance of [Array](./models.html# Warning: mb_strtolower() expects parameter 1 to be string, array given in /Users/pschuster/Documents/4Players/scill/developer-documentation/docs/smarty/templates_c/38e702377cf77a882280b7758c839c37abec261c_0.file.csharp-scillclient.tpl.php on line 255 ). In case of a failure, this function returns an instance of [Array](./models.html# Warning: mb_strtolower() expects parameter 1 to be string, array given in /Users/pschuster/Documents/4Players/scill/developer-documentation/docs/smarty/templates_c/38e702377cf77a882280b7758c839c37abec261c_0.file.csharp-scillclient.tpl.php on line 270 ).

ActivateBattlePassLevel

public Array|Array ActivateBattlePassLevel(string levelId, string language?);

Activate a given battle pass level by id

Parameters

appId string

The app id

levelId string

The id of the battle pass level.

language string OPTIONAL

Set the language. Content can be translated in the Admin Panel. Values can be international language codes like de, en, fr, it, …

Returns

In case of a success, this function returns an instance of [Array](./models.html# Warning: mb_strtolower() expects parameter 1 to be string, array given in /Users/pschuster/Documents/4Players/scill/developer-documentation/docs/smarty/templates_c/38e702377cf77a882280b7758c839c37abec261c_0.file.csharp-scillclient.tpl.php on line 255 ). In case of a failure, this function returns an instance of [Array](./models.html# Warning: mb_strtolower() expects parameter 1 to be string, array given in /Users/pschuster/Documents/4Players/scill/developer-documentation/docs/smarty/templates_c/38e702377cf77a882280b7758c839c37abec261c_0.file.csharp-scillclient.tpl.php on line 270 ).

ClaimBattlePassLevelReward

public Array|Array ClaimBattlePassLevelReward(string levelId, string language?);

Claim the battle pass level id

Parameters

appId string

The app id

levelId string

The id of the battle pass level.

language string OPTIONAL

Set the language. Content can be translated in the Admin Panel. Values can be international language codes like de, en, fr, it, …

Returns

In case of a success, this function returns an instance of [Array](./models.html# Warning: mb_strtolower() expects parameter 1 to be string, array given in /Users/pschuster/Documents/4Players/scill/developer-documentation/docs/smarty/templates_c/38e702377cf77a882280b7758c839c37abec261c_0.file.csharp-scillclient.tpl.php on line 255 ). In case of a failure, this function returns an instance of [Array](./models.html# Warning: mb_strtolower() expects parameter 1 to be string, array given in /Users/pschuster/Documents/4Players/scill/developer-documentation/docs/smarty/templates_c/38e702377cf77a882280b7758c839c37abec261c_0.file.csharp-scillclient.tpl.php on line 270 ).

UnlockBattlePass

public Array|Array UnlockBattlePass(string battlePassId, string language?);

Unlock the battle pass for a user

Parameters

appId string

The app id

battlePassId string

The id of the battle pass. It’s the same as in battle_pass_id you received in earlier requests (i.e. getting all active battle passes for a product).

language string OPTIONAL

Set the language. Content can be translated in the Admin Panel. Values can be international language codes like de, en, fr, it, …

Returns

In case of a success, this function returns an instance of [Array](./models.html# Warning: mb_strtolower() expects parameter 1 to be string, array given in /Users/pschuster/Documents/4Players/scill/developer-documentation/docs/smarty/templates_c/38e702377cf77a882280b7758c839c37abec261c_0.file.csharp-scillclient.tpl.php on line 255 ). In case of a failure, this function returns an instance of [Array](./models.html# Warning: mb_strtolower() expects parameter 1 to be string, array given in /Users/pschuster/Documents/4Players/scill/developer-documentation/docs/smarty/templates_c/38e702377cf77a882280b7758c839c37abec261c_0.file.csharp-scillclient.tpl.php on line 270 ).

GetLeaderboard

public Array|Array GetLeaderboard(string leaderboardId, int currentPage?, int pageSize?, string language?);

Provides the current leaderboard rankings for a specific leaderboard.

Parameters

leaderboardId string

The id of the leaderboard

currentPage integer OPTIONAL

The page index starting at 1. The number of pageSize elements are returned for each page. Default value is 1

pageSize integer OPTIONAL

The number of elements per page. Default is 25.

language string OPTIONAL

Set the language. Content can be translated in the Admin Panel. Values can be international language codes like de, en, fr, it, …

Returns

In case of a success, this function returns an instance of [Array](./models.html# Warning: mb_strtolower() expects parameter 1 to be string, array given in /Users/pschuster/Documents/4Players/scill/developer-documentation/docs/smarty/templates_c/38e702377cf77a882280b7758c839c37abec261c_0.file.csharp-scillclient.tpl.php on line 255 ). In case of a failure, this function returns an instance of [Array](./models.html# Warning: mb_strtolower() expects parameter 1 to be string, array given in /Users/pschuster/Documents/4Players/scill/developer-documentation/docs/smarty/templates_c/38e702377cf77a882280b7758c839c37abec261c_0.file.csharp-scillclient.tpl.php on line 270 ).

GetLeaderboards

public Array|Array GetLeaderboards(int currentPage?, int pageSize?, string language?);

Returns an array of Leaderboard items defined for the application.

Parameters

currentPage integer OPTIONAL

The page index starting at 1. The number of pageSize elements are returned for each page. Default value is 1

pageSize integer OPTIONAL

The number of elements per page. Default is 25.

language string OPTIONAL

Set the language. Content can be translated in the Admin Panel. Values can be international language codes like de, en, fr, it, …

Returns

In case of a success, this function returns an instance of [Array](./models.html# Warning: mb_strtolower() expects parameter 1 to be string, array given in /Users/pschuster/Documents/4Players/scill/developer-documentation/docs/smarty/templates_c/38e702377cf77a882280b7758c839c37abec261c_0.file.csharp-scillclient.tpl.php on line 255 ). In case of a failure, this function returns an instance of [Array](./models.html# Warning: mb_strtolower() expects parameter 1 to be string, array given in /Users/pschuster/Documents/4Players/scill/developer-documentation/docs/smarty/templates_c/38e702377cf77a882280b7758c839c37abec261c_0.file.csharp-scillclient.tpl.php on line 270 ).

GetLeaderboardRankings

public Array|Array GetLeaderboardRankings(string memberType, string memberId, string language?);

Returns an array of LeaderboardRanking items defined for all leaderboards in the application specified for the user.

Parameters

memberType string

The member type, can be user or team (right now) and sets which leaderboards should be selected.

memberId string

Either the user_id or team_id you used when sending the events. The memberType flag identifies which one is used.

language string OPTIONAL

Set the language. Content can be translated in the Admin Panel. Values can be international language codes like de, en, fr, it, …

Returns

In case of a success, this function returns an instance of [Array](./models.html# Warning: mb_strtolower() expects parameter 1 to be string, array given in /Users/pschuster/Documents/4Players/scill/developer-documentation/docs/smarty/templates_c/38e702377cf77a882280b7758c839c37abec261c_0.file.csharp-scillclient.tpl.php on line 255 ). In case of a failure, this function returns an instance of [Array](./models.html# Warning: mb_strtolower() expects parameter 1 to be string, array given in /Users/pschuster/Documents/4Players/scill/developer-documentation/docs/smarty/templates_c/38e702377cf77a882280b7758c839c37abec261c_0.file.csharp-scillclient.tpl.php on line 270 ).

GetLeaderboardRanking

public Array|Array GetLeaderboardRanking(string memberType, string memberId, string leaderboardId, string language?);

Returns a LeaderboardMemberRanking item for the specified leaderboard. Use this route to get the position of a user of team in a specified leaderboard.

Parameters

memberType string

The member type, can be user or team (right now) and sets which leaderboards should be selected.

memberId string

Either the user_id or team_id you used when sending the events. The memberType flag identifies which one is used.

leaderboardId string

The id of the leaderboard

language string OPTIONAL

Set the language. Content can be translated in the Admin Panel. Values can be international language codes like de, en, fr, it, …

Returns

In case of a success, this function returns an instance of [Array](./models.html# Warning: mb_strtolower() expects parameter 1 to be string, array given in /Users/pschuster/Documents/4Players/scill/developer-documentation/docs/smarty/templates_c/38e702377cf77a882280b7758c839c37abec261c_0.file.csharp-scillclient.tpl.php on line 255 ). In case of a failure, this function returns an instance of [Array](./models.html# Warning: mb_strtolower() expects parameter 1 to be string, array given in /Users/pschuster/Documents/4Players/scill/developer-documentation/docs/smarty/templates_c/38e702377cf77a882280b7758c839c37abec261c_0.file.csharp-scillclient.tpl.php on line 270 ).