GET v1/games
Returns an array of all Games
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
Collection of Game| Name | Description | Type | Additional 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: All Games returned successfully
- 401 Unauthorized:
- 500 InternalServerError:
Response Formats
application/json, text/json
Sample:
[
{
"Id": "sample string 1",
"GameTypeId": "e40aa906-4bd0-4f67-82c1-d52cf23f6c44",
"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"
},
{
"Id": "sample string 1",
"GameTypeId": "e40aa906-4bd0-4f67-82c1-d52cf23f6c44",
"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":"e40aa906-4bd0-4f67-82c1-d52cf23f6c44","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"},{"Id":"sample string 1","GameTypeId":"e40aa906-4bd0-4f67-82c1-d52cf23f6c44","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:
<ArrayOfGame xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ITAGroup.Games.Api.Contracts.v1.Models">
<Game>
<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>e40aa906-4bd0-4f67-82c1-d52cf23f6c44</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>
<Game>
<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>e40aa906-4bd0-4f67-82c1-d52cf23f6c44</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>
</ArrayOfGame>