GET api/server/GetGameInfo?gameid={gameid}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
gameid

integer

Required

Body Parameters

None.

Response Information

Resource Description

oGameInfo
NameDescriptionTypeAdditional information
Game

oGame

None.

Players

Collection of oGamePlayer

None.

Status

oGameStatus

None.

Response Formats

application/json, text/json

Sample:
{
  "Game": {
    "ServerID": 1,
    "GameID": 2,
    "GameTypeID": 3,
    "ConnectedClients": 4,
    "GameCode": "sample string 5",
    "RefID": 6
  },
  "Players": [
    {
      "PlayerID": 1,
      "GameID": 2,
      "Name": "sample string 3",
      "Avatar": "QEA=",
      "ClientAddress": "sample string 4",
      "ConnectionKey": "sample string 5",
      "PlayerPoints": 6,
      "GameCode": "sample string 7",
      "RefID": 8
    },
    {
      "PlayerID": 1,
      "GameID": 2,
      "Name": "sample string 3",
      "Avatar": "QEA=",
      "ClientAddress": "sample string 4",
      "ConnectionKey": "sample string 5",
      "PlayerPoints": 6,
      "GameCode": "sample string 7",
      "RefID": 8
    }
  ],
  "Status": {
    "GameID": 1,
    "StatusID": 2,
    "GameStatus": "sample string 3",
    "GameStatusType": 6,
    "StartTime": "2026-01-01T21:22:10.8279707-08:00",
    "EndTime": "2026-01-01T21:22:10.8279707-08:00",
    "IsComplete": true,
    "GameCode": "sample string 6",
    "RefID": 7
  }
}

application/xml, text/xml

Sample:
<oGameInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RG.Game">
  <Game>
    <RefID xmlns="http://schemas.datacontract.org/2004/07/RG">6</RefID>
    <GameCode>sample string 5</GameCode>
    <ConnectedClients>4</ConnectedClients>
    <GameID>2</GameID>
    <GameTypeID>3</GameTypeID>
    <ServerID>1</ServerID>
  </Game>
  <Players>
    <oGamePlayer>
      <RefID xmlns="http://schemas.datacontract.org/2004/07/RG">8</RefID>
      <GameCode>sample string 7</GameCode>
      <Avatar>QEA=</Avatar>
      <ClientAddress>sample string 4</ClientAddress>
      <ConnectionKey>sample string 5</ConnectionKey>
      <GameID>2</GameID>
      <Name>sample string 3</Name>
      <PlayerID>1</PlayerID>
      <PlayerPoints>6</PlayerPoints>
    </oGamePlayer>
    <oGamePlayer>
      <RefID xmlns="http://schemas.datacontract.org/2004/07/RG">8</RefID>
      <GameCode>sample string 7</GameCode>
      <Avatar>QEA=</Avatar>
      <ClientAddress>sample string 4</ClientAddress>
      <ConnectionKey>sample string 5</ConnectionKey>
      <GameID>2</GameID>
      <Name>sample string 3</Name>
      <PlayerID>1</PlayerID>
      <PlayerPoints>6</PlayerPoints>
    </oGamePlayer>
  </Players>
  <Status>
    <RefID xmlns="http://schemas.datacontract.org/2004/07/RG">7</RefID>
    <GameCode>sample string 6</GameCode>
    <EndTime>2026-01-01T21:22:10.8279707-08:00</EndTime>
    <GameID>1</GameID>
    <GameStatus>sample string 3</GameStatus>
    <IsComplete>true</IsComplete>
    <StartTime>2026-01-01T21:22:10.8279707-08:00</StartTime>
    <StatusID>2</StatusID>
  </Status>
</oGameInfo>