This operation creates a new free games bonus campaign.
Request
| PARAMETER | DESCRIPTION | FORMAT | EXAMPLE |
| partnerID | ID of partner Unique ID associated with each customer |
GUID | D61A14AE-0A0C-464B-B7AB-5900BE7462F9 |
| sign | Parameters partnerID, campaignName, module, currency, gamesPerPlayer, timeFrom, timeTo (for more information, see Creating Data Sign) |
string (64) | 5E0A0349AE36AD67 CD21D891AB124CCE 8CC4171C5BD7EF5B 26FCA86DB71F500A |
| campaignName | Name of the campaign |
string |
campaign 1 |
| module | Key of the game module | string (50) | VSlotHB |
| currency | The campaign currency | string (3) | EUR |
| gamesPerPlayer | The total number of free games for player in campaign | short | 10 |
| coinSize |
The count size value used for the campaign. (see GetModuleSettings in order to understand the true bet in the game Totalbet - FGB bet amount = CoinSize from CreateCampaign Linebet - FGB bet amount = WinLineCount * CoinSize from CreateCampaign) LevelBet - do not support FGB *Optional, if it is not filled, It takes the lowest bet. |
decimal | 0.02 |
| timeFrom | Full date and time of campaign start (in UTC) | DateTime | 2024-04-21T00:00:00 |
| timeTo | Full date and time of campaign end (in UTC) | DateTime | 2024-04-24T08:00:00 |
Request example:
REST JSON
POST https://staging.tomhorngames.com/services/gms/RestCustomerIntegrationService.svc/CreateCampaign HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: application/json
Content-Length: 123456
Host: staging.tomhorngames.com
{
"partnerID" : "C77BB500-7E9A-4214-BD3C-605D6D2F91D9",
"sign" : "1A106C8C06A0DE71E23729101BC380BAD138C376E4DAADECDBF948B3BFB6A76E",
"campaignName" : "test_EUR",
"module" : "VSlotBM",
"currency" : "EUR",
"gamesPerPlayer" : "10",
"coinSize" : "0.02",
"timeFrom" : "2024-04-21T00:00:00",
"timeTo" : "2024-04-24T08:00:00"
}
Response
| PARAMETER | DESCRIPTION | FORMAT | EXAMPLE |
| Code | Result codes: 0, 1, 11, 12, 1001, 1002, 1010, 1012, 1015, 1040, 1041 (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 (256) | Cannot find specified identity |
| Campaign | Information about the campaign created. The property is set only if the result code is 0 (success) | ||
| Code | Code of the campaign | string | Customer_1 |
| Name | Name of the campaign | string | campaign 1 |
| GameModuleKey | Key of the game module | string (16) | VSlotHB |
| GamesPerPlayer | The total number of games for player in campaign | short | 10 |
| GamesRemaining | The remaining games count | short | 0 |
| StartDate | Full date and time of campaign start (in UTC) | DateTime | 2024-04-21T00:00:00 |
| EndDate | Full date and time of campaign end (in UTC) | DateTime | 2024-04-24T08:00:00 |
| State | State of the campaign: Upcoming, Running, Completed or Canceled | enumeration value | Running |
Response example:
REST JSON
{
"Campaign": {
"Code": "Customer_1",
"CoinSize": 1,
"EndDate": "2017-10-05T08:00:00",
"GameModuleKey": "VSlotBM",
"GamesPerPlayer": 10,
"GamesRemaining": 0,
"Name": "Customer campaign 1",
"StartDate": "2024-04-21T00:00:00",
"State": "Upcoming"
},
"Code": 0,
"Message": null
}
SOAP
<CreateCampaignResult>
<Code>0</Code>
<Message></Message>
<Campaign>
<Code>Customer_1</Code>
<CoinSize>1</CoinSize>
<Name>campaign 1</Name>
<GameModuleKey>VSlotHB</GameModuleKey>
<GamesPerPlayer>10</GamesPerPlayer>
<GamesRemaining>0</GamesRemaining>
<StartDate>2024-04-21T00:00:00</StartDate>
<EndDate>2024-04-24T08:00:00</EndDate>
<State>Upcoming</State>
</Campaign>
</CreateCampaignResult>
Comments
0 comments
Article is closed for comments.