Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
DESCRIPCIÓN.
Este Web Service, permite Consultar todos los detalles de un Crédito registrado en la Aplicación SIFCO WEB. El mismo trae un conjunto de parámetros que permiten obtener toda la información que se requiera de un crédito, tanto a nivel del cliente, como detalles financieros (Moneda, Monto, Capital, Intereses, Plazos, Ubicación Geográfica, Garantías, Tasas, Frecuencias, Vencimientos, etc.) del mismo. Por ello es importante consumir los Web Service de Web Services
para el Manejo de Prestamosde Consulta de Categorías Generales, para poder comprender todos los parámetros obtenidos con esta consulta.
Swagger open api macro |
---|
swagger: '2.0'
info:
title: "SIFCO_REST_API"
version: "1.0"
termsOfService: "https://sifco.org/sobre-nosotros/"
contact:
email: "soporte@sifco.org"
license:
name: "Apache 2.0"
url: "http://www.apache.org/licenses/LICENSE-2.0.html"
host: "<SERVER>"
schemes:
- https
- http
basePath: /<APPDIR>/rest
tags:
- name: "TCrPrestamos"
externalDocs:
description: "Manual SIFCO"
url: "https://sifco.atlassian.net/wiki/x/GoDW"
produces:
- application/json
paths:
/TCrPrestamos/{PreNumero}:
get:
tags:
- TCrPrestamos
operationId: "GetTCrPrestamos"
summary: "Consultas de Manejo de Prestamos"
parameters:
- in: header
name: Content-Type
type: "string"
required: true
default: application/json
- in: header
name: Authorization
type: "string"
required: true
default: OAuth <Access Token>
- in: header
name: GENEXUS-AGENT
type: "string"
required: true
default: SmartDevice Application
- name: "PreNumero"
in: "path"
description: "Número del Préstamo"
required: true
type: "string"
responses:
200:
description: "Successful operation"
schema:
$ref: "#/definitions/TCrPrestamos"
401:
description: "Not Authenticated"
schema:
$ref: "#/definitions/GxJsonError"
404:
description: "Not found"
schema:
$ref: "#/definitions/GxJsonError"
400:
description: "Bad request"
schema:
$ref: "#/definitions/GxJsonError"
500:
description: "Internal server error"
schema:
$ref: "#/definitions/GxJsonError"
security:
- OAuth2: []
ApiKeyAuth1: []
securityDefinitions:
OAuth2:
type: oauth2
flow: password
tokenUrl: https://test.sifco.org/DemoCoopGT/oauth/access_token
scopes:
Execute: Permite el método tipo GET
Insert: Permite el método tipo POST
Update: Permite el método tipo PUT
Delete: Permite el método tipo DELETE
FullControl: Permite el manejo de los Cuatro Métodos GET, POST, PUT,DELETE, sobre el Web Service
ApiKeyAuth1:
type: apiKey
in: header
name: granttype
definitions:
TCrPrestamos:
properties:
PreNumero:
description: Número del Préstamo
type: "string"
PreEmpCodigo:
description: Código de Empresa del Préstamo
type: "integer"
format: "int32"
PreSucCodigo:
description: Código de Sucursal del Préstamo
type: "integer"
format: "int32"
PreSoCrNumero:
description: Número Solicitud
type: "integer"
format: "int64"
PrePrdCod:
description: Código del Producto en Préstamo
type: "integer"
format: "int32"
PrePrdNombre:
description: Nombre Producto en Préstamos
type: "string"
PrePrdTipo:
description: Tipo Producto
type: "integer"
format: "int32"
ApColCod:
description: Código SubProducto Colocación
type: "integer"
format: "int32"
ApColDes:
description: Descripción SubProducto Coloca
type: "string"
ApColAport:
description: Calculo sobre aportaciones
type: "string"
ApColVeces:
description: Cant. Veces S/Saldo Aportación
type: "number"
format: "double"
ApColMontMaximo:
description: Monto Máximo Crédito
type: "number"
format: "double"
ApColTasaFoV:
description: Tasa Fija o Variable
type: "string"
ApColFacPlazo:
description: Factor de Plazo
type: "integer"
format: "int32"
ApColPlazo:
description: Plazo Máximo
type: "integer"
format: "int32"
ApMonCod:
description: Código Moneda
type: "integer"
format: "int32"
ApMonNombre:
description: Nombre Moneda
type: "string"
ApMonSimbolo:
description: Símbolo
type: "string"
ApColTMin:
description: Tasa Mínima Permitida
type: "number"
format: "double"
ApColTMax:
description: Tasa Máxima Permitida
type: "number"
format: "double"
ApColEstado:
description: Estado del Producto de Crédito
type: "boolean"
PreMonedaCod:
description: Moneda en que se concedió el crédito
type: "integer"
format: "int32"
PreMonedaNombre:
description: Nombre moneda
type: "string"
PreMonedaSimbolo:
description: Símbolo de moneda
type: "string"
ApColTCInt:
description: Tasa de Interés Corriente
type: "integer"
format: "int32"
ApColTCMora:
description: Tasa de Interés Mora
type: "integer"
format: "int32"
ApColTNInt:
description: Nombre de Tasa Interés Corriente
type: "string"
ApColTNMora:
description: Nombre Tasa Interés Mora
type: "string"
ApColMes:
description: Tipo Mes de Cálculo
type: "integer"
format: "int32"
ApColAno:
description: Tipo Aí±o de Cálculo
type: "integer"
format: "int32"
PreCorrelativo:
description: Correlativo del préstamo
type: "integer"
format: "int64"
PreNombre:
description: Nombre del Préstamo
type: "string"
PreCliCod:
description: Código Cliente para Correspondencia
type: "integer"
format: "int64"
PreCliNom:
description: Nombre Cliente para Correspondencia
type: "string"
PreCliPromotor:
description: Promotor de Cliente
type: "string"
PreDirCor:
description: Correlativo de Dirección Cliente
type: "integer"
format: "int32"
PreDirTipo:
description: Tipo Dirección
type: "integer"
format: "int32"
PreDirDir1:
description: Dirección Préstamo
type: "string"
PrePrmCod:
description: Código de Promotor del Préstamo
type: "string"
PrePrmNombre:
description: Nombre de Promotor del Préstamo
type: "string"
PreAprCod:
description: Código Aprobación Préstamo
type: "integer"
format: "int32"
PreAprDes:
description: Descripción Aprobación Préstamo
type: "string"
PreAprLimites:
description: Tiene Limites
type: "string"
PreAprMinimo:
description: Monto Mínimo
type: "number"
format: "double"
PreAprMaximo:
description: Monto Máximo
type: "number"
format: "double"
PreGarCod:
description: Código Garantía Préstamo
type: "integer"
format: "int32"
PreGarDes:
description: Descripción Garantía Préstamo
type: "string"
ApOrgCod:
description: Código de Origen de Fondos
type: "integer"
format: "int32"
ApOrgDes:
description: Descripción de Origen de Fondo
type: "string"
PreFecAprobacion:
description: Fecha Aprobación del Crédito
type: "string"
format: "date"
PreFecConcesion:
description: Fecha de Concesión del Préstamo
type: "string"
format: "date"
PreFecEscritura:
description: Fecha de Escrituración
type: "string"
format: "date"
PreGrDCod:
description: Gran División Destino Préstamo
type: "integer"
format: "int32"
PreGrDDes:
description: Descripción Gran División Préstamo
type: "string"
PrePaiCod:
description: País Inversión Préstamo
type: "integer"
format: "int64"
PrePaiNom:
description: Descripción País Préstamo
type: "string"
PreRegCod:
description: Región Inversión Préstamo
type: "integer"
format: "int64"
PreRegDes:
description: Descripción Región Préstamo
type: "string"
PreDepCod:
description: Departamento Inversión Préstamo
type: "integer"
format: "int64"
PreDepDes:
description: Descripción Departamento Préstamo
type: "string"
PreMunCod:
description: Municipio Inversión Préstamo
type: "integer"
format: "int64"
PreMunDes:
description: Descripción Municipio Préstamo
type: "string"
PreMonOriginal:
description: Monto Original del Crédito
type: "number"
format: "double"
PreMonTotal:
description: Monto Total Otorgado Crédito
type: "number"
format: "double"
CupNumero:
description: Código del Cupo
type: "integer"
format: "int64"
CupMonDisponible:
description: Monto Disponible del Cupo
type: "number"
format: "double"
CupFecVencimiento:
description: Fecha de Vencimiento del Cupo
type: "string"
format: "date"
CupDespVence:
description: Permite Cambio Después Fecha de Vencimiento
type: "string"
CupObligatorio:
description: Cupo Obligatorio
type: "integer"
format: "int64"
PreTasaFoV:
description: Tipo de Tasa del Préstamo
type: "string"
PreTasaBase:
description: Tasa Base Asignada al Préstamo
type: "number"
format: "double"
PreBaseMora:
description: Tasa Base Mora del Préstamo
type: "number"
format: "double"
PreSpreCorr:
description: Tasa Spread de Interés
type: "number"
format: "double"
PreSpreMora:
description: Tasa Spread de Interés x Mora
type: "number"
format: "double"
PreFacPlazo:
description: Factor del Plazo
type: "integer"
format: "int32"
PrePeriodoFrecuencia:
description: Periodo de Frecuencia
type: "string"
PreNumeroPeriodos:
description: Numero de Periodos
type: "integer"
format: "int32"
PreFacPlazoDescripcion:
description: Descripción del Factora del plazo
type: "string"
PrePlazo:
description: Plazo del Préstamo
type: "integer"
format: "int32"
PreFecVencimiento:
description: Fecha de Vencimiento Crédito
type: "string"
format: "date"
PreTipCom:
description: Tipo de Compromiso
type: "integer"
format: "int32"
PreFreCCod:
description: Frecuencia Pago Capital
type: "integer"
format: "int32"
PreFreCDes:
description: Descripción Frecuencia Pago Capital
type: "string"
PreFreCPeriodo:
description: Tipo de Periodo Frecuencia
type: "string"
PreFreCNumeroPeriodos:
description: Numero de Periodos
type: "integer"
format: "int32"
PreFreICod:
description: Frecuencia Pago Intereses Préstamo
type: "integer"
format: "int32"
PreFreIDes:
description: Descripción Frecuencia Pago In
type: "string"
PreFreIPeriodo:
description: Tipo de Periodo Frecuencia
type: "string"
PreFreINumeroPeriodos:
description: Numero de Periodos
type: "integer"
format: "int32"
PreFec1Cap:
description: Fecha Primer Pago de Capital
type: "string"
format: "date"
PreFec1Int:
description: Fecha Primer Pago de Intereses
type: "string"
format: "date"
PreDiaPago:
description: Día de Pago
type: "integer"
format: "int32"
PreFreCPlanilla:
description: Frecuencia Pago Planilla
type: "integer"
format: "int32"
PreFreDPlanilla:
description: Descripción Pago Planilla
type: "string"
PreNumCuotas:
description: Número de Cuotas Préstamo
type: "integer"
format: "int32"
PreValCuota:
description: Valor de la Cuota
type: "number"
format: "double"
PreCuotaDefinidaUsuario:
description: Cuota Definida por el Usuario
type: "number"
format: "double"
PreForDes:
description: Forma de Desembolso Crédito
type: "integer"
format: "int32"
PrePrimerDesembolso:
description: Fecha de Primer Desembolso
type: "string"
format: "date"
PreForPago:
description: Forma de Pago
type: "integer"
format: "int32"
PreAsigBoleta:
description: Asigna Boleta si o no
type: "string"
PreCtaNumero:
description: Número Cuenta Captaciones
type: "string"
PreCtaNombre:
description: Nombre Cuenta Captaciones
type: "string"
PreCtaEstado:
description: Estado Actual Cta Captaciones
type: "integer"
format: "int32"
PreCtaInactiva:
description: Activa/Inactiva Cta Captaciones
type: "string"
ApCaCCod:
description: Código de Categoríaa de Crédito
type: "integer"
format: "int32"
ApCaCDes:
description: Descripción de Categoría de Crédito
type: "string"
ApEstCod:
description: Código de Estado
type: "string"
ApEstDes:
description: Descripción de Estado
type: "string"
PreFecModulo:
description: Fecha Creación según modulo
type: "string"
format: "date"
PreFecAdicion:
description: Fecha Ingreso Crédito
type: "string"
format: "date"
PreUsuCod:
description: Usuario que Ingresa Préstamo
type: "string"
PreFecModificacion:
description: Fecha de Modificación Préstamo
type: "string"
format: "date"
PreUsuMod:
description: Usuario que Modificó Préstamo
type: "string"
PreFecPCap:
description: Fecha Próximo Pago de Capital
type: "string"
format: "date"
PreFecPInt:
description: Fecha Próximo Pago de Interese
type: "string"
format: "date"
PreFecUCap:
description: Fecha Ultimo Pago de Capital
type: "string"
format: "date"
PreFecUInt:
description: Fecha Ultimo Pago de Intereses
type: "string"
format: "date"
PreMarDesembolsar:
description: Margen por Desembolsar
type: "number"
format: "double"
PreSusInts:
description: Tiene Suspensión de Intereses
type: "string"
PreFecSuspension:
description: Fecha de Suspensión de Interés
type: "string"
format: "date"
PreSalCapital:
description: Saldo de Capital
type: "number"
format: "double"
PreCapAtrasado:
description: Capital Atrasado
type: "number"
format: "double"
PreIntMes:
description: Intereses del Mes
type: "number"
format: "double"
PreIntAcumulado:
description: Interés Acumulado
type: "number"
format: "double"
PreIntVencido:
description: Interés Vencido
type: "number"
format: "double"
PreIntAnticipado:
description: Interés Anticipado
type: "number"
format: "double"
PreIntMora:
description: Intereses Moratorios
type: "number"
format: "double"
PreUltGar:
description: Ultimo Correlativo Garantías
type: "integer"
format: "int32"
PreUltPri:
description: Ultimo Correlativo Prima Segur
type: "integer"
format: "int32"
PreUltCam:
description: Ultimo Correlativo Cambio Comp
type: "integer"
format: "int64"
PreUltAbo:
description: Ultimo Abono Extraordinario
type: "integer"
format: "int64"
PreNumCont:
description: Número de Contrato del Préstamo
type: "string"
PreReferencia:
description: No. Referencia del Préstamo
type: "string"
PreAnulado:
description: Préstamo Fue Anulado
type: "string"
CrCiclo:
description: Ciclo del Préstamo grupal
type: "integer"
format: "int64"
CrDiasGracia:
description: Dias de gracia otorgados
type: "integer"
format: "int32"
CrDiasPGracia:
description: Dias de gracia pendientes
type: "integer"
format: "int32"
PreComentario:
description: Comentario Opcional
type: "string"
PreEstado:
description: Estado de Crédito
type: "boolean"
PreMensaje:
description: Código de mensaje
type: "integer"
format: "int64"
PreTipoCredito:
description: Es crédito normal, renovado o refinanciado
type: "integer"
format: "int32"
PreNumeroRefinanciamiento:
description: Número de préstamo de refinanciamiento
type: "string"
PreNombreRefinanciamiento:
description: Nombre del préstamo de refinanciamiento
type: "string"
PreMontoCapitalRefinanciamiento:
description: Monto capital refinanciamiento
type: "number"
format: "double"
PreMontoInteresRefinanciamiento:
description: Monto interés refinanciamiento
type: "number"
format: "double"
PreMontoOtrosRefinanciamiento:
description: Monto otros refinanciamiento
type: "number"
format: "double"
PreIntDevengado:
description: Monto interés devengado mes anterior
type: "number"
format: "double"
gx_md5_hash:
description: gx_md5_hash is an identifier for a specific version of a resource, it is used for optimistic concurrency check. It is required for update and delete operations and ignored on insert.
type: "string"
required:
- PreNumero
GxJsonError:
properties:
error:
$ref: "#/definitions/GxJsonError.error"
GxJsonError.error:
properties:
code:
description: Código de Error
type: "string"
message:
description: Mensaje de Error
type: "string"
x-gx-level: "GxJsonError" |
RELACIONES ENTRE EL MODELO DE DATOS DE ESTE WEB SERVICE, Y EL RESTO DEL API’s RESTful DE LA APLICACIÓN SIFCO WEB.
Modelo de Datos de este Web Service | Web Service a Constantes del Sistema Relacionados |
---|---|
TCrPrestamos | |
PrePaiCod | |
PreRegCod | |
PreDepCod |
EJEMPLOS DE REQUEST Y RESPONSE, PARA LOS SERVICIOS RESTful BAJO PROTOCOLO HTTP.
A continuación se muestra una tabla con un ejemplo de una Solicitud y un Respuesta para este Web Service.
METODO GET
Este método para este Web Service en especifico permite consultar todos los detalles de un Crédito registrado en la Aplicación SIFCO WEB.
El siguiente ejemplo permite consultar todos los detalles de un Crédito registrado en la Aplicación SIFCO WEB.
Tipo de Mensaje HTTP | Ejemplo | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
REQUEST | URL:
HEADERS
| ||||||||||
200 (Successful operation) Operación Exitosa |
| ||||||||||
400 (Bad Request). Solicitud Errada |
| ||||||||||
401 (This service needs an Authorization Header) (No Autenticado, asociado normalmente a que no se respetaron las cabeceras obligatorias para el consumo de este Web Service, para mayores detalles consultar (Configuración de Seguridad para Obtener Token de Acceso y Consumir de los Web Services) ). |
| ||||||||||
404 (Not Found). | Respuesta Vacía (Web Service, no encontrado) | ||||||||||
500 (Internal Server Error) (Error Interno del Servidor de las API’s REST). |
|
Info |
---|
INFORMACIÓN Para identificar el MENSAJE DE ERROR remitirse a la pagina de (Listado de Mensajes), donde se describe el listado de mensajes que arroja las API’s REST de la Aplicación SIFCO WEB, con su respectiva Descripción. |
Note |
---|
NO DEBE OLVIDAR NO olvide tomar en cuenta para el uso de este Web Service, el Flujo de Trabajo descrito en Web Services de Créditos, dado a que en caso de no seguirlo al pie de la letra puede generar errores inesperados en la ejecución. |
Note |
---|
RESPETE LOS ENCABEZADOS OBLIGATORIOS para que pueda consumir el WEB SERVICE respectivo. |
Code Block | ||
---|---|---|
| ||
Content-Type: application/json Authorization: OAuth f2a9ec34-cf83-46f5-8862-f78ac03670d1!171380a787a9152688ab61a94d66e0eb77... GENEXUS-AGENT: SmartDevice Application |
Warning |
---|
EN CASO DE ERROR HTTP 401 (Not Authenticated) Por favor validar que esta colocando los Encabezados Adecuadamente, y de persistir el problema dirigirse a la Pagina (Configuración de Seguridad para Obtener Token de Acceso y Consumir de los Web Services), para generar nuevamente su Token de Acceso, y/o verificar problemas con su acceso al API REST. |
| ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Enlaces Relevantes | ||||||||||||
Artículos Relacionados
| ||||||||||||
Artículos Actualizados Recientemente
|
|