Endpoints para Estado (Provincia)

La entidad State se refiere a las provincias o estados que forman un determinado país. Cada entidad de este tipo se relaciona con un País a través de su identificador único.

Endpoints

GET/State/getState

Obtención de todas las entidades State almacenadas en el sistema.

Descripción

Este endpoint recupera una lista paginada de los estados almacenados en el sistema. Los parámetros de paginación pueden modificarse siguiendo las indicaciones detalladas en el siguiente punto.

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",
      "country": {
          "id": "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>
  	<export>
  		<id>string</id>
  		<name>string</name>
  		<country>
  			<id>string</id>
  			<description>string</description>
  			<iso>string</iso>
  		</country>
  	</export>
  </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 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 ocurre cuando intenta enviar demasiadas solicitudes en un corto periodo de tiempo.	429	{"code": 429,"error": "Too Many Requests"}