This operation retrieves a list of available campaigns and can be used when a player is entering a game lobby. So players could see the lobby banner with current campaigns in the customer website.
Request
Parameter | Description | Format | Example |
partnerID | Unique Partner ID associated with the customer |
GUID | D61A14AE-0A0C-464B-B7AB-5900BE7462F9 |
sign | Parameters - partnerID, name, type (for more information, see Creating Data Sign) |
string (64) | 5E0A0349AE36AD67 CD21D891AB124CCE 8CC4171C5BD7EF5B 26FCA86DB71F500A |
name | Player’s name | string (48) | Player01 |
type | The type of campaign | string | FreeGamesBonus |
Request example:
REST JSON
POST https://staging.tomhorngames.com/services/gms/RestCustomerIntegrationService.svc/GetCampaigns HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: application/json
Content-Length: 123456
Host: staging.tomhorngames.com
{
"partnerID" : "9a2e7402-5cef-42ed-84a6-db589ce19fc6",
"sign" : "E8C1A3EB1BDD263B9FB5213AFFF8AEF909F0D9934BFFEDAD481091CDE36EB365",
"name" : "test_EUR",
"type" : "FreeGamesBonus"
}
Response
Parameter | Description | Format | Example |
Code | Result codes: 0, 1, 11, 12, 1001, 1002, 1003, 1006, 1007, 1010, 1017, 1033 (for more information, see Result Codes) | integer | 0 |
Message | Description of the error, if one has occurred. This value is filled only in the event that an error takes place. | string (255) | Cannot find specified identity |
Campaigns | List of available campaigns for the specified player. The property is set only if the result code is 0 (success) | ||
Campaign | Information about campaign | string | campaign 1 |
Name | Name of the campaign | string | Customer_1 |
CoinSize | The coin size value of the campaing |
decimal | 0.02 |
Code | Code of the campaign | string | VSlotHB_TNP |
GameModuleKey | Key of the game module |
string (50) | VSlotHB_TNP |
GamesPerPlayer | The total number of games for each player in campaign |
short | 20 |
GamesRemaining | The remaining games count for each player |
short | 10 |
StartDate |
Full date and time of campaign start (in UTC) | DateTime | 2022-10-18T12:41:00 |
EndDate | Full date and time of campaign end (in UTC) | DateTime | 2022-10-18T17:41:00 |
State | State of the campaign: Upcoming, Running, Completed or Canceled | enumeration value | Running |
Response example:
REST JSON
{
"Campaigns": [ {
"Code": "Customer_1",
"EndDate": "2016-10-05T08:00:00",
"GameModuleKey": "VSlotBM",
"GamesPerPlayer": 10,
"GamesRemaining": 10,
"Name": "campaign 1",
"CoinSize": "0.02",
"StartDate": "2016-09-04T08:00:00",
"State": "Running"
}],
"Code": 0,
"Message": null
}
SOAP
<GetCampaignsResult> <Code>0</Code> <Message></Message> <Campaigns> <Campaign> <Name>campaign 1</Name> <Code>Customer_1</Code> <GameModuleKey>VSlotHB</GameModuleKey> <GamesPerPlayer>20</GamesPerPlayer> <GamesRemaining>10</GamesRemaining> <StartDate>2013-10-11T10:00:00</StartDate> <EndDate>2013-11-18T12:41:00</EndDate> <State>Running</State> </Campaign> <Campaign> <Name>campaign 2</Name> <Code>Customer_2</Code> <GameModuleKey>VSlotBM</GameModuleKey> <GamesPerPlayer>10</GamesPerPlayer> <GamesRemaining>10</GamesRemaining> <StartDate>2013-10-11T10:00:00</StartDate> <EndDate>2013-11-11T10:00:00</EndDate> <State>Running</State> </Campaign> <Campaign> <Name>campaign 3</Name> <Code>Customer_3</Code> <GameModuleKey>VSlotMS</GameModuleKey> <GamesPerPlayer>7</GamesPerPlayer> <GamesRemaining>7</GamesRemaining> <StartDate>2013-10-11T10:00:00</StartDate> <EndDate>2013-11-11T14:00:00</EndDate> <State>Running</State> </Campaign> ... </Campaigns> </GetCampaignsResult>
Comments
0 comments
Article is closed for comments.