From 4fc5828ba08ebc0f34978b66179998aa577c7840 Mon Sep 17 00:00:00 2001 From: Cristian Camargo Date: Mon, 22 Apr 2019 14:23:39 +0000 Subject: [PATCH] Update credito-creditos.json, documentacion de servicio de datacredito --- apigee/credito-creditos.json | 639 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 633 insertions(+), 6 deletions(-) diff --git a/apigee/credito-creditos.json b/apigee/credito-creditos.json index cd1c90b..1116bdb 100644 --- a/apigee/credito-creditos.json +++ b/apigee/credito-creditos.json @@ -78,7 +78,7 @@ ] } }, - "/v2/credito/solicitudes": { + "/v2/credito/solicitudes": { "get": { "tags": [ "cols-credito-solicitudes" @@ -130,8 +130,87 @@ } ] } + }, + "/v2/credito/solicitudes/natural": { + "get": { + "tags": [ + "cols-credito-solicitudes" + ], + "summary": "Consulta de historia de credito PN.", + "description": "Consulta de historia de credito para personas naturales.", + "operationId": "consultaHistoriaCreditoNatural", + "parameters": [ + { + "name": "usuarioId", + "in": "query", + "description": "Numero de identificacion del usuario.", + "required": true, + "schema": { + "type": "number" + } + }, + { + "name": "tipoId", + "in": "query", + "description": "Tipo del documento de identificacion del usuario.", + "required": true, + "schema": { + "type": "number" + } + }, + { + "name": "numId", + "in": "query", + "description": "Numero del documento de identificacion del usuario.", + "required": true, + "schema": { + "type": "number" + } + }, + { + "name": "primerApellido", + "in": "query", + "description": "Primer apellido del usuario.", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "clave", + "in": "query", + "description": "Clave del producto.", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Operación exitosa", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/consultaHistoriaCreditoNaturalResponse" + } + } + } + }, + "400": { + "description": "Estado inválido" + } + }, + "security": [ + { + "apigee_auth": [ + "write:apigee", + "read:apigee" + ] + } + ] + } } - }, "externalDocs": { "description": "Encontrar más información en EnterpriseArchitect", @@ -158,6 +237,10 @@ "cuota": { "type": "object", "properties": { + "valor": { + "type": "string", + "description": "Numero de cuotas pactadas" + }, "pactada": { "type": "string", "description": "Numero de cuotas pactadas" @@ -177,7 +260,7 @@ "aprobado": { "type": "string", "description": "Numero de cuotas aprobadas" - } + } }, "xml": { "name": "cuota" @@ -218,6 +301,14 @@ "mora": { "type": "object", "properties": { + "saldo": { + "type": "string", + "description": "Saldo de la mora." + }, + "maxima": { + "type": "string", + "description": "Maximo valor de la mora." + }, "dias": { "type": "string", "description": "Dias de mora." @@ -309,14 +400,17 @@ "properties": { "radicacion": { "type": "string", + "format": "date-time", "description": "Fecha de radicacion." }, "proceso": { "type": "string", + "format": "date-time", "description": "Fecha de proceso." }, "pago": { "type": "string", + "format": "date-time", "description": "Fecha de pago." } }, @@ -359,7 +453,7 @@ "name": "valor" } }, - "sistema": { + "sistema": { "type": "object", "properties": { "financiacion": { @@ -375,7 +469,7 @@ "name": "sistema" } }, - "solicitudCredito": { + "solicitudCredito": { "type": "object", "properties": { "fecha": { @@ -414,8 +508,541 @@ "xml": { "name": "solicitudCredito" } + }, + "obligacionEndeudamiento": { + "type": "object", + "properties": { + "tipo": { + "type": "string", + "description": "Tipo de obligacion. Posibles valores: 'credito' o 'cartera'." + }, + "numero": { + "type": "string", + "description": "Numero de la cuenta." + }, + "entidad": { + "$ref": "#/components/schemas/entidad" + } + }, + "xml": { + "name": "obligacion" + } + }, + "obligacion": { + "type": "object", + "properties": { + "tipo": { + "type": "string", + "description": "Tipo de obligacion. Posibles valores: 'credito' o 'cartera'." + }, + "bloqueada": { + "type": "boolean", + "description": "Valida si la cuenta esta bloqueada." + }, + "numero": { + "type": "string", + "description": "Numero de la cuenta." + }, + "fechaApertura": { + "type": "string", + "format": "date-time", + "description": "Fecha de apertura de la cuenta." + }, + "fechaActualizacion": { + "type": "string", + "format": "date-time", + "description": "Fecha de actualizacion." + }, + "situacionTitular": { + "type": "string", + "description": "situacion del titular." + }, + "amparada": { + "type": "boolean", + "description": "Si tiene garante esta amparada. True si esta amparada, false de lo contrario." + }, + "obligacion": { + "type": "string", + "description": "Tipo de obligacion." + }, + "cupo": { + "type": "string", + "description": "Cupo de la obligacion." + }, + "saldo": { + "type": "string", + "description": "Saldo de la obligacion." + }, + "saldoInicial": { + "type": "string", + "description": "Saldo inicial de la obligacion." + }, + "garantia": { + "type": "string", + "description": "Garantia." + }, + "comportamiento": { + "type": "string", + "description": "Comportamiento." + }, + "positivoNegativo": { + "type": "string", + "description": "positivoNegativo." + }, + "fechaVencimiento": { + "type": "string", + "format": "date-time", + "description": "Fecha de vencimiento de la obligacion." + }, + "estado": { + "$ref": "#/components/schemas/estado" + }, + "ciudad": { + "$ref": "#/components/schemas/ciudad" + }, + "entidad": { + "$ref": "#/components/schemas/entidad" + }, + "cuenta": { + "type": "object", + "properties": { + "tipo": { + "type": "string", + "description": "Tipo de la cuenta." + } + } + }, + "contrato": { + "$ref": "#/components/schemas/contrato" + }, + "pago": { + "$ref": "#/components/schemas/pago" + }, + "cuota": { + "$ref": "#/components/schemas/cuota" + }, + "mora": { + "$ref": "#/components/schemas/mora" + } + }, + "xml": { + "name": "obligacion" + } + }, + + + "consulta": { + "type": "object", + "properties": { + "fecha": { + "type": "string", + "format": "date-time", + "description": "Fecha de consulta." + }, + "razon": { + "type": "string", + "description": "Razon de consulta." + }, + "cuenta": { + "type": "object", + "properties": { + "tipo": { + "type": "string", + "description": "Tipo de cuenta" + } + } + }, + "ciudad": { + "$ref": "#/components/schemas/ciudad" + }, + "entidad": { + "$ref": "#/components/schemas/entidad" + } + }, + "xml": { + "name": "consulta" + } + }, + + + "endeudamiento": { + "type": "object", + "properties": { + "calificacion": { + "type": "string", + "description": "Calificacion de endeudamiento." + }, + "saldoPendiente": { + "type": "string", + "description": "Saldo pendiente." + }, + "fechaReporte": { + "type": "string", + "format": "date-time", + "description": "Fecha de reporte." + }, + "garantia": { + "type": "string", + "description": "Garante." + }, + "moneda": { + "type": "string", + "description": "Moneda." + }, + "obligacion": { + "$ref": "#/components/schemas/obligacionEndeudamiento" + } + }, + "xml": { + "name": "endeudamiento" + } + }, + "pago": { + "type": "object", + "properties": { + "forma": { + "type": "string", + "description": "Forma de pago." + }, + "periodicidad": { + "type": "string", + "description": "Periodicidad pago." + } + }, + "xml": { + "name": "pago" + } + }, + "contrato": { + "type": "object", + "properties": { + "tipo": { + "type": "string", + "description": "Tipo de contrato." + }, + "permanencia": { + "type": "string", + "description": "Permanencia del contrato." + }, + "tiempo": { + "type": "string", + "description": "Nombre de la entidad." + } + }, + "xml": { + "name": "contrato" + } + }, + "entidad": { + "type": "object", + "properties": { + "nombre": { + "type": "string", + "description": "Nombre de la entidad." + }, + "sede": { + "$ref": "#/components/schemas/ciudad" + } + }, + "xml": { + "name": "entidad" + } + }, + "estado": { + "type": "object", + "properties": { + "codigo": { + "type": "string", + "description": "codigo de estado." + }, + "origen": { + "type": "string", + "description": "Origen del estado." + } + }, + "xml": { + "name": "estado" + } + }, + "cuenta": { + "type": "object", + "properties": { + "tipo": { + "type": "string", + "description": "Tipo de cuenta. Posibles valores: 'ahorro' o 'corriente'." + }, + "bloqueada": { + "type": "boolean", + "description": "Valida si la cuenta esta bloqueada." + }, + "numero": { + "type": "string", + "description": "Numero de la cuenta." + }, + "fechaApertura": { + "type": "string", + "format": "date-time", + "description": "Fecha de apertura de la cuenta." + }, + "fechaActualizacion": { + "type": "string", + "format": "date-time", + "description": "Fecha de actualizacion." + }, + "situacionTitular": { + "type": "string", + "description": "situacion del titular." + }, + "estado": { + "$ref": "#/components/schemas/estado" + }, + "ciudad": { + "$ref": "#/components/schemas/ciudad" + }, + "entidad": { + "$ref": "#/components/schemas/entidad" + } + }, + "xml": { + "name": "cuenta" + } + }, + "razon": { + "type": "object", + "properties": { + "codigo": { + "type": "string", + "description": "Codigo de razon." + } + }, + "xml": { + "name": "razon" + } + }, + "puntuacion": { + "type": "object", + "properties": { + "valor": { + "type": "string", + "description": "Valor del puntuacion o score." + }, + "tipo": { + "type": "string", + "description": "Tipo de puntuacion o score." + }, + "razon": { + "type": "array", + "items": { + "$ref": "#/components/schemas/razon" + } + } + }, + "xml": { + "name": "puntuacion" + } + }, + "genero": { + "type": "object", + "properties": { + "codigo": { + "type": "string", + "description": "Codigo del genero." + } + }, + "xml": { + "name": "genero" + } + }, + "departamento": { + "type": "object", + "properties": { + "nombre": { + "type": "string", + "description": "Nombre del departamento." + } + }, + "xml": { + "name": "departamento" + } + }, + "ciudad": { + "type": "object", + "properties": { + "ciudad": { + "type": "string", + "description": "Nombre de la ciudad." + } + }, + "xml": { + "name": "ciudad" + } + }, + "direccion": { + "type": "object", + "properties": { + "departamento": { + "$ref": "#/components/schemas/departamento" + }, + "ciudad": { + "$ref": "#/components/schemas/ciudad" + } + }, + "xml": { + "name": "direccion" + } + }, + "documento": { + "type": "object", + "properties": { + "numero": { + "type": "string", + "description": "Numero de documento." + }, + "fecha": { + "type": "string", + "format": "date-time", + "description": "fecha de expedicion del documento." + }, + "vigencia": { + "type": "string", + "description": "Vigencia del documento." + } + }, + "xml": { + "name": "documento" + } + }, + "nombre": { + "type": "object", + "properties": { + "primero": { + "type": "string", + "description": "Primer nombre." + }, + "segundo": { + "type": "string", + "description": "segundo nombre." + }, + "primerApellido": { + "type": "string", + "description": "Primer apellido." + }, + "segundoApellido": { + "type": "string", + "description": "Segundo apellido." + }, + "completo": { + "type": "string", + "description": "Nombre completo." + } + }, + "xml": { + "name": "nombre" + } + }, + "informacionPersonal": { + "type": "object", + "properties": { + "nombre": { + "$ref": "#/components/schemas/nombre" + }, + "documento": { + "$ref": "#/components/schemas/documento" + }, + "direccion": { + "$ref": "#/components/schemas/direccion" + }, + "genero": { + "$ref": "#/components/schemas/genero" + } + }, + "xml": { + "name": "informacionPersonal" + } + }, + "obtenerHistoriaCredito": { + "type": "object", + "properties": { + "independiente": { + "type": "boolean", + "description": "Indica si la persona es independiente." + }, + "validada": { + "type": "boolean", + "description": "True si esta validado contra la registraduría, false si esta validado contra otras fuentes de información, lo cual incluye otros suscriptores." + }, + "edadMinima": { + "type": "string", + "description": "Edad minima." + }, + "edadMaxima": { + "type": "string", + "description": "Edad maxima." + }, + "fechaConsulta": { + "type": "string", + "format": "date-time", + "description": "Fecha en que se realiza la consulta." + }, + "informacionPersonal": { + "$ref": "#/components/schemas/informacionPersonal" + }, + "puntuacion": { + "$ref": "#/components/schemas/puntuacion" + }, + "cuenta": { + "type": "array", + "items": { + "$ref": "#/components/schemas/cuenta" + } + }, + "obligacion": { + "type": "array", + "items": { + "$ref": "#/components/schemas/obligacion" + } + }, + "endeudamiento": { + "type": "array", + "items": { + "$ref": "#/components/schemas/endeudamiento" + } + }, + "consulta": { + "type": "array", + "items": { + "$ref": "#/components/schemas/consulta" + } + } + }, + "xml": { + "name": "obtenerHistoriaCredito" + } + }, + "consultaHistoriaCreditoNaturalResponse": { + "type": "object", + "required": [ + "resultado" + ], + "properties": { + "resultado": { + "type": "array", + "xml": { + "name": "resultado" + }, + "items": { + "$ref": "#/components/schemas/resultado" + } + }, + "obtenerHistoriaCredito": { + "type": "array", + "items": { + "$ref": "#/components/schemas/obtenerHistoriaCredito" + } + } + } }, - "getSolicitudesCreditoResponse": { + "getSolicitudesCreditoResponse": { "type": "object", "required": [ "resultado" -- libgit2 0.26.0