Skip to main content

ApiResponseDTOUserCategoryDTO

Standard API response wrapper for all endpoints.

successboolean

Indicates whether the operation was successful

Example: true
data object

DTO that groups a user with their list of categorized budget entries.

userDTO object

DTO representing a user in the system.

idstring

Unique identifier of the user

Example: USR12345
usernamestring

Username used for login

Example: john_doe
firstNamestring

User's first name

Example: John
lastNamestring

User's last name

Example: Doe
emailstring

User's email address

Example: john.doe@example.com
gsmstring

User's mobile phone number

Example: +212612345678
categoryHolderDTOS object[]

List of categories associated with the user

  • Array [
  • categoryDTO object

    DTO representing a budget or transaction category assigned to a user.

    idinteger<int64>

    Unique identifier of the category

    Example: 1
    userIDstringrequired

    ID of the user who owns this category

    Example: USR123
    codestringrequired

    Code identifying the category (e.g., internal or functional code)

    Example: FOOD
    namestringrequired

    Display name of the category

    Example: Food & Dining
    maximumnumber

    Maximum allowed amount for this category

    Example: 1000
    isNotifyboolean

    Whether the user should be notified when approaching the limit

    Example: true
  • ]
  • messagestring

    Human-readable message describing the result

    Example: Operation completed successfully
    ApiResponseDTOUserCategoryDTO
    {
    "success": true,
    "data": {
    "userDTO": {
    "id": "USR12345",
    "username": "john_doe",
    "firstName": "John",
    "lastName": "Doe",
    "email": "john.doe@example.com",
    "gsm": "+212612345678"
    },
    "categoryHolderDTOS": [
    {
    "categoryDTO": {
    "id": 1,
    "userID": "USR123",
    "code": "FOOD",
    "name": "Food & Dining"
    },
    "maximum": 1000,
    "isNotify": true
    }
    ]
    },
    "message": "Operation completed successfully"
    }