Servicio Consolidado
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.
🔗 Endpoints disponibles
POSThttp://localhost:8081/app/servicioConsolidadoV2
📦 Estructura JSON
{
"placa": "HXX005",
"PLUS": true,
"PA": true
}
Estructura JSON de Envío
La solicitud al servicio debe enviarse en formato JSON, con los siguientes atributos obligatorios:
| Atributo | Tipo | Descripción |
|---|---|---|
| placa | String | Campo que indica la placa del vehículo a consultar. |
| PLUS | Boolean | (Opcional) Campo que indica si la consulta sera plus o no. Por defecto su valor es false |
| PA | Boolean | (Opcional) Campo que indica que se consultaran las fuentes configuradas de persona, para todos los propietarios del vehículo, este parámetro viene atado con el parámetro PLUS. Si el parámetro PLUS se envía en false y este en true, se cambiará de manera automática a false este campo. Se puede omitir en el body o se puede enviar como false. |
🧾 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:
| Atributo | Tipo | Descripción |
|---|---|---|
| id | String | Campo que indica el id de la consulta. |
| idDatoConsultado | String | Campo que indica el identificador único del dato consultado. Sirve para hacer seguimiento ante posibles dudas o errores. |
| tipoDocumento | String | Campo que indica el tipo de Documento consultado. Ejemplo: Cédula, NIT, etc. |
| dato | String | Campo que indica el número de documento consultado. |
| apis | JSONArray | Campo que indica arreglo con objetos que contienen los resultados de cada fuente. |
Estructura JSON de una api dentro del JSON de apis
| Atributo | Tipo | Descripción |
|---|---|---|
| lista | String | Campo 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. |
| tipo | String | Campo 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. |
| presentaRiesgo | Boolean | Campo que indica si la fuente generó alerta de riesgo. |
| presentaAdvertencia | Boolean | Campo que indica si la fuente generó advertencia de riesgo. Sólo se incluye si el parámetro SoloRiesgo se envía en false. |
| error | String | Campo que indica mensaje de error que se incluye únicamente cuando se produjo un error en el origen. |
❌ 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"