Players

POST /players

Create a player and return his ID

Endpoint

Request Body

{
  "establishmentId": "string"
  "name": "string"
}

Responses

200

User created successfully.

{
  "message": "Player created successfully"
  "playerId": "123e4567-e89b-12d3-a456-426614174000"
}

500

Internal server error when the user creation fails.

{
  "message": "Failed to create user"
  "error": "Error message with details"
}

GET /players

Returns a list of players associated with an establishment

Endpoint

Responses

200

Query executed successfully.

{
  "0": "undefined"
}

400

Bad request due to missing establishmentId parameter.

{
  "message": "Missing establishmentId parameter"
}

GET /players/[playerId]

Return a player

Endpoint

Parameters

Responses

200

User retrieved successfully.

{
  "playerId": "undefined"
  "name": "undefined"
  "coins": "undefined"
  "status": "undefined"
}

400

Bad request due to missing playerId parameter.

{
  "message": "Missing playerId parameter"
}

404

User not found.

{
  "message": "User not found"
}

500

Internal server error when there's a problem retrieving the user.

{
  "message": "Failed to get user"
  "error": "Error message with details"
}

PUT /players/[playerId]

Updates the name, email, and establishment ID for a player given the user ID.

Endpoint

Request Body

{
  "name": "string"
  "status": "string"
  "establishmentId": "string"
}

Parameters

Responses

200

Player information updated successfully

{
  "status": "success"
  "updatedAttributes": "object"
}

400

Bad Request - Invalid input provided

404

Not Found - The player with the given user ID was not found

500

Internal Server Error - Could not update player

DELETE /players/[playerId]

Eliminate and player and their balance

Endpoint

Parameters

Responses

200

User deleted successfully.

{
  "message": "User deleted successfully"
}

400

Bad request due to missing or invalid playerId.

{
  "message": "Missing or invalid playerId"
}

404

User not found in the database.

{
  "message": "User not found"
}

500

Internal server error when there's a problem deleting the user.

{
  "message": "Error deleting the user"
}