Capture

Allows a ship to attempt to capture an objective or another game element at its current location or in an adjacent direction.

POST /api/v1/cubic/capture

Capture

cURL

curl --request POST \
  --url http://50.187.81.221:4000/api/v1/cubic/capture \
  --header 'Content-Type: application/json' \
  --data '
{
  "gameID": "uniqueGame123",
  "direction": "CURRENT",
  "capturingShip": {
    "teamName": "RedTeam",
    "shipName": "RedCruiser1"
  }
}
'

Body

application/json

Details for a ship to attempt a capture action, including the game ID, the direction, and the capturing ship.

Data transfer object for a ship to attempt a capture action.

gameID · string · required

The unique identifier of the game.

direction · enum<string> · required

The direction of the capture attempt relative to the capturing ship. 'CURRENT' means attempting capture at the same vertex.

Available options: CURRENT, UP, DOWN, LEFT, RIGHT, FORWARD, BACK

capturingShip · object · required

The ship attempting to capture an objective.

Show child attributes

Response

201

Capture attempt successfully executed.