GET v1/games/{id}/payouts

Returns an array of all Payout Options for the given Game

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Unique Identifier of the Game that the payouts belong to.

 string

Required

Body Parameters

None.

Response Information

Resource Description

an enumerable list of payout options, if the game exists. Otherwise a 404 error.

Collection of PayoutOption
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.
LegendLabel

string

None.
OutcomeOverrideMessage

string

None.
ImageUrl

string

None.
HighlightedImageUrl

string

None.
AwardValue

integer

None.
MustAwardBy

integer

None.
DoNotAwardUntil

integer

None.
Distribution

integer

None.
IsDefault

boolean

None.
Hidden

boolean

None.
Sort

integer

None.
Plays

integer

None.
Previews

integer

None.

Response Codes

  • 200 OK: All Payout Options returned successfully
  • 401 Unauthorized:
  • 500 InternalServerError:

Response Formats

application/json, text/json

Sample: 
[
  {
    "Id": "64456c34-46a3-4996-bb9f-f460d3c7b987",
    "LegendLabel": "sample string 2",
    "OutcomeOverrideMessage": "sample string 3",
    "ImageUrl": "sample string 4",
    "HighlightedImageUrl": "sample string 5",
    "AwardValue": 6,
    "MustAwardBy": 1,
    "DoNotAwardUntil": 1,
    "Distribution": 7,
    "IsDefault": true,
    "Hidden": true,
    "Sort": 10,
    "Plays": 11,
    "Previews": 12
  },
  {
    "Id": "64456c34-46a3-4996-bb9f-f460d3c7b987",
    "LegendLabel": "sample string 2",
    "OutcomeOverrideMessage": "sample string 3",
    "ImageUrl": "sample string 4",
    "HighlightedImageUrl": "sample string 5",
    "AwardValue": 6,
    "MustAwardBy": 1,
    "DoNotAwardUntil": 1,
    "Distribution": 7,
    "IsDefault": true,
    "Hidden": true,
    "Sort": 10,
    "Plays": 11,
    "Previews": 12
  }
]

text/html

Sample: 
[{"Id":"64456c34-46a3-4996-bb9f-f460d3c7b987","LegendLabel":"sample string 2","OutcomeOverrideMessage":"sample string 3","ImageUrl":"sample string 4","HighlightedImageUrl":"sample string 5","AwardValue":6,"MustAwardBy":1,"DoNotAwardUntil":1,"Distribution":7,"IsDefault":true,"Hidden":true,"Sort":10,"Plays":11,"Previews":12},{"Id":"64456c34-46a3-4996-bb9f-f460d3c7b987","LegendLabel":"sample string 2","OutcomeOverrideMessage":"sample string 3","ImageUrl":"sample string 4","HighlightedImageUrl":"sample string 5","AwardValue":6,"MustAwardBy":1,"DoNotAwardUntil":1,"Distribution":7,"IsDefault":true,"Hidden":true,"Sort":10,"Plays":11,"Previews":12}]

application/xml, text/xml

Sample: 
<ArrayOfPayoutOption xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ITAGroup.Games.Api.Contracts.v1.Models">
  <PayoutOption>
    <AwardValue>6</AwardValue>
    <Distribution>7</Distribution>
    <DoNotAwardUntil>1</DoNotAwardUntil>
    <Hidden>true</Hidden>
    <HighlightedImageUrl>sample string 5</HighlightedImageUrl>
    <Id>64456c34-46a3-4996-bb9f-f460d3c7b987</Id>
    <ImageUrl>sample string 4</ImageUrl>
    <IsDefault>true</IsDefault>
    <LegendLabel>sample string 2</LegendLabel>
    <MustAwardBy>1</MustAwardBy>
    <OutcomeOverrideMessage>sample string 3</OutcomeOverrideMessage>
    <Plays>11</Plays>
    <Previews>12</Previews>
    <Sort>10</Sort>
  </PayoutOption>
  <PayoutOption>
    <AwardValue>6</AwardValue>
    <Distribution>7</Distribution>
    <DoNotAwardUntil>1</DoNotAwardUntil>
    <Hidden>true</Hidden>
    <HighlightedImageUrl>sample string 5</HighlightedImageUrl>
    <Id>64456c34-46a3-4996-bb9f-f460d3c7b987</Id>
    <ImageUrl>sample string 4</ImageUrl>
    <IsDefault>true</IsDefault>
    <LegendLabel>sample string 2</LegendLabel>
    <MustAwardBy>1</MustAwardBy>
    <OutcomeOverrideMessage>sample string 3</OutcomeOverrideMessage>
    <Plays>11</Plays>
    <Previews>12</Previews>
    <Sort>10</Sort>
  </PayoutOption>
</ArrayOfPayoutOption>