This operation retrieves a list of all campaigns for a customer.
Request
PARAMETER | DESCRIPTION | FORMAT | EXAMPLE |
partnerID | The ID of partner Unique ID associated with each customer | GUID | D61A14AE-0A0C-464B-B7AB-5900BE7462F9 |
sign | Parameters partnerID, type (for more information, see Creating Data Sign) | string (64) | 5E0A0349AE36AD67 CD21D891AB124CCE 8CC4171C5BD7EF5B 26FCA86DB71F500A |
type | The type of campaign | string | FreeGamesBonus |
Request example:
REST JSON
POST https://staging.tomhorngames.com/services/gms/RestCustomerIntegrationService.svc/GetCustomerCampaigns 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",
"type" : "FreeGamesBonus"
}
Response
PARAMETER | DESCRIPTION | FORMAT | EXAMPLE |
Code | Result codes: 0, 1, 11, 12, 1001, 1002 (for more information, see Result Codes) | integer | 0 |
Message | Description of the error, if one has occurred. This value is filled only if an error takes place. | string (256) | Cannot find specified identity |
Campaigns | List of all customer campaigns. The property is set only if the result code is 0 (success) | ||
CustomerCampaign | Information about customer campaign | ||
Code | Code of the campaign | string (32) | Customer_1 |
Name | Name of the campaign | string (64) | Customer campaign |
Currencies | List of currency codes of the campaign separated by comma | string | USD,EUR |
StartDate | Full date and time of campaign start (in UTC) | DateTime | 2013-11-18T12:30:00 |
EndDate | Full date and time of campaign end (in UTC) | DateTime | 2013-11-18T18:30:00 |
Games | Names of the game modules separated by comma | string | Magic Fruits,Golden Bells |
State | State of the campaign | enumeration value | Running |
PlayersCount | The number of players | int | 10 |
GamesCount | The total number of games | int | 100 |
GamesPlayed | The games played in the campaign | int | 20 |
GamesRemaining | The remaining games count | int | 80 |
TotalWin | Total win amount | decimal | 7.3800 |
Response example:
REST JSON
{
"Campaigns": [ {
"Code": "Customer_1",
"Currencies": "EUR",
"EndDate": "2013-10-11T14:30:00",
"Games": "Magic Fruit",
"GamesCount": 200,
"GamesPlayed": 200,
"GamesRemaining": 0,
"Name": "Customer campaign 1",
"PlayersCount": 20,
"CoinSize": 0.02,
"StartDate": "2013-10-10T14:30:00",
"State": "Completed",
"TotalWin": 67.8000
},
{
"Code": "Customer_2",
"Currencies": "EUR",
"EndDate":"2013-11-18T11:30:00",
"Games": "Magic Fruit",
"GamesCount": 100,
"GamesPlayed": 20,
"GamesRemaining": 80,
"Name": "Customer campaign 2",
"PlayersCount": 10,
"CoinSize": 0.10,
"StartDate": "2013-11-18T08:30:00",
"State": "Running",
"TotalWin": 7.3800
},
{
"Code": "Customer_3",
"Currencies": "EUR",
"EndDate": "2013-11-18T18:30:00",
"Games": "Magic Fruit",
"GamesCount": 150,
"GamesPlayed": 0,
"GamesRemaining": 150,
"Name": "Customer campaign 3",
"PlayersCount ":10,
"CoinSize": 1.00,
"StartDate": "2013-11-18T012:30:00",
"State": "Upcoming",
"TotalWin": 0.0000
}],
"Code": 0,
"Message": null
}
SOAP
<GetCustomerCampaignsResult> <Code>0</Code> <Message></Message> <Campaigns> <CustomerCampaign> <Code>Customer_1</Code> <Name>Customer campaign 1</Name> <Currencies>USD</Currencies> <StartDate>2013-10-10T14:30:00</StartDate> <EndDate>2013-10-11T14:30:00</EndDate> <Games>Magic Fruits</Games> <State>Completed</State> <PlayersCount>20</PlayersCount> <GamesCount>200</GamesCount> <GamesPlayed>200</GamesPlayed> <GamesRemaining>0</GamesRemaining> <TotalWin>67.8000</TotalWin> </CustomerCampaign> <CustomerCampaign> <Code>Customer_2</Code> <Name>Customer campaign 2</Name> <Currencies>USD</Currencies> <StartDate>2013-11-18T08:30:00</StartDate> <EndDate>2013-11-18T11:30:00</EndDate> <Games>Magic Fruits</Games> <State>Running</State> <PlayersCount>10</PlayersCount> <GamesCount>100</GamesCount> <GamesPlayed>20</GamesPlayed> <GamesRemaining>80</GamesRemaining> <TotalWin>7.3800</TotalWin> </CustomerCampaign> <CustomerCampaign> <Code>Customer_3</Code> <Name>Customer campaign 3</Name> <Currencies>USD</Currencies> <StartDate>2013-11-18T012:30:00</StartDate> <EndDate>2013-11-18T18:30:00</EndDate> <Games>Magic Fruits</Games> <State>Upcoming</State> <PlayersCount>10</PlayersCount> <GamesCount>150</GamesCount> <GamesPlayed>0</GamesPlayed> <GamesRemaining>150</GamesRemaining> <TotalWin>0</TotalWin> </CustomerCampaign> ... </Campaigns> </GetCustomerCampaignsResult>
Comments
0 comments
Article is closed for comments.