Skip to main content

Servicio Consolidado Reintento

Para consumir el servicio REST, es necesario hacer un llamado POST, usando una autenticación básica en los “headers” con el usuario y la contraseña proporcionados.

Este servicio permite reintentar las fuentes que fallaron en una consulta previamente ejecutada. No consume una consulta nueva: las fuentes ya fueron cobradas al momento de crear la consulta original.

🔗 Endpoints disponibles​

POSThttp://localhost:8081/app/servicioConsolidadoReintentoV2

📦 Estructura JSON​

{
  "consultaId": "6819352a2d56fe06e5879fd4"
}

Estructura JSON de Envío​

La solicitud al servicio debe enviarse en formato JSON, con el siguiente atributo obligatorio:

AtributoTipoDescripción
consultaIdStringCampo que indica el identificador único de la consulta previa cuyas fuentes con error se van a reintentar. La consulta debe estar en estado TERMINADO y pertenecer a la empresa del usuario autenticado.

🧾 Respuesta​

✅ Ejemplo de respuesta (200 OK)​

[
  {
    "id": "6819352a2d56fe06e5879fd4",
    "idDatoConsultado": "",
    "dato": "HXX005",
    "tipoDocumento": "plc",
    "apis": [
      {
        "lista": "nombreApi",
        "tipo": "vehiculo",
        "presentaAdvertencia": false,
        "Resultado": {}
      },
    ]
  }
]

Estructura JSON de Respuesta​

En todos los casos, se retorna una estructura JSON con los siguientes atributos:

AtributoTipoDescripción
idStringCampo que indica el id de la consulta.
idDatoConsultadoStringCampo que indica el identificador único del dato consultado. Sirve para hacer seguimiento ante posibles dudas o errores.
tipoDocumentoStringCampo que indica el tipo de Documento consultado. Ejemplo: Cédula, NIT, etc.
datoStringCampo que indica el número de documento consultado.
apisJSONArrayCampo que indica arreglo con objetos que contienen los resultados de cada fuente.

Estructura JSON de una api dentro del JSON de apis​

AtributoTipoDescripción
listaStringCampo que indica el nombre único de la fuente dentro del sistema. Se debe homologar con el listado de fuentes disponibles descrito en el apartado de apis.
tipoStringCampo que indica agrupación lógica dentro de la aplicación, ejemplo: Información General, Seguridad Social, Fuentes Nacionales, Fuentes Internacionales, PEPS, Noticias, Buscadores, Lista Privadas.
presentaRiesgoBooleanCampo que indica si la fuente generó alerta de riesgo.
presentaAdvertenciaBooleanCampo que indica si la fuente generó advertencia de riesgo. Sólo se incluye si el parámetro SoloRiesgo se envía en false.
errorStringCampo que indica mensaje de error que se incluye únicamente cuando se produjo un error en el origen.

❌ Ejemplo de respuesta (400 BAD REQUEST)​

"Debe enviar el consultaId"

❌ Ejemplo de respuesta (401 UNAUTHORIZED)​

"La empresa no tiene permisos para consumir este servicio"

❌ Ejemplo de respuesta (500 INTERNAL SERVER ERROR)​

 "Ha ocurrido un error interno"