GET api/Game

Use this method to list all public games available

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

The list of publicly available games

Collection of Game
NameDescriptionTypeAdditional information
GameId

Unique Id of the game

integer

None.

ShowPublic

True if shown publicly

boolean

None.

Code

Secret code to join

string

None.

DateCreated

Datetime created

date

None.

Name

Name to show up in the list

string

None.

NumberOfPlayers

Number of players in the game

integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "gameId": 1,
    "showPublic": true,
    "code": "sample string 3",
    "dateCreated": "2024-10-09T15:37:13.9485935-07:00",
    "name": "sample string 5",
    "numberOfPlayers": 6
  },
  {
    "gameId": 1,
    "showPublic": true,
    "code": "sample string 3",
    "dateCreated": "2024-10-09T15:37:13.9485935-07:00",
    "name": "sample string 5",
    "numberOfPlayers": 6
  }
]

application/xml, text/xml

Sample:
<ArrayOfGame xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TScunts.Models.API.MClone">
  <Game>
    <Code>sample string 3</Code>
    <DateCreated>2024-10-09T15:37:13.9485935-07:00</DateCreated>
    <GameId>1</GameId>
    <Name>sample string 5</Name>
    <NumberOfPlayers>6</NumberOfPlayers>
    <ShowPublic>true</ShowPublic>
  </Game>
  <Game>
    <Code>sample string 3</Code>
    <DateCreated>2024-10-09T15:37:13.9485935-07:00</DateCreated>
    <GameId>1</GameId>
    <Name>sample string 5</Name>
    <NumberOfPlayers>6</NumberOfPlayers>
    <ShowPublic>true</ShowPublic>
  </Game>
</ArrayOfGame>