GET api/Game/{gameCode}/Join/{name}
Use this to join a game
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
gameCode |
The game code of the game you want to join |
string |
Required |
name |
The name you want to join the game as |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
The response to the join game request
JoinGameResponseName | Description | Type | Additional information |
---|---|---|---|
GameParticipantId |
The game participant id of this user for this game. |
integer |
None. |
GameId |
The Id of the game created if it's created. |
integer |
Required |
Success |
True if successfully created the game. |
boolean |
Required |
ErrorMessage |
Error message if the request is unsuccessful. |
string |
Required |
Code |
Code for the game. |
string |
Required |
Response Formats
application/json, text/json
Sample:
{ "gameParticipantId": 1, "gameId": 2, "success": true, "errorMessage": "sample string 4", "code": "sample string 5" }
application/xml, text/xml
Sample:
<JoinGameResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TScunts.Models.API.MClone"> <Code>sample string 5</Code> <ErrorMessage>sample string 4</ErrorMessage> <GameId>2</GameId> <Success>true</Success> <GameParticipantId>1</GameParticipantId> </JoinGameResponse>