GET v1/games/{id}/payouts/{payoutOptionId}

Retrieves a Payout Option by their id

Request Information

URI Parameters

NameDescriptionTypeAdditional information
payoutOptionId

Unique Identifier of the Payout Option requested.

 globally unique identifier

Required
id

string

None.

Body Parameters

None.

Response Information

Resource Description

The Payout Option, if it exists. Otherwise a 404 error.

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: Requested Payout Option successfully returned.
  • 401 Unauthorized:
  • 404 NotFound: Requested Payout Option does not exist.
  • 500 InternalServerError:

Response Formats

application/json, text/json

Sample: 
{
  "Id": "f4540db3-002a-4db9-9baf-bb798b49d016",
  "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":"f4540db3-002a-4db9-9baf-bb798b49d016","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: 
<PayoutOption xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ITAGroup.Games.Api.Contracts.v1.Models">
  <AwardValue>6</AwardValue>
  <Distribution>7</Distribution>
  <DoNotAwardUntil>1</DoNotAwardUntil>
  <Hidden>true</Hidden>
  <HighlightedImageUrl>sample string 5</HighlightedImageUrl>
  <Id>f4540db3-002a-4db9-9baf-bb798b49d016</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>