PUT v1/games/{id}

Creates a new game or updates an existing game

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Unique Identifier of the game to update or create.

 string

Required

Body Parameters

An object representing the game.

Game
NameDescriptionTypeAdditional information
Id

string

None.
GameTypeId

globally unique identifier

None.
Name

string

None.
BundleName

string

None.
StartMessage

string

None.
CompletionMessage

string

None.
ThemeId

string

None.
WarningPercentage

integer

None.
WarningAddresses

string

None.
IsWarningEmailEnabled

boolean

None.
ClientLogoUrl

string

None.
ProgramLogoUrl

string

None.
StartingGameLogoUrl

string

None.
BackgroundImageUrl

string

None.
CatalogLink

string

None.
CompletionTitle

string

None.

Request Formats

application/json, text/json

Sample: 
{
  "Id": "sample string 1",
  "GameTypeId": "051f1918-4a61-4ad0-ba40-f8d7eba98e6b",
  "Name": "sample string 3",
  "BundleName": "sample string 4",
  "StartMessage": "sample string 5",
  "CompletionMessage": "sample string 6",
  "ThemeId": "sample string 7",
  "WarningPercentage": 8,
  "WarningAddresses": "sample string 9",
  "IsWarningEmailEnabled": true,
  "ClientLogoUrl": "sample string 11",
  "ProgramLogoUrl": "sample string 12",
  "StartingGameLogoUrl": "sample string 13",
  "BackgroundImageUrl": "sample string 14",
  "CatalogLink": "sample string 15",
  "CompletionTitle": "sample string 16"
}

text/html

Sample: 
{"Id":"sample string 1","GameTypeId":"051f1918-4a61-4ad0-ba40-f8d7eba98e6b","Name":"sample string 3","BundleName":"sample string 4","StartMessage":"sample string 5","CompletionMessage":"sample string 6","ThemeId":"sample string 7","WarningPercentage":8,"WarningAddresses":"sample string 9","IsWarningEmailEnabled":true,"ClientLogoUrl":"sample string 11","ProgramLogoUrl":"sample string 12","StartingGameLogoUrl":"sample string 13","BackgroundImageUrl":"sample string 14","CatalogLink":"sample string 15","CompletionTitle":"sample string 16"}

application/xml, text/xml

Sample: 
<Game xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ITAGroup.Games.Api.Contracts.v1.Models">
  <BackgroundImageUrl>sample string 14</BackgroundImageUrl>
  <BundleName>sample string 4</BundleName>
  <CatalogLink>sample string 15</CatalogLink>
  <ClientLogoUrl>sample string 11</ClientLogoUrl>
  <CompletionMessage>sample string 6</CompletionMessage>
  <CompletionTitle>sample string 16</CompletionTitle>
  <GameTypeId>051f1918-4a61-4ad0-ba40-f8d7eba98e6b</GameTypeId>
  <Id>sample string 1</Id>
  <IsWarningEmailEnabled>true</IsWarningEmailEnabled>
  <Name>sample string 3</Name>
  <ProgramLogoUrl>sample string 12</ProgramLogoUrl>
  <StartMessage>sample string 5</StartMessage>
  <StartingGameLogoUrl>sample string 13</StartingGameLogoUrl>
  <ThemeId>sample string 7</ThemeId>
  <WarningAddresses>sample string 9</WarningAddresses>
  <WarningPercentage>8</WarningPercentage>
</Game>

Response Information

Resource Description

A response containing the new Game's unique id, or validation errors if the game could not be created or updated.

GamePostResponse
NameDescriptionTypeAdditional information
Id

string

None.

Response Codes

  • 200 OK: Game successfully saved.
  • 400 BadRequest: Data validation failed, see the response body for more information.
  • 401 Unauthorized:
  • 500 InternalServerError:

Response Formats

application/json, text/json

Sample: 
{
  "Id": "sample string 1"
}

text/html

Sample: 
{"Id":"sample string 1"}

application/xml, text/xml

Sample: 
<GamePostResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ITAGroup.Games.Api.Contracts.v1.Responses">
  <Id>sample string 1</Id>
</GamePostResponse>