Consultas - Sucursales

Catálogos de ubicación (departamento → distrito → ciudad) usados para el registro de Sucursales.

Consultar departamentos

Obtener el listado completo de departamentos

GET ip:puerto/consulta/sucursales/departamentos

Ejemplo de la respuesta

{
  "status": true,
  "data": [
    { "id": 1, "descripcion": "CAPITAL" },
    { "id": 2, "descripcion": "CONCEPCION" },
    { "id": 12, "descripcion": "CENTRAL" }
  ]
}

Referencia API: consultarDepartamentos

Consultar distritos

Obtener el listado de distritos, opcionalmente filtrado por departamento

GET ip:puerto/consulta/sucursales/distritos

Query param	Tipo	Obligatorio	Detalle
departamento	number (id)	No	Si se envía, filtra los distritos de ese departamento. Si se omite, devuelve todos los distritos

Ejemplo de request

GET ip:puerto/consulta/sucursales/distritos?departamento=12

Ejemplos de la respuesta

{
  "status": true,
  "data": [
    { "id": 152, "descripcion": "AREGUA", "departamento": 12 },
    { "id": 154, "descripcion": "FERNANDO DE LA MORA", "departamento": 12 },
    { "id": 159, "descripcion": "LUQUE", "departamento": 12 }
  ]
}

{
  "status": false,
  "requestId": "<uuid>",
  "message": "El parámetro departamento debe ser numérico",
  "data": []
}

Referencia API: consultarDistritos

Consultar ciudades

Obtener el listado de ciudades, opcionalmente filtrado por departamento y/o distrito

GET ip:puerto/consulta/sucursales/ciudades

Query param	Tipo	Obligatorio	Detalle
departamento	number (id)	No	Filtra las ciudades de ese departamento
distrito	number (id)	No	Filtra las ciudades de ese distrito

Ambos parámetros son independientes y se pueden combinar. Si se omiten los dos, devuelve todas las ciudades del catálogo.

Ejemplo de request

GET ip:puerto/consulta/sucursales/ciudades?departamento=12&distrito=154

Ejemplos de la respuesta

{
  "status": true,
  "data": [
    { "id": 5044, "descripcion": "FERNANDO DE LA MORA", "departamento": 12, "distrito": 154 },
    { "id": 5045, "descripcion": "4 VIENTOS", "departamento": 12, "distrito": 154 },
    { "id": 5846, "descripcion": "BARRIO STA.MARIA", "departamento": 12, "distrito": 154 }
  ]
}

{
  "status": false,
  "requestId": "<uuid>",
  "message": "El parámetro distrito debe ser numérico",
  "data": []
}

Referencia API: consultarCiudades

Notas comunes a los 3 endpoints

• El campo descripcion corresponde al nombre almacenado en los catálogos de ubicación.
• Los ids devueltos son los mismos que espera POST /empresa/sucursales en los campos departamento, distrito y ciudad.
• Ante cualquier excepción no controlada, la respuesta es:

{
  "status": false,
  "requestId": "<uuid>",
  "message": "<detalle del error>",
  "data": []
}