{ "openapi": "3.0.4", "info": { "title": "FlowsPlay Game API - Main Endpoints 2.0", "version": "2.0" }, "servers": [ { "url": "/game" } ], "paths": { "/v2/sites/{siteId}/flashwins/{flashWinId}/appearance": { "get": { "tags": [ "FlashWinAppearance" ], "summary": "Get the flash win appearance details for the supplied site and flash win id", "parameters": [ { "name": "siteId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "flashWinId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "locale", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FlashWinGameAppearanceDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FlashWinGameAppearanceDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlashWinGameAppearanceDto" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } } } } }, "/v2/sites/{siteId}/flashwins/{flashWinId}/style.css": { "get": { "tags": [ "FlashWinAppearance" ], "summary": "Gets the css file for the given site and flash win id", "parameters": [ { "name": "siteId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "flashWinId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "locale", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "device", "in": "query", "description": "", "schema": { "$ref": "#/components/schemas/Device" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "text/css": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "200": { "description": "OK", "content": { "text/css": { "schema": { "type": "string", "format": "binary" } } } }, "404": { "description": "Not Found", "content": { "text/css": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } } } } }, "/v2/sites/{siteId}/flashwins/games/{gameId}": { "get": { "tags": [ "FlashWinGame" ], "summary": "Get the flash win game data for the supplied site and game id", "parameters": [ { "name": "siteId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "gameId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "Exception", "title": "GenericException", "status": 500, "detail": "An unexpected error occurred", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "Exception", "title": "GenericException", "status": 500, "detail": "An unexpected error occurred", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "Exception", "title": "GenericException", "status": 500, "detail": "An unexpected error occurred", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FlashWinsGameResponseDto" }, "example": { "organisationId": "{{siteId}}", "workspaceId": "{{flowsWorkspaceId}}", "flashWinId": "{{flashWinId}}", "requiresOptIn": false, "open": true, "startTime": 1784005848862, "endTime": 1784009448862, "currency": "{{currency}}", "prizeDistributionType": "Daily", "instanceId": 1, "status": null, "remainingPrizes": 5, "prizes": [ { "unqid": "{{prizeUnqid}}", "type": "{{prizeType}}", "amount": 100, "quantity": 10, "remaining": 5 } ] } }, "application/json": { "schema": { "$ref": "#/components/schemas/FlashWinsGameResponseDto" }, "example": { "organisationId": "{{siteId}}", "workspaceId": "{{flowsWorkspaceId}}", "flashWinId": "{{flashWinId}}", "requiresOptIn": false, "open": true, "startTime": 1784005848862, "endTime": 1784009448862, "currency": "{{currency}}", "prizeDistributionType": "Daily", "instanceId": 1, "status": null, "remainingPrizes": 5, "prizes": [ { "unqid": "{{prizeUnqid}}", "type": "{{prizeType}}", "amount": 100, "quantity": 10, "remaining": 5 } ] } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlashWinsGameResponseDto" }, "example": { "organisationId": "{{siteId}}", "workspaceId": "{{flowsWorkspaceId}}", "flashWinId": "{{flashWinId}}", "requiresOptIn": false, "open": true, "startTime": 1784005848862, "endTime": 1784009448862, "currency": "{{currency}}", "prizeDistributionType": "Daily", "instanceId": 1, "status": null, "remainingPrizes": 5, "prizes": [ { "unqid": "{{prizeUnqid}}", "type": "{{prizeType}}", "amount": 100, "quantity": 10, "remaining": 5 } ] } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Organisation is not set up for flash wins", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Organisation is not set up for flash wins", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Organisation is not set up for flash wins", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "No active flash win found for game: {{gameId}}", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "No active flash win found for game: {{gameId}}", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "No active flash win found for game: {{gameId}}", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "503": { "description": "Service Unavailable", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ServiceUnavailableException", "title": "ServiceUnavailable", "status": 503, "detail": "Flows API is unavailable and cached prize data is stale for flash win: {{flashWinId}}", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ServiceUnavailableException", "title": "ServiceUnavailable", "status": 503, "detail": "Flows API is unavailable and cached prize data is stale for flash win: {{flashWinId}}", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ServiceUnavailableException", "title": "ServiceUnavailable", "status": 503, "detail": "Flows API is unavailable and cached prize data is stale for flash win: {{flashWinId}}", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } } } } }, "/v2/sites/{siteId}/flashwins/games/{gameId}/brand/{brandId}": { "get": { "tags": [ "FlashWinGame" ], "summary": "Get the flash win game data for the supplied site, brand and game id", "parameters": [ { "name": "siteId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "gameId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "brandId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "Exception", "title": "GenericException", "status": 500, "detail": "An unexpected error occurred", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "Exception", "title": "GenericException", "status": 500, "detail": "An unexpected error occurred", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "Exception", "title": "GenericException", "status": 500, "detail": "An unexpected error occurred", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FlashWinsGameResponseDto" }, "example": { "organisationId": "{{siteId}}", "workspaceId": "{{flowsWorkspaceId}}", "flashWinId": "{{flashWinId}}", "requiresOptIn": false, "open": true, "startTime": 1784005848867, "endTime": 1784009448867, "currency": "{{currency}}", "prizeDistributionType": "Daily", "instanceId": 1, "status": null, "remainingPrizes": 5, "prizes": [ { "unqid": "{{prizeUnqid}}", "type": "{{prizeType}}", "amount": 100, "quantity": 10, "remaining": 5 } ] } }, "application/json": { "schema": { "$ref": "#/components/schemas/FlashWinsGameResponseDto" }, "example": { "organisationId": "{{siteId}}", "workspaceId": "{{flowsWorkspaceId}}", "flashWinId": "{{flashWinId}}", "requiresOptIn": false, "open": true, "startTime": 1784005848867, "endTime": 1784009448867, "currency": "{{currency}}", "prizeDistributionType": "Daily", "instanceId": 1, "status": null, "remainingPrizes": 5, "prizes": [ { "unqid": "{{prizeUnqid}}", "type": "{{prizeType}}", "amount": 100, "quantity": 10, "remaining": 5 } ] } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlashWinsGameResponseDto" }, "example": { "organisationId": "{{siteId}}", "workspaceId": "{{flowsWorkspaceId}}", "flashWinId": "{{flashWinId}}", "requiresOptIn": false, "open": true, "startTime": 1784005848867, "endTime": 1784009448867, "currency": "{{currency}}", "prizeDistributionType": "Daily", "instanceId": 1, "status": null, "remainingPrizes": 5, "prizes": [ { "unqid": "{{prizeUnqid}}", "type": "{{prizeType}}", "amount": 100, "quantity": 10, "remaining": 5 } ] } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Organisation is not set up for flash wins", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Organisation is not set up for flash wins", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Organisation is not set up for flash wins", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "No active flash win found for game: {{gameId}}", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "No active flash win found for game: {{gameId}}", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "No active flash win found for game: {{gameId}}", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "503": { "description": "Service Unavailable", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ServiceUnavailableException", "title": "ServiceUnavailable", "status": 503, "detail": "Flows API is unavailable and cached prize data is stale for flash win: {{flashWinId}}", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ServiceUnavailableException", "title": "ServiceUnavailable", "status": 503, "detail": "Flows API is unavailable and cached prize data is stale for flash win: {{flashWinId}}", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ServiceUnavailableException", "title": "ServiceUnavailable", "status": 503, "detail": "Flows API is unavailable and cached prize data is stale for flash win: {{flashWinId}}", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } } } } }, "/v2/sites/{siteId}/flashwins/games/{gameId}/players/sessions/{sessionId}": { "get": { "tags": [ "FlashWinGame" ], "summary": "Get the flash win game data for the supplied site and game id, evaluated for a specific player session", "parameters": [ { "name": "siteId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "gameId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "sessionId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "Exception", "title": "GenericException", "status": 500, "detail": "An unexpected error occurred", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "Exception", "title": "GenericException", "status": 500, "detail": "An unexpected error occurred", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "Exception", "title": "GenericException", "status": 500, "detail": "An unexpected error occurred", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FlashWinsGameResponseDto" }, "example": { "organisationId": "{{siteId}}", "workspaceId": "{{flowsWorkspaceId}}", "flashWinId": "{{flashWinId}}", "requiresOptIn": false, "open": true, "startTime": 1784005848871, "endTime": 1784009448871, "currency": "{{currency}}", "prizeDistributionType": "Daily", "instanceId": 1, "status": null, "remainingPrizes": 5, "prizes": [ { "unqid": "{{prizeUnqid}}", "type": "{{prizeType}}", "amount": 100, "quantity": 10, "remaining": 5 } ] } }, "application/json": { "schema": { "$ref": "#/components/schemas/FlashWinsGameResponseDto" }, "example": { "organisationId": "{{siteId}}", "workspaceId": "{{flowsWorkspaceId}}", "flashWinId": "{{flashWinId}}", "requiresOptIn": false, "open": true, "startTime": 1784005848871, "endTime": 1784009448871, "currency": "{{currency}}", "prizeDistributionType": "Daily", "instanceId": 1, "status": null, "remainingPrizes": 5, "prizes": [ { "unqid": "{{prizeUnqid}}", "type": "{{prizeType}}", "amount": 100, "quantity": 10, "remaining": 5 } ] } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlashWinsGameResponseDto" }, "example": { "organisationId": "{{siteId}}", "workspaceId": "{{flowsWorkspaceId}}", "flashWinId": "{{flashWinId}}", "requiresOptIn": false, "open": true, "startTime": 1784005848871, "endTime": 1784009448871, "currency": "{{currency}}", "prizeDistributionType": "Daily", "instanceId": 1, "status": null, "remainingPrizes": 5, "prizes": [ { "unqid": "{{prizeUnqid}}", "type": "{{prizeType}}", "amount": 100, "quantity": 10, "remaining": 5 } ] } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Organisation is not set up for flash wins", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Organisation is not set up for flash wins", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Organisation is not set up for flash wins", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "No active flash win found for game: {{gameId}}", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "No active flash win found for game: {{gameId}}", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "No active flash win found for game: {{gameId}}", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "503": { "description": "Service Unavailable", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ServiceUnavailableException", "title": "ServiceUnavailable", "status": 503, "detail": "Flows API is unavailable and cached prize data is stale for flash win: {{flashWinId}}", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ServiceUnavailableException", "title": "ServiceUnavailable", "status": 503, "detail": "Flows API is unavailable and cached prize data is stale for flash win: {{flashWinId}}", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ServiceUnavailableException", "title": "ServiceUnavailable", "status": 503, "detail": "Flows API is unavailable and cached prize data is stale for flash win: {{flashWinId}}", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } } } } }, "/v2/sites/{siteId}/flashwins/games/{gameId}/brand/{brandId}/players/sessions/{sessionId}": { "get": { "tags": [ "FlashWinGame" ], "summary": "Get the flash win game data for the supplied site, brand and game id, evaluated for a specific player session", "parameters": [ { "name": "siteId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "gameId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "brandId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "sessionId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "Exception", "title": "GenericException", "status": 500, "detail": "An unexpected error occurred", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "Exception", "title": "GenericException", "status": 500, "detail": "An unexpected error occurred", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "Exception", "title": "GenericException", "status": 500, "detail": "An unexpected error occurred", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FlashWinsGameResponseDto" }, "example": { "organisationId": "{{siteId}}", "workspaceId": "{{flowsWorkspaceId}}", "flashWinId": "{{flashWinId}}", "requiresOptIn": false, "open": true, "startTime": 1784005848874, "endTime": 1784009448874, "currency": "{{currency}}", "prizeDistributionType": "Daily", "instanceId": 1, "status": null, "remainingPrizes": 5, "prizes": [ { "unqid": "{{prizeUnqid}}", "type": "{{prizeType}}", "amount": 100, "quantity": 10, "remaining": 5 } ] } }, "application/json": { "schema": { "$ref": "#/components/schemas/FlashWinsGameResponseDto" }, "example": { "organisationId": "{{siteId}}", "workspaceId": "{{flowsWorkspaceId}}", "flashWinId": "{{flashWinId}}", "requiresOptIn": false, "open": true, "startTime": 1784005848874, "endTime": 1784009448874, "currency": "{{currency}}", "prizeDistributionType": "Daily", "instanceId": 1, "status": null, "remainingPrizes": 5, "prizes": [ { "unqid": "{{prizeUnqid}}", "type": "{{prizeType}}", "amount": 100, "quantity": 10, "remaining": 5 } ] } }, "text/json": { "schema": { "$ref": "#/components/schemas/FlashWinsGameResponseDto" }, "example": { "organisationId": "{{siteId}}", "workspaceId": "{{flowsWorkspaceId}}", "flashWinId": "{{flashWinId}}", "requiresOptIn": false, "open": true, "startTime": 1784005848874, "endTime": 1784009448874, "currency": "{{currency}}", "prizeDistributionType": "Daily", "instanceId": 1, "status": null, "remainingPrizes": 5, "prizes": [ { "unqid": "{{prizeUnqid}}", "type": "{{prizeType}}", "amount": 100, "quantity": 10, "remaining": 5 } ] } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Organisation is not set up for flash wins", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Organisation is not set up for flash wins", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Organisation is not set up for flash wins", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "No active flash win found for game: {{gameId}}", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "No active flash win found for game: {{gameId}}", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "No active flash win found for game: {{gameId}}", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "503": { "description": "Service Unavailable", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ServiceUnavailableException", "title": "ServiceUnavailable", "status": 503, "detail": "Flows API is unavailable and cached prize data is stale for flash win: {{flashWinId}}", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ServiceUnavailableException", "title": "ServiceUnavailable", "status": 503, "detail": "Flows API is unavailable and cached prize data is stale for flash win: {{flashWinId}}", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ServiceUnavailableException", "title": "ServiceUnavailable", "status": 503, "detail": "Flows API is unavailable and cached prize data is stale for flash win: {{flashWinId}}", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } } } } }, "/v2/sites/{siteId}/flashwins/{flashWinId}/players/sessions/{sessionId}/optinstatus": { "get": { "tags": [ "FlashWinOptInStatus" ], "summary": "Gets the player opt-in status for the given site and flash win using a session ID.\nThis call is intended to be called from the front end and does not require the site API key.", "parameters": [ { "name": "siteId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "flashWinId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "Exception", "title": "GenericException", "status": 500, "detail": "An unexpected error occurred", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "Exception", "title": "GenericException", "status": 500, "detail": "An unexpected error occurred", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "Exception", "title": "GenericException", "status": 500, "detail": "An unexpected error occurred", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProductPlayerOptInStatusDto" }, "example": { "isOptedIn": true } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProductPlayerOptInStatusDto" }, "example": { "isOptedIn": true } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProductPlayerOptInStatusDto" }, "example": { "isOptedIn": true } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "No active flash win found for game: {{gameId}}", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "No active flash win found for game: {{gameId}}", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "No active flash win found for game: {{gameId}}", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } } } }, "patch": { "tags": [ "FlashWinOptInStatus" ], "summary": "Sets the player opt-in status for the given site and flash win using a session ID.\nThis call is intended to be called from the front end and does not require the site API key.", "parameters": [ { "name": "siteId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "flashWinId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewProductPlayerOptInStatusDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NewProductPlayerOptInStatusDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NewProductPlayerOptInStatusDto" } } } }, "responses": { "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "Exception", "title": "GenericException", "status": 500, "detail": "An unexpected error occurred", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "Exception", "title": "GenericException", "status": 500, "detail": "An unexpected error occurred", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "Exception", "title": "GenericException", "status": 500, "detail": "An unexpected error occurred", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProductPlayerOptInStatusDto" }, "example": { "isOptedIn": true } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProductPlayerOptInStatusDto" }, "example": { "isOptedIn": true } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProductPlayerOptInStatusDto" }, "example": { "isOptedIn": true } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "No active flash win found for game: {{gameId}}", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "No active flash win found for game: {{gameId}}", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "No active flash win found for game: {{gameId}}", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } } } } }, "/v2/sites/{siteId}/flashwins/{flashWinId}/players/sessions/{sessionId}/brand/{brandId}/optinstatus": { "get": { "tags": [ "FlashWinOptInStatus" ], "summary": "Gets the player opt-in status for the given site, flash win, and brand using a session ID.\nThis call is intended to be called from the front end and does not require the site API key.", "parameters": [ { "name": "siteId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "flashWinId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "brandId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "Exception", "title": "GenericException", "status": 500, "detail": "An unexpected error occurred", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "Exception", "title": "GenericException", "status": 500, "detail": "An unexpected error occurred", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "Exception", "title": "GenericException", "status": 500, "detail": "An unexpected error occurred", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProductPlayerOptInStatusDto" }, "example": { "isOptedIn": true } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProductPlayerOptInStatusDto" }, "example": { "isOptedIn": true } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProductPlayerOptInStatusDto" }, "example": { "isOptedIn": true } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "No active flash win found for game: {{gameId}}", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "No active flash win found for game: {{gameId}}", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "No active flash win found for game: {{gameId}}", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } } } }, "patch": { "tags": [ "FlashWinOptInStatus" ], "summary": "Sets the player opt-in status for the given site, flash win, and brand using a session ID.\nThis call is intended to be called from the front end and does not require the site API key.", "parameters": [ { "name": "siteId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "flashWinId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "brandId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewProductPlayerOptInStatusDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NewProductPlayerOptInStatusDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NewProductPlayerOptInStatusDto" } } } }, "responses": { "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "Exception", "title": "GenericException", "status": 500, "detail": "An unexpected error occurred", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "Exception", "title": "GenericException", "status": 500, "detail": "An unexpected error occurred", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "Exception", "title": "GenericException", "status": 500, "detail": "An unexpected error occurred", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProductPlayerOptInStatusDto" }, "example": { "isOptedIn": true } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProductPlayerOptInStatusDto" }, "example": { "isOptedIn": true } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProductPlayerOptInStatusDto" }, "example": { "isOptedIn": true } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "No active flash win found for game: {{gameId}}", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "No active flash win found for game: {{gameId}}", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "No active flash win found for game: {{gameId}}", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } } } } }, "/v2/sites/{siteId}/flashwins/{flashWinId}/players/{playerId}/optinstatus": { "get": { "tags": [ "FlashWinOptInStatus" ], "summary": "Gets the player opt-in status for the given site and flash win using a raw player ID.\nThis call is intended to be called from another server and secured via the site API key.", "parameters": [ { "name": "siteId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "flashWinId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "playerId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "Exception", "title": "GenericException", "status": 500, "detail": "An unexpected error occurred", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "Exception", "title": "GenericException", "status": 500, "detail": "An unexpected error occurred", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "Exception", "title": "GenericException", "status": 500, "detail": "An unexpected error occurred", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProductPlayerOptInStatusDto" }, "example": { "isOptedIn": true } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProductPlayerOptInStatusDto" }, "example": { "isOptedIn": true } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProductPlayerOptInStatusDto" }, "example": { "isOptedIn": true } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "UnauthorizedException", "title": "Unauthorised", "status": 401, "detail": "This request is not authorized", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "UnauthorizedException", "title": "Unauthorised", "status": 401, "detail": "This request is not authorized", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "UnauthorizedException", "title": "Unauthorised", "status": 401, "detail": "This request is not authorized", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "No active flash win found for game: {{gameId}}", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "No active flash win found for game: {{gameId}}", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "No active flash win found for game: {{gameId}}", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } } } }, "patch": { "tags": [ "FlashWinOptInStatus" ], "summary": "Sets the player opt-in status for the given site and flash win using a raw player ID.\nThis call is intended to be called from another server and secured via the site API key.", "parameters": [ { "name": "siteId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "flashWinId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "playerId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewProductPlayerOptInStatusDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NewProductPlayerOptInStatusDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NewProductPlayerOptInStatusDto" } } } }, "responses": { "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "Exception", "title": "GenericException", "status": 500, "detail": "An unexpected error occurred", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "Exception", "title": "GenericException", "status": 500, "detail": "An unexpected error occurred", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "Exception", "title": "GenericException", "status": 500, "detail": "An unexpected error occurred", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProductPlayerOptInStatusDto" }, "example": { "isOptedIn": true } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProductPlayerOptInStatusDto" }, "example": { "isOptedIn": true } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProductPlayerOptInStatusDto" }, "example": { "isOptedIn": true } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "UnauthorizedException", "title": "Unauthorised", "status": 401, "detail": "This request is not authorized", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "UnauthorizedException", "title": "Unauthorised", "status": 401, "detail": "This request is not authorized", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "UnauthorizedException", "title": "Unauthorised", "status": 401, "detail": "This request is not authorized", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "No active flash win found for game: {{gameId}}", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "No active flash win found for game: {{gameId}}", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "No active flash win found for game: {{gameId}}", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } } } } }, "/v2/sites/{siteId}/flashwins/{flashWinId}/players/{playerId}/brand/{brandId}/optinstatus": { "get": { "tags": [ "FlashWinOptInStatus" ], "summary": "Gets the player opt-in status for the given site, flash win, and brand using a raw player ID.\nThis call is intended to be called from another server and secured via the site API key.", "parameters": [ { "name": "siteId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "flashWinId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "playerId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "brandId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "Exception", "title": "GenericException", "status": 500, "detail": "An unexpected error occurred", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "Exception", "title": "GenericException", "status": 500, "detail": "An unexpected error occurred", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "Exception", "title": "GenericException", "status": 500, "detail": "An unexpected error occurred", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProductPlayerOptInStatusDto" }, "example": { "isOptedIn": true } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProductPlayerOptInStatusDto" }, "example": { "isOptedIn": true } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProductPlayerOptInStatusDto" }, "example": { "isOptedIn": true } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "UnauthorizedException", "title": "Unauthorised", "status": 401, "detail": "This request is not authorized", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "UnauthorizedException", "title": "Unauthorised", "status": 401, "detail": "This request is not authorized", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "UnauthorizedException", "title": "Unauthorised", "status": 401, "detail": "This request is not authorized", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "No active flash win found for game: {{gameId}}", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "No active flash win found for game: {{gameId}}", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "No active flash win found for game: {{gameId}}", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } } } }, "patch": { "tags": [ "FlashWinOptInStatus" ], "summary": "Sets the player opt-in status for the given site, flash win, and brand using a raw player ID.\nThis call is intended to be called from another server and secured via the site API key.", "parameters": [ { "name": "siteId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "flashWinId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "playerId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "brandId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewProductPlayerOptInStatusDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NewProductPlayerOptInStatusDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NewProductPlayerOptInStatusDto" } } } }, "responses": { "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "Exception", "title": "GenericException", "status": 500, "detail": "An unexpected error occurred", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "Exception", "title": "GenericException", "status": 500, "detail": "An unexpected error occurred", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "Exception", "title": "GenericException", "status": 500, "detail": "An unexpected error occurred", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProductPlayerOptInStatusDto" }, "example": { "isOptedIn": true } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProductPlayerOptInStatusDto" }, "example": { "isOptedIn": true } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProductPlayerOptInStatusDto" }, "example": { "isOptedIn": true } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "UnauthorizedException", "title": "Unauthorised", "status": 401, "detail": "This request is not authorized", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "UnauthorizedException", "title": "Unauthorised", "status": 401, "detail": "This request is not authorized", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "UnauthorizedException", "title": "Unauthorised", "status": 401, "detail": "This request is not authorized", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "No active flash win found for game: {{gameId}}", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "No active flash win found for game: {{gameId}}", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "No active flash win found for game: {{gameId}}", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } } } } }, "/v2/sites/{siteId}/games/{gameId}": { "get": { "tags": [ "Game" ], "summary": "Get the current or upcoming jackpot and flash win for the supplied site and game id", "parameters": [ { "name": "siteId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "gameId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "503": { "description": "Service Unavailable", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GameDtoV2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GameDtoV2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GameDtoV2" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } } } } }, "/v2/sites/{siteId}/games/{gameId}/brand/{brandId}": { "get": { "tags": [ "Game" ], "summary": "Get the current or upcoming jackpot and flash win for the supplied site, game id, and brand id", "parameters": [ { "name": "siteId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "gameId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "brandId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "503": { "description": "Service Unavailable", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GameDtoV2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GameDtoV2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GameDtoV2" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } } } } }, "/v2/sites/{siteId}/games/{gameId}/players/sessions/{sessionId}": { "get": { "tags": [ "Game" ], "summary": "Get the current or upcoming jackpot and flash win for the supplied site and game id, evaluated for a specific player session", "parameters": [ { "name": "siteId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "gameId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "sessionId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "503": { "description": "Service Unavailable", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GameDtoV2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GameDtoV2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GameDtoV2" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } } } } }, "/v2/sites/{siteId}/games/{gameId}/brand/{brandId}/players/sessions/{sessionId}": { "get": { "tags": [ "Game" ], "summary": "Get the current or upcoming jackpot and flash win for the supplied site, game id, and brand id, evaluated for a specific player session", "parameters": [ { "name": "siteId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "gameId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "brandId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "sessionId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "503": { "description": "Service Unavailable", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GameDtoV2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GameDtoV2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GameDtoV2" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } } } } }, "/v2/sites/{siteId}/jackpots/{jackpotGroupId}/appearance": { "get": { "tags": [ "JackpotAppearance" ], "summary": "Get the jackpot v2 appearance details for the supplied site and jackpot group id", "parameters": [ { "name": "siteId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "jackpotGroupId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "locale", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/JackpotGameAppearanceDtoV2" } }, "application/json": { "schema": { "$ref": "#/components/schemas/JackpotGameAppearanceDtoV2" } }, "text/json": { "schema": { "$ref": "#/components/schemas/JackpotGameAppearanceDtoV2" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } } } } }, "/v2/sites/{siteId}/jackpots/{jackpotGroupId}/style.css": { "get": { "tags": [ "JackpotAppearance" ], "summary": "Gets the css file for the given site and jackpot group id (v2 widget)", "parameters": [ { "name": "siteId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "jackpotGroupId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "locale", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "device", "in": "query", "description": "", "schema": { "$ref": "#/components/schemas/Device" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "text/css": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "200": { "description": "OK", "content": { "text/css": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Bad Request", "content": { "text/css": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "404": { "description": "Not Found", "content": { "text/css": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } } } } }, "/v2/sites/{siteId}/jackpots/games/{gameId}": { "get": { "tags": [ "JackpotGame" ], "summary": "Get the current or upcoming jackpot for the supplied site and game id", "parameters": [ { "name": "siteId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "gameId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "503": { "description": "Service Unavailable", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/JackpotGameDtoV2" }, "example": { "organisationId": "{{siteId}}", "workspaceId": "{{flowsWorkspaceId}}", "jackpotGroupId": "{{jackpotGroupId}}", "kind": "OneLevel", "widget": "Standard", "requiresOptIn": true, "startTime": 1784005848955, "endTime": 1786597848955, "jackpotValues": [ { "dropType": "Value drop", "maxThresholdAmount": 1000, "jackpotId": "{{jackpotId}}", "level": 1, "amount": 100.23, "currency": "{{currency}}", "status": "{{status}}", "open": true, "startTime": 1784005848955 } ], "recentWinners": [ { "jackpotOrder": 1, "winnerName": "{{winnerName}}", "amountWon": 100.99, "jackpotWon": "{{jackpotWon}}" } ] } }, "application/json": { "schema": { "$ref": "#/components/schemas/JackpotGameDtoV2" }, "example": { "organisationId": "{{siteId}}", "workspaceId": "{{flowsWorkspaceId}}", "jackpotGroupId": "{{jackpotGroupId}}", "kind": "OneLevel", "widget": "Standard", "requiresOptIn": true, "startTime": 1784005848955, "endTime": 1786597848955, "jackpotValues": [ { "dropType": "Value drop", "maxThresholdAmount": 1000, "jackpotId": "{{jackpotId}}", "level": 1, "amount": 100.23, "currency": "{{currency}}", "status": "{{status}}", "open": true, "startTime": 1784005848955 } ], "recentWinners": [ { "jackpotOrder": 1, "winnerName": "{{winnerName}}", "amountWon": 100.99, "jackpotWon": "{{jackpotWon}}" } ] } }, "text/json": { "schema": { "$ref": "#/components/schemas/JackpotGameDtoV2" }, "example": { "organisationId": "{{siteId}}", "workspaceId": "{{flowsWorkspaceId}}", "jackpotGroupId": "{{jackpotGroupId}}", "kind": "OneLevel", "widget": "Standard", "requiresOptIn": true, "startTime": 1784005848955, "endTime": 1786597848955, "jackpotValues": [ { "dropType": "Value drop", "maxThresholdAmount": 1000, "jackpotId": "{{jackpotId}}", "level": 1, "amount": 100.23, "currency": "{{currency}}", "status": "{{status}}", "open": true, "startTime": 1784005848955 } ], "recentWinners": [ { "jackpotOrder": 1, "winnerName": "{{winnerName}}", "amountWon": 100.99, "jackpotWon": "{{jackpotWon}}" } ] } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "No current jackpot for game: {{gameId}}", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "No current jackpot for game: {{gameId}}", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "No current jackpot for game: {{gameId}}", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } } } } }, "/v2/sites/{siteId}/jackpots/games/{gameId}/brand/{brandId}": { "get": { "tags": [ "JackpotGame" ], "summary": "Get the current or upcoming jackpot for the supplied site, game id, and brand id", "parameters": [ { "name": "siteId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "gameId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "brandId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "503": { "description": "Service Unavailable", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/JackpotGameDtoV2" }, "example": { "organisationId": "{{siteId}}", "workspaceId": "{{flowsWorkspaceId}}", "jackpotGroupId": "{{jackpotGroupId}}", "kind": "OneLevel", "widget": "Standard", "requiresOptIn": true, "startTime": 1784005848959, "endTime": 1786597848959, "jackpotValues": [ { "dropType": "Value drop", "maxThresholdAmount": 1000, "jackpotId": "{{jackpotId}}", "level": 1, "amount": 100.23, "currency": "{{currency}}", "status": "{{status}}", "open": true, "startTime": 1784005848959 } ], "recentWinners": [ { "jackpotOrder": 1, "winnerName": "{{winnerName}}", "amountWon": 100.99, "jackpotWon": "{{jackpotWon}}" } ] } }, "application/json": { "schema": { "$ref": "#/components/schemas/JackpotGameDtoV2" }, "example": { "organisationId": "{{siteId}}", "workspaceId": "{{flowsWorkspaceId}}", "jackpotGroupId": "{{jackpotGroupId}}", "kind": "OneLevel", "widget": "Standard", "requiresOptIn": true, "startTime": 1784005848959, "endTime": 1786597848959, "jackpotValues": [ { "dropType": "Value drop", "maxThresholdAmount": 1000, "jackpotId": "{{jackpotId}}", "level": 1, "amount": 100.23, "currency": "{{currency}}", "status": "{{status}}", "open": true, "startTime": 1784005848959 } ], "recentWinners": [ { "jackpotOrder": 1, "winnerName": "{{winnerName}}", "amountWon": 100.99, "jackpotWon": "{{jackpotWon}}" } ] } }, "text/json": { "schema": { "$ref": "#/components/schemas/JackpotGameDtoV2" }, "example": { "organisationId": "{{siteId}}", "workspaceId": "{{flowsWorkspaceId}}", "jackpotGroupId": "{{jackpotGroupId}}", "kind": "OneLevel", "widget": "Standard", "requiresOptIn": true, "startTime": 1784005848959, "endTime": 1786597848959, "jackpotValues": [ { "dropType": "Value drop", "maxThresholdAmount": 1000, "jackpotId": "{{jackpotId}}", "level": 1, "amount": 100.23, "currency": "{{currency}}", "status": "{{status}}", "open": true, "startTime": 1784005848959 } ], "recentWinners": [ { "jackpotOrder": 1, "winnerName": "{{winnerName}}", "amountWon": 100.99, "jackpotWon": "{{jackpotWon}}" } ] } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "No current jackpot for game: {{gameId}}", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "No current jackpot for game: {{gameId}}", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "No current jackpot for game: {{gameId}}", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } } } } }, "/v2/sites/{siteId}/jackpots/games/{gameId}/players/sessions/{sessionId}": { "get": { "tags": [ "JackpotGame" ], "summary": "Get the current or upcoming jackpot for the supplied site and game id, evaluated for a specific player session", "parameters": [ { "name": "siteId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "gameId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "sessionId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "503": { "description": "Service Unavailable", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/JackpotGameDtoV2" }, "example": { "organisationId": "{{siteId}}", "workspaceId": "{{flowsWorkspaceId}}", "jackpotGroupId": "{{jackpotGroupId}}", "kind": "OneLevel", "widget": "Standard", "requiresOptIn": true, "startTime": 1784005848963, "endTime": 1786597848963, "jackpotValues": [ { "dropType": "Value drop", "maxThresholdAmount": 1000, "jackpotId": "{{jackpotId}}", "level": 1, "amount": 100.23, "currency": "{{currency}}", "status": "{{status}}", "open": true, "startTime": 1784005848963 } ], "recentWinners": [ { "jackpotOrder": 1, "winnerName": "{{winnerName}}", "amountWon": 100.99, "jackpotWon": "{{jackpotWon}}" } ] } }, "application/json": { "schema": { "$ref": "#/components/schemas/JackpotGameDtoV2" }, "example": { "organisationId": "{{siteId}}", "workspaceId": "{{flowsWorkspaceId}}", "jackpotGroupId": "{{jackpotGroupId}}", "kind": "OneLevel", "widget": "Standard", "requiresOptIn": true, "startTime": 1784005848963, "endTime": 1786597848963, "jackpotValues": [ { "dropType": "Value drop", "maxThresholdAmount": 1000, "jackpotId": "{{jackpotId}}", "level": 1, "amount": 100.23, "currency": "{{currency}}", "status": "{{status}}", "open": true, "startTime": 1784005848963 } ], "recentWinners": [ { "jackpotOrder": 1, "winnerName": "{{winnerName}}", "amountWon": 100.99, "jackpotWon": "{{jackpotWon}}" } ] } }, "text/json": { "schema": { "$ref": "#/components/schemas/JackpotGameDtoV2" }, "example": { "organisationId": "{{siteId}}", "workspaceId": "{{flowsWorkspaceId}}", "jackpotGroupId": "{{jackpotGroupId}}", "kind": "OneLevel", "widget": "Standard", "requiresOptIn": true, "startTime": 1784005848963, "endTime": 1786597848963, "jackpotValues": [ { "dropType": "Value drop", "maxThresholdAmount": 1000, "jackpotId": "{{jackpotId}}", "level": 1, "amount": 100.23, "currency": "{{currency}}", "status": "{{status}}", "open": true, "startTime": 1784005848963 } ], "recentWinners": [ { "jackpotOrder": 1, "winnerName": "{{winnerName}}", "amountWon": 100.99, "jackpotWon": "{{jackpotWon}}" } ] } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "No current jackpot for game: {{gameId}}", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "No current jackpot for game: {{gameId}}", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "No current jackpot for game: {{gameId}}", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } } } } }, "/v2/sites/{siteId}/jackpots/games/{gameId}/brand/{brandId}/players/sessions/{sessionId}": { "get": { "tags": [ "JackpotGame" ], "summary": "Get the current or upcoming jackpot for the supplied site, game id, and brand id, evaluated for a specific player session", "parameters": [ { "name": "siteId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "gameId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "brandId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "sessionId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "503": { "description": "Service Unavailable", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/JackpotGameDtoV2" }, "example": { "organisationId": "{{siteId}}", "workspaceId": "{{flowsWorkspaceId}}", "jackpotGroupId": "{{jackpotGroupId}}", "kind": "OneLevel", "widget": "Standard", "requiresOptIn": true, "startTime": 1784005848969, "endTime": 1786597848969, "jackpotValues": [ { "dropType": "Value drop", "maxThresholdAmount": 1000, "jackpotId": "{{jackpotId}}", "level": 1, "amount": 100.23, "currency": "{{currency}}", "status": "{{status}}", "open": true, "startTime": 1784005848969 } ], "recentWinners": [ { "jackpotOrder": 1, "winnerName": "{{winnerName}}", "amountWon": 100.99, "jackpotWon": "{{jackpotWon}}" } ] } }, "application/json": { "schema": { "$ref": "#/components/schemas/JackpotGameDtoV2" }, "example": { "organisationId": "{{siteId}}", "workspaceId": "{{flowsWorkspaceId}}", "jackpotGroupId": "{{jackpotGroupId}}", "kind": "OneLevel", "widget": "Standard", "requiresOptIn": true, "startTime": 1784005848969, "endTime": 1786597848969, "jackpotValues": [ { "dropType": "Value drop", "maxThresholdAmount": 1000, "jackpotId": "{{jackpotId}}", "level": 1, "amount": 100.23, "currency": "{{currency}}", "status": "{{status}}", "open": true, "startTime": 1784005848969 } ], "recentWinners": [ { "jackpotOrder": 1, "winnerName": "{{winnerName}}", "amountWon": 100.99, "jackpotWon": "{{jackpotWon}}" } ] } }, "text/json": { "schema": { "$ref": "#/components/schemas/JackpotGameDtoV2" }, "example": { "organisationId": "{{siteId}}", "workspaceId": "{{flowsWorkspaceId}}", "jackpotGroupId": "{{jackpotGroupId}}", "kind": "OneLevel", "widget": "Standard", "requiresOptIn": true, "startTime": 1784005848969, "endTime": 1786597848969, "jackpotValues": [ { "dropType": "Value drop", "maxThresholdAmount": 1000, "jackpotId": "{{jackpotId}}", "level": 1, "amount": 100.23, "currency": "{{currency}}", "status": "{{status}}", "open": true, "startTime": 1784005848969 } ], "recentWinners": [ { "jackpotOrder": 1, "winnerName": "{{winnerName}}", "amountWon": 100.99, "jackpotWon": "{{jackpotWon}}" } ] } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "No current jackpot for game: {{gameId}}", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "No current jackpot for game: {{gameId}}", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "No current jackpot for game: {{gameId}}", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } } } } }, "/v2/sites/{siteId}/jackpots/{jackpotGroupId}/players/sessions/{sessionId}/optinstatus": { "get": { "tags": [ "JackpotOptInStatusV" ], "summary": "Gets the player opt-in status mapped from the session id for the given site and jackpot. This call is intended to be called from the front end and does not require the site API key.", "parameters": [ { "name": "siteId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "jackpotGroupId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "Exception", "title": "GenericException", "status": 500, "detail": "An unexpected error occurred", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "Exception", "title": "GenericException", "status": 500, "detail": "An unexpected error occurred", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "Exception", "title": "GenericException", "status": 500, "detail": "An unexpected error occurred", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProductPlayerOptInStatusDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProductPlayerOptInStatusDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProductPlayerOptInStatusDto" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Jackpot does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Jackpot does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Jackpot does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "Organisation not found", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "Organisation not found", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "Organisation not found", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } } } }, "patch": { "tags": [ "JackpotOptInStatusV" ], "summary": "Sets the player opt-in status mapped from the session id for the given site and jackpot. This call is intended to be called from the front end and does not require the site API key.", "parameters": [ { "name": "siteId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "jackpotGroupId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewProductPlayerOptInStatusDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NewProductPlayerOptInStatusDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NewProductPlayerOptInStatusDto" } } } }, "responses": { "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "Exception", "title": "GenericException", "status": 500, "detail": "An unexpected error occurred", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "Exception", "title": "GenericException", "status": 500, "detail": "An unexpected error occurred", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "Exception", "title": "GenericException", "status": 500, "detail": "An unexpected error occurred", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProductPlayerOptInStatusDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProductPlayerOptInStatusDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProductPlayerOptInStatusDto" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Jackpot does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Jackpot does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Jackpot does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "Organisation not found", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "Organisation not found", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "Organisation not found", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "503": { "description": "Service Unavailable", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } } } } }, "/v2/sites/{siteId}/jackpots/{jackpotGroupId}/players/sessions/{sessionId}/brand/{brandId}/optinstatus": { "get": { "tags": [ "JackpotOptInStatusV" ], "summary": "Gets the player opt-in status mapped from the session id for the given site, jackpot and brand. This call is intended to be called from the front end and does not require the site API key.", "parameters": [ { "name": "siteId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "jackpotGroupId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "brandId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "Exception", "title": "GenericException", "status": 500, "detail": "An unexpected error occurred", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "Exception", "title": "GenericException", "status": 500, "detail": "An unexpected error occurred", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "Exception", "title": "GenericException", "status": 500, "detail": "An unexpected error occurred", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProductPlayerOptInStatusDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProductPlayerOptInStatusDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProductPlayerOptInStatusDto" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Jackpot does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Jackpot does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Jackpot does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "Organisation not found", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "Organisation not found", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "Organisation not found", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } } } }, "patch": { "tags": [ "JackpotOptInStatusV" ], "summary": "Sets the player opt-in status mapped from the session id for the given site, jackpot and brand. This call is intended to be called from the front end and does not require the site API key.", "parameters": [ { "name": "siteId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "jackpotGroupId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "brandId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewProductPlayerOptInStatusDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NewProductPlayerOptInStatusDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NewProductPlayerOptInStatusDto" } } } }, "responses": { "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "Exception", "title": "GenericException", "status": 500, "detail": "An unexpected error occurred", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "Exception", "title": "GenericException", "status": 500, "detail": "An unexpected error occurred", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "Exception", "title": "GenericException", "status": 500, "detail": "An unexpected error occurred", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProductPlayerOptInStatusDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProductPlayerOptInStatusDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProductPlayerOptInStatusDto" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Jackpot does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Jackpot does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Jackpot does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "Organisation not found", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "Organisation not found", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "Organisation not found", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "503": { "description": "Service Unavailable", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } } } } }, "/v2/sites/{siteId}/jackpots/{jackpotGroupId}/players/{playerId}/optinstatus": { "get": { "tags": [ "JackpotOptInStatusV" ], "summary": "Gets the player opt-in status for the given site and jackpot group. This call is meant to be called from another server and secured via the site api key which is required.", "parameters": [ { "name": "siteId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "jackpotGroupId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "playerId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "Exception", "title": "GenericException", "status": 500, "detail": "An unexpected error occurred", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "Exception", "title": "GenericException", "status": 500, "detail": "An unexpected error occurred", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "Exception", "title": "GenericException", "status": 500, "detail": "An unexpected error occurred", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProductPlayerOptInStatusDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProductPlayerOptInStatusDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProductPlayerOptInStatusDto" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Jackpot does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Jackpot does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Jackpot does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "UnauthorizedException", "title": "Unauthorised", "status": 401, "detail": "This request is not authorized", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "UnauthorizedException", "title": "Unauthorised", "status": 401, "detail": "This request is not authorized", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "UnauthorizedException", "title": "Unauthorised", "status": 401, "detail": "This request is not authorized", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "Organisation not found", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "Organisation not found", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "Organisation not found", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } } } }, "patch": { "tags": [ "JackpotOptInStatusV" ], "summary": "Sets the player opt-in status for the given site and jackpot group. This call is meant to be called from another server and secured via the site api key which is required.", "parameters": [ { "name": "siteId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "jackpotGroupId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "playerId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewProductPlayerOptInStatusDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NewProductPlayerOptInStatusDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NewProductPlayerOptInStatusDto" } } } }, "responses": { "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "Exception", "title": "GenericException", "status": 500, "detail": "An unexpected error occurred", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "Exception", "title": "GenericException", "status": 500, "detail": "An unexpected error occurred", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "Exception", "title": "GenericException", "status": 500, "detail": "An unexpected error occurred", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProductPlayerOptInStatusDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProductPlayerOptInStatusDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProductPlayerOptInStatusDto" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Jackpot does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Jackpot does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Jackpot does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "UnauthorizedException", "title": "Unauthorised", "status": 401, "detail": "This request is not authorized", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "UnauthorizedException", "title": "Unauthorised", "status": 401, "detail": "This request is not authorized", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "UnauthorizedException", "title": "Unauthorised", "status": 401, "detail": "This request is not authorized", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "Organisation not found", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "Organisation not found", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "Organisation not found", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "503": { "description": "Service Unavailable", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } } } } }, "/v2/sites/{siteId}/jackpots/{jackpotGroupId}/players/{playerId}/brand/{brandId}/optinstatus": { "get": { "tags": [ "JackpotOptInStatusV" ], "summary": "Gets the player opt-in status for the given site, jackpot group and brand. This call is meant to be called from another server and secured via the site api key which is required.", "parameters": [ { "name": "siteId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "jackpotGroupId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "playerId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "brandId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "Exception", "title": "GenericException", "status": 500, "detail": "An unexpected error occurred", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "Exception", "title": "GenericException", "status": 500, "detail": "An unexpected error occurred", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "Exception", "title": "GenericException", "status": 500, "detail": "An unexpected error occurred", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProductPlayerOptInStatusDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProductPlayerOptInStatusDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProductPlayerOptInStatusDto" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Jackpot does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Jackpot does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Jackpot does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "UnauthorizedException", "title": "Unauthorised", "status": 401, "detail": "This request is not authorized", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "UnauthorizedException", "title": "Unauthorised", "status": 401, "detail": "This request is not authorized", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "UnauthorizedException", "title": "Unauthorised", "status": 401, "detail": "This request is not authorized", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "Organisation not found", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "Organisation not found", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "Organisation not found", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } } } }, "patch": { "tags": [ "JackpotOptInStatusV" ], "summary": "Sets the player opt-in status for the given site, jackpot group and brand. This call is meant to be called from another server and secured via the site api key which is required.", "parameters": [ { "name": "siteId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "jackpotGroupId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "playerId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "brandId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewProductPlayerOptInStatusDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NewProductPlayerOptInStatusDto" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/NewProductPlayerOptInStatusDto" } } } }, "responses": { "500": { "description": "Internal Server Error", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "Exception", "title": "GenericException", "status": 500, "detail": "An unexpected error occurred", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "Exception", "title": "GenericException", "status": 500, "detail": "An unexpected error occurred", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "Exception", "title": "GenericException", "status": 500, "detail": "An unexpected error occurred", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ProductPlayerOptInStatusDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProductPlayerOptInStatusDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProductPlayerOptInStatusDto" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Jackpot does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Jackpot does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Jackpot does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "UnauthorizedException", "title": "Unauthorised", "status": 401, "detail": "This request is not authorized", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "UnauthorizedException", "title": "Unauthorised", "status": 401, "detail": "This request is not authorized", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "UnauthorizedException", "title": "Unauthorised", "status": 401, "detail": "This request is not authorized", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "Organisation not found", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "Organisation not found", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "NotFoundException", "title": "NotFound", "status": 404, "detail": "Organisation not found", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } }, "503": { "description": "Service Unavailable", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomProblemDetails" }, "example": { "type": "ValidationException", "title": "Validation", "status": 400, "detail": "Flash win does not require opting in", "instance": "{{Request.Method}} {{Request.Path}}", "property": null, "messages": null } } } } } } } }, "components": { "schemas": { "CustomProblemDetails": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true }, "property": { "type": "string", "nullable": true }, "messages": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": { } }, "Device": { "enum": [ "Desktop", "Mobile" ], "type": "string" }, "FlashWinGameAppearanceDto": { "required": [ "desktopStyleSheet", "desktopTextAssets", "desktopVariant", "flashWinId", "mobileStyleSheet", "mobileTextAssets", "mobileVariant", "widget" ], "type": "object", "properties": { "flashWinId": { "type": "string", "nullable": true }, "widget": { "$ref": "#/components/schemas/WidgetType" }, "optInRequired": { "type": "boolean", "nullable": true }, "desktopVariant": { "$ref": "#/components/schemas/WidgetVariantKind" }, "desktopVariantPosition": { "$ref": "#/components/schemas/WidgetPosition" }, "desktopTextAssets": { "type": "array", "items": { "$ref": "#/components/schemas/TextAssetValueDto" }, "nullable": true }, "desktopStyleSheet": { "type": "string", "nullable": true }, "mobileVariant": { "$ref": "#/components/schemas/WidgetVariantKind" }, "mobileVariantPosition": { "$ref": "#/components/schemas/WidgetPosition" }, "mobileTextAssets": { "type": "array", "items": { "$ref": "#/components/schemas/TextAssetValueDto" }, "nullable": true }, "mobileStyleSheet": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FlashWinsGamePrizeDto": { "required": [ "amount", "quantity", "remaining", "type", "unqid" ], "type": "object", "properties": { "unqid": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "amount": { "type": "number", "format": "double" }, "quantity": { "type": "integer", "format": "int32" }, "remaining": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "FlashWinsGameResponseDto": { "required": [ "flashWinId", "organisationId", "prizes", "requiresOptIn", "workspaceId" ], "type": "object", "properties": { "organisationId": { "type": "string", "nullable": true }, "workspaceId": { "type": "string", "nullable": true }, "flashWinId": { "type": "string", "nullable": true }, "requiresOptIn": { "type": "boolean" }, "open": { "type": "boolean", "nullable": true }, "startTime": { "type": "integer", "format": "int64", "nullable": true }, "endTime": { "type": "integer", "format": "int64", "nullable": true }, "currency": { "type": "string", "nullable": true }, "prizeDistributionType": { "$ref": "#/components/schemas/PrizeDistributionType" }, "instanceId": { "type": "integer", "format": "int32", "nullable": true }, "status": { "type": "string", "nullable": true }, "remainingPrizes": { "type": "integer", "format": "int32", "nullable": true }, "prizes": { "type": "array", "items": { "$ref": "#/components/schemas/FlashWinsGamePrizeDto" }, "nullable": true } }, "additionalProperties": false }, "GameDtoV2": { "type": "object", "properties": { "jackpot": { "$ref": "#/components/schemas/JackpotGameDtoV2" }, "flashwin": { "$ref": "#/components/schemas/FlashWinsGameResponseDto" } }, "additionalProperties": false }, "JackpotGameAppearanceDtoV2": { "required": [ "desktopStyleSheet", "desktopTextAssets", "desktopVariant", "jackpotGroupId", "kind", "mobileStyleSheet", "mobileTextAssets", "mobileVariant", "widget" ], "type": "object", "properties": { "jackpotGroupId": { "type": "string", "nullable": true }, "kind": { "$ref": "#/components/schemas/JackpotKind" }, "widget": { "$ref": "#/components/schemas/WidgetType" }, "desktopVariant": { "$ref": "#/components/schemas/WidgetVariantKind" }, "desktopVariantPosition": { "$ref": "#/components/schemas/WidgetPosition" }, "desktopTextAssets": { "type": "array", "items": { "$ref": "#/components/schemas/TextAssetValueDto" }, "nullable": true }, "desktopStyleSheet": { "type": "string", "nullable": true }, "mobileVariant": { "$ref": "#/components/schemas/WidgetVariantKind" }, "mobileVariantPosition": { "$ref": "#/components/schemas/WidgetPosition" }, "mobileTextAssets": { "type": "array", "items": { "$ref": "#/components/schemas/TextAssetValueDto" }, "nullable": true }, "mobileStyleSheet": { "type": "string", "nullable": true } }, "additionalProperties": false }, "JackpotGameDtoV2": { "required": [ "endTime", "jackpotGroupId", "kind", "organisationId", "requiresOptIn", "startTime", "widget", "workspaceId" ], "type": "object", "properties": { "organisationId": { "type": "string", "nullable": true }, "workspaceId": { "type": "string", "nullable": true }, "jackpotGroupId": { "type": "string", "nullable": true }, "kind": { "$ref": "#/components/schemas/JackpotKind" }, "widget": { "$ref": "#/components/schemas/WidgetType" }, "requiresOptIn": { "type": "boolean" }, "startTime": { "type": "integer", "format": "int64" }, "endTime": { "type": "integer", "format": "int64" }, "jackpotValues": { "type": "array", "items": { "$ref": "#/components/schemas/JackpotResultValueDtoV2" }, "nullable": true }, "recentWinners": { "type": "array", "items": { "$ref": "#/components/schemas/JackpotRecentWinnersDto" }, "nullable": true } }, "additionalProperties": false }, "JackpotKind": { "enum": [ "OneLevel", "TwoLevels", "ThreeLevels", "FourLevels", "FiveLevels" ], "type": "string" }, "JackpotRecentWinnersDto": { "required": [ "amountWon", "jackpotOrder", "jackpotWon", "winnerName" ], "type": "object", "properties": { "jackpotOrder": { "type": "integer", "format": "int32" }, "winnerName": { "type": "string", "nullable": true }, "amountWon": { "type": "number", "format": "double" }, "jackpotWon": { "type": "string", "nullable": true } }, "additionalProperties": false }, "JackpotResultValueDtoV2": { "required": [ "amount", "currency", "jackpotId", "level", "open", "startTime", "status" ], "type": "object", "properties": { "jackpotId": { "type": "string", "nullable": true }, "level": { "type": "integer", "format": "int32", "nullable": true }, "amount": { "type": "number", "format": "double", "nullable": true }, "currency": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "open": { "type": "boolean", "nullable": true }, "startTime": { "type": "integer", "format": "int64", "nullable": true }, "dropType": { "type": "string", "nullable": true }, "maxThresholdAmount": { "type": "number", "format": "double", "nullable": true }, "dropEndTime": { "type": "string", "nullable": true } }, "additionalProperties": false }, "NewProductPlayerOptInStatusDto": { "required": [ "isOptedIn" ], "type": "object", "properties": { "isOptedIn": { "type": "boolean" } }, "additionalProperties": false }, "PrizeDistributionType": { "enum": [ "Total", "Daily" ], "type": "string" }, "ProductPlayerOptInStatusDto": { "required": [ "isOptedIn" ], "type": "object", "properties": { "isOptedIn": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "TextAssetValueDto": { "required": [ "name", "value" ], "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true }, "src": { "$ref": "#/components/schemas/ValueSrcDto" } }, "additionalProperties": false }, "ValueSrcDto": { "required": [ "device", "isCustomValue", "locale" ], "type": "object", "properties": { "locale": { "type": "string", "nullable": true }, "device": { "$ref": "#/components/schemas/Device" }, "isCustomValue": { "type": "boolean" } }, "additionalProperties": false }, "WidgetPosition": { "enum": [ "Top", "Bottom", "TopLeft", "TopRight", "BottomLeft", "BottomRight" ], "type": "string" }, "WidgetType": { "enum": [ "Custom", "Standard", "StandardV2" ], "type": "string" }, "WidgetVariantKind": { "enum": [ "None", "Small", "Medium", "Large", "StickyTop", "StickyLeft", "Floating", "Toolbar" ], "type": "string" } }, "securitySchemes": { "SiteUserApiKeyScheme": { "type": "apiKey", "description": "Site API key header", "name": "x-api-key", "in": "header" } } }, "security": [ { "SiteUserApiKeyScheme": [ ] } ], "tags": [ { "name": "FlashWinAppearance" }, { "name": "FlashWinGame" }, { "name": "FlashWinOptInStatus" }, { "name": "Game" }, { "name": "JackpotAppearance" }, { "name": "JackpotGame" }, { "name": "JackpotOptInStatusV" } ] }