Client
Work with Clients.
| API | Description |
|---|---|
| GET v1/clients |
Returns an array of all clients |
| GET v1/clients/{id} |
Retrieves a client by their id |
| GET v1/clients/{id}/keys |
Retrieves all client keys for a client by their id |
| POST v1/clients/{id}/create-clientkey |
Add new Client Key to Client |
| POST v1/clients/{id}/remove-clientkey |
Remove Client Key to Client |
| POST v1/clients |
Creates a client |
| PUT v1/clients/{id} |
Creates a new client or updates an existing client |
Exception
| API | Description |
|---|---|
| POST v1/Exception/LogJavaScriptError |
No documentation available. |
GameListSummary
Work with GameListSummaryzes.
| API | Description |
|---|---|
| GET v1/gameListSummaries/page/{pageNumber}/perpage/{perPage}/sort/{sort}/direction/{direction} |
Returns an array of all GameListSummaries |
| GET v1/gameListSummaries/{id} |
Retrieves a GameListSummary by their id |
Debug
Debug the service itself. Check online status, authentication, server time, etc.
| API | Description |
|---|---|
| POST v1/debug/AnonymousPing |
Returns true, no authentication required |
| POST v1/debug/Time |
Returns site time, authentication required |
| POST v1/debug/AuthenticatedPing |
Returns true, authentication required |
| POST v1/debug/ErrorPreview |
Generates a handled error and returns it |
| POST v1/debug/ServerErrorPreview |
Throws an unhandled error |
| POST v1/debug/WhoAmI |
Displays the name of the authenticated client |
Participant
Work with a Participant. Requires Participant Key
| API | Description |
|---|---|
| GET v1/Participant |
Return top level information about a Participant |
| GET v1/Participant/{id} |
Retrieves a Participant by their id |
| POST v1/Participant |
Creates a Participant |
| PUT v1/Participant/{id} |
Creates a new participant or updates an existing participant |
GameType
Work with Games.
| API | Description |
|---|---|
| GET v1/gameTypes |
Returns an array of all Games Types |
| GET v1/gameTypes/{id} |
Retrieves a Game Type by their id |
| POST v1/gameTypes |
Creates a Game Type |
| PUT v1/gameTypes/{id} |
Creates a new game type or updates an existing game type |
| DELETE v1/gameTypes/{id} |
Remove Game Type |
| GET v1/gameTypes/{id}/screenShot |
Get a ScreenShot.png |
| POST v1/gameTypes/{id}/upload-screenShot |
Upload a Screen Shot to a Game Type |
Budget
Work with Games.
| API | Description |
|---|---|
| GET v1/games/{id}/budget |
Retrieves a Budget by the game id |
| PUT v1/games/{id}/budget |
Creates a new game or updates an existing game |
Report
| API | Description |
|---|---|
| GET v1/reports/detail/{id}/page/{pageNumber}/perpage/{perPage}/sort/{sort}/direction/{direction} |
Game Detail Report |
| GET v1/reports/detailvisual/{id}/start/{startDate}/end/{endDate} |
Game Detail Report Visualization |
| GET v1/reports/summary/page/{pageNumber}/perpage/{perPage}/sort/{sort}/direction/{direction} |
Client Summary Report |
| GET v1/reports/excel/summary |
Retrieves excel version of Game List Summary Report |
| GET v1/reports/excel/detail/{id} |
Retrieves the excel version of the Game Detail Report |
GamePlays
Work with a game plays. Requires Client Authentication
| API | Description |
|---|---|
| POST v1/game-plays/start-game-play |
Request a Game Play |
| GET v1/game-plays?participantId={participantId}&latest={latest} |
No documentation available. |
Token
Work with tokens. Requires Client Authentication
| API | Description |
|---|---|
| POST v1/tokens/participant/{id} |
Creates a token for a user so that they can play a game. If the participant does not already exist in the system, it will be created before the token is created. |
| GET v1/tokens/{tokenId} |
Returns token by token id |
| GET v1/tokens/participant/{id} |
Returns an array of all tokens for a single participant. If the participant does not already exist in the system, it will be created and an empty list will be returned. |
| GET v1/tokens/expired/{id}?pageIndex={pageIndex}&pageSize={pageSize} |
Get a list of expired tokens for a given game |
| POST v1/tokens/expired/{id}/{tokenId}/paid |
Marks a token as paid so that it doesn't show up in the get expired tokens call anymore. |
Game
Work with Games.
| API | Description |
|---|---|
| GET v1/games |
Returns an array of all Games |
| GET v1/games/{id} |
Retrieves a Game by their id |
| POST v1/games |
Creates a Game |
| PUT v1/games/{id} |
Creates a new game or updates an existing game |
| POST v1/games/{id}/clone |
Clones an existing Game |
GamePlay
Work with a Game Play. Requires Game Play Key
| API | Description |
|---|---|
| GET v1/game-play |
Return top level information about a GamePlay |
| GET v1/game-play/stylesheet/{gamePlayKey} |
Returns a theme custom stylesheet for a game play |
| GET v1/game-play/companyLogo/{gamePlayKey} |
Get a CompanyLogo.png for game play |
| GET v1/game-play/programLogo/{gamePlayKey} |
Get a ProgramLogo.png for game play |
Theme
Work with themes.
| API | Description |
|---|---|
| GET v1/themes |
Returns an array of all themes |
| GET v1/themes/{id} |
Retrieves a theme by their id |
| POST v1/themes |
Creates a theme |
| PUT v1/themes/{id} |
Creates a new theme or updates an existing theme |
| GET v1/themes/{cid}/{id}/companyLogo |
Get a CompanyLogo.png |
| GET v1/themes/{clientid}/{id}/programLogo |
Get a ProgramLogo.png |
| GET v1/themes/{clientid}/{id}/frameBackground |
Get a FrameBackgroundImage.png |
| POST v1/themes/{id}/upload-companyLogo |
Upload a Company Logo to a Theme |
| DELETE v1/themes/{id}/companyLogo |
Delete a company logo |
| POST v1/themes/{id}/upload-programLogo |
Upload a Program Logo to a Theme |
| DELETE v1/themes/{id}/programLogo |
Delete a program logo |
| POST v1/themes/{id}/upload-frameBackgroundImage |
Upload a Frame Background Image to a Theme |
| DELETE v1/themes/{id}/frameBackgroundImage |
Delete a Frame Background Image |
PayoutOption
Work with Payout Options.
| API | Description |
|---|---|
| GET v1/games/{id}/payouts |
Returns an array of all Payout Options for the given Game |
| GET v1/games/{id}/payouts/{payoutOptionId} |
Retrieves a Payout Option by their id |
| POST v1/games/{id}/payouts |
Creates a Payout Option |
| PUT v1/games/{id}/payouts |
Creates a new payout option or updates an existing payout option |
| PUT v1/games/{id}/payouts/sort |
Sets the sort of the payout option |
| PUT v1/games/{id}/payouts/default |
Sets the default flag of the payout option |
| PUT v1/games/{id}/payouts/hidden |
Sets the hidden flag of the payout option |
| DELETE v1/games/{id}/payouts/{payoutOptionId} |
Remove Payout Option |