Skip to main content
Version: Latest

Listado de ciudades

Se consulta nombre de ciudad, departamento y codigo correspondiente.

Las ciudades disponibles en formato json en esta ruta: https://app.aveonline.co/assets/resources/public/listadociudades.json

Request 🚀

url

https://app.aveonline.co/api/box/v1.0/ciudad.php

Method

POST

Content-Type: application/json

Params JSON

  • tipo* String Enrutador de la API, "listar"
  • data* String Nombre de la ciudad que se desea buscar
  • registros* Number Cantidad de registros relacionados a la búsqueda que se desean visualizar

Ejemplo

{
"tipo": "listar",
"data": "bogota",
"registros": ""
}

Response 📄

Success

  • status String Estado del resultado
  • message String Mensaje de respuesta
  • ciudades Array Object -> [{}]
    • nombre String Nombre de la ciudad con el formato adecuado
    • id Number Identificador interno de la ciudad
    • codigoDANE String Codigo DANE de 8 posiciones de la ciudad

Ejemplo

{
"status": "ok",
"message": "registros encontrados",
"ciudades": [
{
"nombre": "BETANIA(BOGOTA D.C.)",
"id": 932,
"codigoDANE": "11001009"
},
{
"nombre": "BOGOTA(CUNDINAMARCA)",
"id": 927,
"codigoDANE": "11001000"
},
{
"nombre": "BOSA(BOGOTA)",
"id": 9230,
"codigoDANE": "5861002"
},
{
"nombre": "ENGATIVA(BOGOTA)",
"id": 9237,
"codigoDANE": "11001001"
},
{
"nombre": "FONTIBON(BOGOTA)",
"id": 9233,
"codigoDANE": "119011000"
},
{
"nombre": "LA UNION(BOGOTA D.C.)",
"id": 933,
"codigoDANE": "11001010"
},
{
"nombre": "PASQUILLA(BOGOTA D.C.)",
"id": 930,
"codigoDANE": "11001007"
},
{
"nombre": "PUERTO BOGOTA(CUNDNAMARCA)",
"id": 9238,
"codigoDANE": "25320003"
},
{
"nombre": "SAN JUAN DE SUMAPAZ(BOGOTA D.C.)",
"id": 929,
"codigoDANE": "11001005"
},
{
"nombre": "SAN JUAN(BOGOTA D.C.)",
"id": 931,
"codigoDANE": "11001008"
},
{
"nombre": "USAQUEN(BOGOTA)",
"id": 9231,
"codigoDANE": "119041000"
}
]
}

Error

Campo data vacío

{
"status": "error",
"message": "El campo data no puede estar vacio"
}

Campo data numérico

{
"status": "error",
"message": "El campo data no puede ser numerico"
}

No se encuentran datos asociados

{
"status": "error",
"message": "registros no encontrados",
"ciudades": []
}

Credenciales incorrectas o token expirado

{
"status": "error",
"message": "credenciales incorrectas"
}