GET v1/games/{id}

Retrieves a Game by their id

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Unique Identifier of the Game requested.

 string

Required

Body Parameters

None.

Response Information

Resource Description

The Game, if it exists. Otherwise a 404 error.

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.

Response Codes

  • 200 OK: Requested Game successfully returned.
  • 401 Unauthorized:
  • 404 NotFound: Requested Game does not exist.
  • 500 InternalServerError:

Response Formats

application/json, text/json

Sample: 
{
  "Id": "sample string 1",
  "GameTypeId": "b7597604-f431-430a-aa34-4da00a415fa4",
  "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":"b7597604-f431-430a-aa34-4da00a415fa4","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>b7597604-f431-430a-aa34-4da00a415fa4</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>