List modules

Paginated list

GET /api/modulo Returns a paginated list of modules. Results are ordered by id descending, with a fixed page size of 5 records.

Query parameters

number

default:"1"

Page number to retrieve. Defaults to 1.

string

Case-insensitive substring filter applied to strNombreModulo. Uses SQL ILIKE '%value%'.

Response

boolean

required

true when the query completes without error.

object[]

required

Array of module objects for the requested page.

Show module object properties

number

Primary key of the module.

string

Module name. Always stored in uppercase.

number

required

Total number of pages available given the current filters and a page size of 5.

Error response

When an unexpected server error occurs the handler catches the exception and returns:

500

{
  "success": false,
  "message": "Ocurrió un error al consultar los módulos."
}

Examples

curl --request GET \
  --url 'https://your-domain.com/api/modulo?page=1&search=ventas' \
  --cookie 'auth_token=<your-jwt>'

const params = new URLSearchParams({
  page: '1',
  search: 'ventas',
});

const response = await fetch(`/api/modulo?${params}`, {
  credentials: 'include',
});

const { success, data, totalPages } = await response.json();

Success response

200

{
  "success": true,
  "data": [
    {
      "id": 5,
      "strNombreModulo": "VENTAS"
    }
  ],
  "totalPages": 2
}

Simple list (for dropdowns)

GET /api/modulo/list Returns all modules without pagination. All fields (id and strNombreModulo) are included. Results are ordered by id ascending. Intended for populating select inputs in the UI.

Response

boolean

required

true when the query completes without error.

object[]

required

Array of all module objects.

Show module object properties

number

Primary key of the module.

string

Module name.

Error response

When an unexpected server error occurs:

500

{
  "statusCode": 500,
  "message": "Error al cargar módulos"
}

Examples

curl --request GET \
  --url 'https://your-domain.com/api/modulo/list' \
  --cookie 'auth_token=<your-jwt>'

const response = await fetch('/api/modulo/list', {
  credentials: 'include',
});

const { success, data } = await response.json();

Success response

200

{
  "success": true,
  "data": [
    { "id": 1, "strNombreModulo": "USUARIOS" },
    { "id": 2, "strNombreModulo": "PERFILES" },
    { "id": 3, "strNombreModulo": "MODULOS" }
  ]
}

Authentication

Users

Profiles

Modules

Permissions

Paginated list

Query parameters

Response

Error response

Examples

Success response

Simple list (for dropdowns)

Response

Error response

Examples

Success response

​Paginated list

​Query parameters

​Response

​Error response

​Examples

​Success response

​Simple list (for dropdowns)

​Response

​Error response

​Examples

​Success response

Paginated list

Query parameters

Response

Error response

Examples

Success response

Simple list (for dropdowns)

Response

Error response

Examples

Success response