Endpoints para Lenguaje
En el contexto de nuestra API, un lenguaje representa una entidad que almacena información sobre los distintos idiomas en los que se pueden visualizar los datos.
Características Comunes del Lenguaje
-
Identificación Única: Cada lenguaje tiene un identificador único
idque los distingue de otros lenguajes en el sistema. -
Datos de Lenguaje: Un lenguaje tiene información asociada como nombre, iso (código del país) y código.
Endpoints
GET/Language/getLanguage
Obtención de todos los Lenguajes almacenados en el sistema.
Descripción
Este endpoint recupera una lista paginada de lenguajes del sistema. Permite a los clientes obtener datos de lenguajes 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 lenguaje, incluyendo su ID, nombre, iso (código del país) y código.
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",
"code": "string",
"iso": "string",
"name": "string"
}
],
"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>
<code>string</code>
<iso>string</iso>
<name>string</name>
</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 Lenguaje. | 404 | {"code": 404,"error": "No entity found for Language."} |
| Este error ocurre cuando intenta enviar demasiadas solicitudes en un corto periodo de tiempo. | 429 | {"code": 429,"error": "Too Many Requests"} |