API Documentation for Tagging

Report a Source/Destination Tag

Description

Reports either:

1. A tag of the current player by another player, or
2. A tag of another player by the current player

The player name in the URL specifies the reporter sending the tag.

To successfully complete a tag, a tag report must be sent by each player with 20 seconds - the tag source and the tag destination.

See the possible names for a Player.

Request

Method

POST

Mapping

/tag/{reporting_player_name}

Headers

Field	Value(s)
Content-Type	application/json

JSON body

Being tagged by another player

{
    "source" : "Pinky"
}

Tagging another player

{
    "destination" : "Clyde"
}

Response

Codes

HTTP Status Code	Meanings
200 OK	Processed tag report successfully
400 Bad Request	The request body was incorrectly formed
	Both source and destination were given
	Neither source nor destination were given
404 Not Found	The given name was invalid
409 Conflict	The game is not in progress
	The Players are the same
	Both Players are Ghosts
	The reporting Player or source/destination Player is not active in the game
500 Internal Server Error	The server crapped itself

JSON body

{
}

Example cURL call (tagging another player)

Example cURL call (being tagged by another player)