EquipmentsController

CpRedEquipmentsController

This page contains documentation for the CpRedEquipmentsController, which manages equipment items in the Cyberpunk Red.

Basic Information

Base Path: /api/v1/authorized
Package: dev.goral.rpghandyhelper.rpgSystems.cpRed.manual.equipments

Authentication

All requests to this controller require an XSRF token to be included in the headers.
Example:

headers: {
  "X-XSRF-TOKEN": "<csrfToken>"
}

---

Endpoint Summary

HTTP Method	Path	Description
GET	/rpgSystems/cpRed/equipments/all	Returns basic info about all available equipments
GET	/rpgSystems/cpRed/equipments/{equipmentId}	Returns detailed information about a specific equipment by ID
GET	/admin/rpgSystems/cpRed/equipments/all	Returns a full list of all equipments types with administrative data
POST	/admin/rpgSystems/cpRed/equipments/add	Adds a new equipment type to the system
PUT	/admin/rpgSystems/cpRed/equipments/update/{equipmentId}	Update equipment data

---

Field Descriptions

Request Body Fields (EquipmentDto)

• name (String): Name of the equipment. Required.
• price (Integer): Price for equipment in eurodollars. Required.
• availability (String): Availability status. Required. Possible values: CHEAP, EVERYDAY, COSTLY, PREMIUM, EXPENSIVE, VERY_EXPENSIVE, LUXURY, SUPER_LUXURY.
• -description (String): Description of the equipment. Required.

Response Fields

• message (String): Describes the result of the operation.
• error (Integer): HTTP status code.
• timestamp (String): Time the response was generated.
• equipment (Object): A single equipment object (if applicable).
• equipmentList (Array): List of equipments (if applicable).

Endpoint Details

Get All Equipments

Method: GET
Path: /rpgSystems/cpRed/equipments/all

Response

{
  "equipments": [
    {
      "name": "item",
      "price": 100,
      "availability": "CHEAP",
      "description": "A cheap item"
    }
  ],
  "message": "Wyposażenie zostało pobrane.",
  "error": 200,
  "timestamp": "..."
}

Possible Errors

• 401 Unauthorized: User is not logged in.

---

Get Equipment by ID

Method: GET
Path: /rpgSystems/cpRed/equipments/{equipmentId}

Response

{
  "equipment": {
    "name": "item",
    "price": 100,
    "availability": "CHEAP",
    "description": "A cheap item"
  },
  "message": "Pobrano przedmiot.",
  "error": 200,
  "timestamp": "..."
}

Possible Errors

• 400 Bad Request: Invalid equipment ID.
• 401 Unauthorized: User is not logged in.
• 404 Not Found: Equipment with the specified ID does not exist.

---

Get All Equipments with Admin Data

Method: GET
Path: admin/rpgSystems/cpRed/equipments/all

Response

{
  "equipments": [
    {
      "id": 1,
      "name": "item",
      "price": 100,
      "availability": "CHEAP",
      "description": "A cheap item"
    }
  ],
  "message": "Wyposażenie zostało pobrane.",
  "error": 200,
  "timestamp": "..."
}

Possible Errors

• 401 Unauthorized: User is not logged in.
• 403 Forbidden: User is not an admin.

---

Add New Equipment

Method: POST
Path: /admin/rpgSystems/cpRed/equipment/add

Request

{
  "name": "item",
  "price": 100,
  "availability": "CHEAP",
  "description": "A cheap item"
}

Response

{
  "message": "Przedmiot item został dodany",
  "error": 200,
  "timestamp": "..."
}

Possible Errors

• 400 Bad Request: User not authenticated.
• 401 Unauthorized: User not logged in.
• 403 Forbidden: User is not an admin.
• 404 Not Found: Invalid equipment data.

---

Update Equipment

Method: PUT
Path: /admin/rpgSystems/cpRed/cyberwares/equipment/{equipmentId}

Request

{
  "name": "new item",
  "price": 130,
  "availability": "CHEAP",
  "description": "Better item"
}

Response

{
  "message": "Przedmiot został zaktualizowany.",
  "error": 200,
  "timestamp": "..."
}

Possible Errors

• 400 Bad Request: Invalid equipment ID or data.
• 401 Unauthorized: User not logged in.
• 403 Forbidden: User is not an admin.
• 404 Not Found: Equipment with the specified ID does not exist.

---

Common Troubleshooting Tips

• Missing XSRF Token: Ensure the X-XSRF-TOKEN header is included in every request.
• Invalid Fields: Double-check the request body for missing or invalid fields.
• Permission Issues: Verify that the user has the necessary permissions for the requested operation.