Endpoints para País

En el contexto de nuestra API, un país representa una entidad que define características de una nación, permitiendo su identificación y manejo en diversas operaciones dentro del sistema.

Características Comunes de un País

1. Identificación Única: Cada país tiene un identificador único id que los distingue de otros países en el sistema.

2. Datos de País: De cada país, se almacena una descripción y código ISO.

Endpoints

GET/Country/getCountry

Obtención de todos los Países almacenados en el sistema.

Descripción

Este endpoint recupera una lista paginada de países del sistema. Permite a los clientes obtener datos de países 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 país, incluyendo su ID, descripción y código del país (iso).

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",
      "idRemote": "string",
      "description": "string",
      "iso": "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>
      <idRemote>string</idRemote>
      <description>string</description>
      <iso>string</iso>
    </item>
  </data>
  <pagination>
    <totalItems>0</totalItems>
    <itemsPerPage>0</itemsPerPage>
    <currentPage>0</currentPage>
    <totalPages>0</totalPages>
    <nextPageUrl>string</nextPageUrl>
  </pagination>
</export>

👉Prueba este endpoint🌱

GET/Country/getCountryByIso/{iso}

Obtención de un País almacenado dado su código ISO.

Descripción

Este endpoint recupera todos los datos de un país dado su código iso. La respuesta incluye información detallada sobre cada país, incluyendo su ID, descripción y código del país (iso).

Parámetros

Nombre	Descripción	Tipo
iso	Código ISO	String

Respuestas

JSON

{
  "data": [
      {
      "id": "string",
      "idRemote": "string",
      "description": "string",
      "iso": "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>
      <idRemote>string</idRemote>
      <description>string</description>
      <iso>string</iso>
    </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 País.	404	{"code": 404,"error": "No entity found for Country."}
Este error ocurre cuando intenta enviar demasiadas solicitudes en un corto periodo de tiempo.	429	{"code": 429,"error": "Too Many Requests"}