Endpoints para Rol

En el contexto de nuestra API, un rol representa una entidad. Este rol indica el papel que tiene cada socio comercial, puede ser Cliente, Administrador, Representante, Usuario de la API y algunos más.

Características Comunes de los Roles

1. Identificación Única: Cada rol tiene un identificador único id que los distingue de otros roles en el sistema.

2. Datos del rol: Normalmente, un rol tiene información asociada, en este caso un nombre.

3. Estado y Actividad: Puede haber estados que indican si el rol está activo, inactivo o suspendido temporalmente, dependiendo de las reglas de negocio y políticas de la plataforma.

Endpoints

GET/Role/getRole

Obtener Roles

Descripción

El método GET recupera una lista paginada de roles del sistema. Permite obtener datos de roles basados en parámetros de paginación como el número de página (page) y el número de ítems por página (pageSize). La respuesta incluye información detallada sobre cada rol, incluyendo su ID, nombre completo y si está activo o no.

Parámetros

Nombre	Descripción	Tipo	Valor Predeterminado
page	Número de página	Integer	1
pageSize	Número de ítems por página	Integer	10

Respuestas

JSON

      {
          "data": [
              {
              "id": "string",
              "name": "string",
              "active": true
              }
          ],
          "pagination": {
              "totalItems": 0,
              "itemsPerPage": 0,
              "currentPage": 0,
              "totalPages": 0,
              "nextPageUrl": "string"
          }
      }

XML

<?xml version="1.0" encoding="UTF-8"?>
  <export>
    <data>
      <item>
        <id>string</id>
        <name>string</name>
        <active>true</active>
      </item>
    </data>
    <pagination>
      <totalItems>0</totalItems>
      <itemsPerPage>0</itemsPerPage>
      <currentPage>0</currentPage>
      <totalPages>0</totalPages>
      <nextPageUrl>string</nextPageUrl>
    </pagination>
  </export>     

👉Prueba este endpoint🌱

Posibles Errores en la Respuesta

Error	Código	Respuesta
Este error ocurre cuando no se puede establecer una conexión con la base de datos. Es un problema interno del servidor.	500	{"code": 500,"error": "Database connection failed."}
Este error ocurre cuando no puede insertar o actualizar y en la dbs de pruebas.	500	{"code": 500,"error": "Invalid connection name, you cannot insert in default"}
Este error indica que el servidor rechaza la solicitud.	400	{"code": 400,"error": "Bad Request"}
Este error indica que no está autorizado.	401	{"code": 401,"error": "Unauthorized."}
Este error indica que no ha sido posible encontrar el Rol.	404	{"code": 404,"error": "No entity found."}
Este error ocurre cuando intenta enviar demasiadas solicitudes en un corto periodo de tiempo.	429	{"code": 429,"error": "Too Many Requests"}