Events

List All Events

GET /events

Request

No specific request parameters are required for listing all events.

Response

{
  "status": "success",
  "return_count": 2,
  "data": [
    {
      "id": 1,
      "name": "Event 1",
      "total_amount": 456.50,
      "budgets_count": 5,
      "description": "Description for Event 1",
      "event_date": "2024-01-19"
    },
    {
      "id": 2,
      "name": "Event 2",
      "total_amount": 145.50,
      "budgets_count": 12,
      "description": "Description for Event 2",
      "event_date": "2024-01-20"
    }
  ]
}

The response includes the status, total number of events, and an array of event details.

View Single Event

GET /events/view/{id}

Request

Replace {id} with the ID of the event you want to view.

Response

{
  "status": "success",
  "return_count": 1,
  "data": {
    "id": 1,
    "name": "Event 1",
    "total_amount": 4596.00,
    "budgets_count": 17,
    "description": "Description for Event 1",
    "event_date": "2024-01-19"
  }
}

The response includes the status, total number of events (1 in this case), and details of the requested event.

Create Event

POST /events/create

Request

• Content-Type: application/json
• Body:

{
  "name": "New Event",
  "description": "Description for New Event",
  "event_date": "2024-01-21"
}

Response

{
  "status": "success",
  "message": "Event saved successfully"
}

{
  "status": "error",
  "message": "Event failed to save"
}

{
  "status": "error",
  "message": "Invalid request method"
}

Update Event

POST /events/update/{id}

Request

Replace {id} with the ID of the event you want to update.

• Content-Type: application/json
• Body:

{
  "name": "Updated Event",
  "description": "Updated description for Event",
  "event_date": "2024-01-22"
}

Response

{
  "status": "success",
  "message": "Event saved successfully"
}

{
  "status": "error",
  "message": "Event failed to save"
}

{
  "status": "error",
  "message": "Invalid request method"
}

Delete Event

POST /events/delete/{id}

Request

Replace {id} with the ID of the event you want to delete.

Response

{
  "status": "success",
  "message": "Event deleted successfully"
}

{
  "status": "error",
  "message": "Event failed to delete"
}

{
  "status": "error",
  "message": "Invalid request method"
}