Servicio que obtiene la lista de todas las ciudades del Paraguay admitidos por el SIFEN. En cada elemento se recupera el código y la descripción, y el objeto Distrito al cual pertenece la Ciudad.
Puede especificar un distrito específico del cual desea obtener las ciudades, en la ruta // de la URL, o puede especificar en dicho campo el valor NULL si desea recuperar todos las Ciudades.
También es posible realizar busquedas por nombres de ciudades parecidos enviando un query param: ?nombre=valor, indicando el valor para el filtro.
Puede utilizar este servicio para mantener actualizado los datos de los distritos en su Sistema.
Endpoint (URL) #
GET https://api.facturasend.com.py/<tenantId>/ciudades/<distritoId>
GET https://api.facturasend.com.py/<tenantId>/ciudades/null
Header (Encabezado) #
Requiere el envío del los siguientes atributos en el encabezado
Campo | Valor |
---|---|
Authorization | Bearer api_key_reemplazar_api_key |
Parámetros (BODY) #
No posee
Parámetros (Query Param) #
Campo | Valor |
---|---|
nombre | Distrito para filtrar |
Este parámetro es opcional y sirve para filtrar las ciudades utilizando el operador LIKE, ejemplo
GET https://api.facturasend.com.py/<tenantId>/ciudades/null?nombre=bahia
Ejemplo de llamadas #
# Obtiene los distritos del departamento y filtrando por el nombre curl \ GET "https://api.facturasend.com.py/<tenantId>/ciudades/<distritoId>?nombre=asuncion" \ -H "Authorization: Bearer api_key_<reemplazar_api_key>"
# El ejemplo se muestra utilizando AXIOS import axios from 'axios'; const headers = { `Authorization` : `Bearer api_key_<reemplazar_api_key>` }; axios.post({ url: `https://api.facturasend.com.py/<tenantId>/ciudades/<distritoId>?nombre=asuncion`, method: 'GET', {headers} } ).then( respuesta => { console.log(respuesta); });
Respuesta de la Petición #
La respuesta de la petición será la siguiente:
{ "success" : true, "result" : [{ "codigo": 5666, "descripcion": "B.AEREA NVA.ASUNCION (PICUIBA)", "distrito": { "codigo": 234, "descripcion": "GRAL. EUGENIO A. GARAY", "departamento": { "codigo": 16, "descripcion": "BOQUERON" } } }, { "codigo": 5678, "descripcion": "NUEVA ASUNCION", "distrito": { "codigo": 234, "descripcion": "GRAL. EUGENIO A. GARAY", "departamento": { "codigo": 16, "descripcion": "BOQUERON" } } }, { "codigo": 999, "descripcion": "Otros", "distrito": { "codigo": 999, "descripcion": "Otros", "departamento": { "codigo": 999, "descripcion": "Otros" } } }] }
Recomendaciones #
- No aplica
Validaciones #
- No aplica