Endpoints para Tipo
La entidad Tipo se referencia desde la entidad Item y referencia a tipos de archivo (imagen, pdf, etc).
Características Comunes del Tipo
-
Identificación Única: Cada tipo tiene un identificador único
idque los distingue de otros tipos en el sistema. -
Datos de Tipo: Para cada tipo hay una descripción y una variable que determina si está activo o inactivo. La descripción indica de qué tipo se trata.
Endpoints
GET/Type/getType
Devuelve una lista paginada con todos los tipos disponibles en la base de datos.
Descripción
Permite obtener una lista con los tipos organizada según los parámetros de paginación como el número de página (page) y el número de ítems por página (pageSize).
Parámetros
| Nombre | Descripción | Tipo | Valor por defecto |
|---|---|---|---|
page | Número de página | Integer | 1 |
pageSize | Elementos por página | Integer | 10 |
Respuestas
JSON
{
"data": [
{
"id": "string",
"description": "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>
<description>string</description>
<active>true</active>
</item>
</data>
<pagination>
<totalItems>0</totalItems>
<itemsPerPage>0</itemsPerPage>
<currentPage>0</currentPage>
<totalPages>0</totalPages>
<nextPageUrl>string</nextPageUrl>
</pagination>
</export>
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 registro. | 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"} |