GET api/Game/{gameId}/Start

Use this to start a game

Request Information

URI Parameters

Name	Description	Type	Additional information
gameId	The game Id of the game you want to start	integer	Required

Body Parameters

None.

Response Information

Resource Description

The response to the start game request

StartGameResponse

Name	Description	Type	Additional information
Success	True if successfully started the game.	boolean	Required
ErrorMessage	Error message if the request is unsuccessful.	string	Required
GameParticipants	The list of game participants	Collection of GameParticipant	None.

Response Formats

application/json, text/json

Sample:

{
  "success": true,
  "errorMessage": "sample string 2",
  "gameParticipants": [
    {
      "gameParticipantId": 1,
      "gameId": 2,
      "name": "sample string 3",
      "ipAddress": "sample string 4",
      "roleId": 5
    },
    {
      "gameParticipantId": 1,
      "gameId": 2,
      "name": "sample string 3",
      "ipAddress": "sample string 4",
      "roleId": 5
    }
  ]
}

application/xml, text/xml

Sample:

<StartGameResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TScunts.Models.API.MClone">
  <ErrorMessage>sample string 2</ErrorMessage>
  <GameParticipants>
    <GameParticipant>
      <GameId>2</GameId>
      <GameParticipantId>1</GameParticipantId>
      <IPAddress>sample string 4</IPAddress>
      <Name>sample string 3</Name>
      <RoleId>5</RoleId>
    </GameParticipant>
    <GameParticipant>
      <GameId>2</GameId>
      <GameParticipantId>1</GameParticipantId>
      <IPAddress>sample string 4</IPAddress>
      <Name>sample string 3</Name>
      <RoleId>5</RoleId>
    </GameParticipant>
  </GameParticipants>
  <Success>true</Success>
</StartGameResponse>