POST v1/games/{id}/payouts

Creates a Payout Option

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Unique Identifier of the Game that the payouts belong to.

 string

Required

Body Parameters

An object representing the Payout Option.

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.

Request Formats

application/json, text/json

Sample: 
{
  "Id": "9ca6d832-74cf-45b9-a36e-fa932212352c",
  "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":"9ca6d832-74cf-45b9-a36e-fa932212352c","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>9ca6d832-74cf-45b9-a36e-fa932212352c</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>

Response Information

Resource Description

A response containing the new PayoutOption's unique id, or validation errors if the Payout Option could not be created.

PayoutOptionPostResponse
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.

Response Codes

  • 201 Created: Payout Option successfully created.
  • 400 BadRequest: Data validation failed, see the response body for more information.
  • 401 Unauthorized:
  • 500 InternalServerError:

Response Formats

application/json, text/json

Sample: 
{
  "Id": "1772fd8e-2b8e-4fc2-8700-e8dab413f913"
}

text/html

Sample: 
{"Id":"1772fd8e-2b8e-4fc2-8700-e8dab413f913"}

application/xml, text/xml

Sample: 
<PayoutOptionPostResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ITAGroup.Games.Api.Contracts.v1.Responses">
  <Id>1772fd8e-2b8e-4fc2-8700-e8dab413f913</Id>
</PayoutOptionPostResponse>