List profiles

Paginated list

GET /api/perfil Returns a paginated list of profiles. 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 strNombrePerfil. Uses SQL ILIKE '%value%'.

string

Filter by administrator flag. Pass "true" to return only administrator profiles, "false" to return only non-administrator profiles. Omit to return all profiles regardless of flag.

Response

boolean

required

true when the query completes without error.

object[]

required

Array of profile objects for the requested page.

Show profile object properties

number

Primary key of the profile.

string

Profile name.

boolean

true if this profile has administrator-level access.

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 perfiles."
}

Examples

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

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

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

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

Success response

200

{
  "success": true,
  "data": [
    {
      "id": 3,
      "strNombrePerfil": "Administrador",
      "bitAdministrador": true
    }
  ],
  "totalPages": 2
}

Simple list (for dropdowns)

GET /api/perfil/list Returns all profiles without pagination. Only id and strNombrePerfil are included. Intended for populating select inputs in the UI.

Response

boolean

required

true when the query completes without error.

object[]

required

Array of all profile objects.

Show profile object properties

number

Primary key of the profile.

string

Profile name.

Error response

When an unexpected server error occurs:

500

{
  "statusCode": 500,
  "message": "Error al cargar lista de perfiles"
}

Examples

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

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

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

Success response

200

{
  "success": true,
  "data": [
    { "id": 1, "strNombrePerfil": "Operador" },
    { "id": 2, "strNombrePerfil": "Supervisor" },
    { "id": 3, "strNombrePerfil": "Administrador" }
  ]
}

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