Este Web Service, es uno de los fundamentales de este grupo de API’s RESTfuldebido a que el mismo permite la consulta, el ingreso o la actualización de préstamos, incluyendo todos sus datos claves. Además de quedar registrado en la Aplicación SIFCO WEB, como un préstamo en estado pendiente. Adicionalmente se debe indicar que las opciones de Consulta, Ingreso o Actualización depende del parámetro Modo.
...
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: "WSIngresarClientes" externalDocs: description: "Manual SIFCO" url: "https://sifco.atlassian.net/wiki/x/9ISo" produces: - application/json paths: /WSIngresarPrestamo: post: tags: - WSIngresarPrestamo operationId: "WSIngresarPrestamo" summary: "WSIngresar Prestamo" parameters: - name: "WSIngresarPrestamoInput" in: "body" required: false schema: $ref: "#/definitions/WSIngresarPrestamoInput" responses: 200: description: "Successful operation" schema: $ref: "#/definitions/WSIngresarPrestamoOutput" 404: description: "Not found" 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: WSIngresarPrestamoInput: properties: Modo: type: "string" ConsultaNumero: type: "string" Prestamo: description: WSCr Prestamo_SDT $ref: "#/definitions/WSCrPrestamo_SDT" WSCrPrestamo_SDT: properties: PreEmpCodigo: description: Código de Empresa del Préstamo type: "integer" format: "int32" PreSucCodigo: description: Código de Sucursal del Préstam type: "integer" format: "int32" PreSoCrNumero: description: Número Solicitud type: "integer" format: "int64" PrePrdCod: description: Código del Producto en Préstam type: "integer" format: "int32" ApColCod: description: Código SubProducto Colocacion type: "integer" format: "int32" PreMonedaCod: description: Moneda en que se concedio el credito 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 Correspond type: "integer" format: "int64" PreDirCor: description: Correlativo de Dirección Clien type: "integer" format: "int32" PrePrmCod: description: Código de Promotor del Préstam type: "string" PreAprCod: description: Código Aprobación Préstamo type: "integer" format: "int32" PreGarCod: description: Código Garantía Préstamo type: "integer" format: "int32" ApOrgCod: description: Código de Origen de Fondos type: "integer" format: "int32" PreFecAprobacion: description: Fecha Aprobación del Crédito type: "string" format: "date" PreFecConcesion: description: Fecha de Concesión del Préstam 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" PrePaiCod: description: Pais Inversión Préstamo type: "integer" format: "int64" PreRegCod: description: Región Inversión Préstamo type: "integer" format: "int64" PreDepCod: description: Departamento Inversión Préstam type: "integer" format: "int64" PreMunCod: description: Municipio Inversión Préstamo type: "integer" format: "int64" 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" PreTasaFoV: description: Tipo de Tasa del Préstamo type: "string" PreTasaBase: description: Tasa Base Asiganda 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 Interes x Mora type: "number" format: "double" PreFacPlazo: description: Factor del Plazo type: "integer" format: "int32" 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" PreFreICod: description: Frecuencia Pago Intereses Prés 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" 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" ApCaCCod: description: Código de Categoría de Crédito type: "integer" format: "int32" ApEstCod: description: Código 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 Interes 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éstam type: "string" PreReferencia: description: No. Referencia del Ptmo type: "string" PreAnulado: description: Prestamo Fue Anulado type: "string" CrCiclo: description: Ciclo del prestamo 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: Codigo de mensaje type: "integer" format: "int64" PreTipoCredito: description: Es crédito normal, novado o refinanciado type: "integer" format: "int32" PreNumeroRefinanciamiento: description: Número de préstamo de refinanciamiento type: "string" PreMontoCapitalRefinanciamiento: description: Monto capital refinanciamiento type: "number" format: "double" PreMontoInteresRefinanciamiento: description: Monto interes refinanciamiento type: "number" format: "double" PreMontoOtrosRefinanciamiento: description: Monto otros refinanciamiento type: "number" format: "double" PreIntDevengado: description: Monto interes devengado mes anterior type: "number" format: "double" WSIngresarPrestamoOutput: properties: PrestamoNumero: type: "string" PrestamoInfo: description: WSCr Prestamo_SDT $ref: "#/definitions/WSCrPrestamo_SDT" Messages: description: Messages type: array items: $ref: "#/definitions/Messages_Message" Result: type: "string" Messages_Message: properties: Id: description: Id type: "string" Type: description: Type type: "integer" format: "int32" Description: description: Description type: "string" GxJsonError: properties: error: $ref: "#/definitions/GxJsonError.error" GxJsonError.error: properties: code: type: "string" message: type: "string" x-gx-level: "GxJsonError" |
Modelo de Datos de este Web Service | Web Service a Constantes del Sistema Relacionados |
---|---|
WSIngresarPrestamoInput | |
Modo | Constantes asociadas a variables preestablecidas por la Aplicación SIFCO WEB. |
ConsultaNumero | Número de préstamo a visualizar o actualizar. Al ingresar no llenar esta información. |
WSIngresarPrestamoInput >WSCrPrestamo_SDT | |
PreEmpCodigo | Código de Empresa del Préstamo |
PreSucCodigo | Código de Sucursal del Préstamo |
PrePrdCod | Código del Producto en Préstamo |
ApColCod | Código SubProducto Colocación |
PreMonedaCod | Moneda en que se concedió el crédito |
PreCliCod | Código Cliente |
PreDirCor | Correlativo de Dirección Cliente |
PreAprCod | Código Aprobación Préstamo |
PreGarCod | Código Garantía Préstamo |
ApOrgCod | Código de Origen de Fondos |
PreGrDCod | Gran División Destino Préstamo |
PrePaiCod | Pais Inversión Préstamo |
PreRegCod | Región Inversión Préstamo |
PreDepCod | Departamento Inversión Préstamo |
PreMunCod | Municipio Inversión Préstamo |
CupNumero | Código del Cupo |
PreFacPlazo | Factor del Plazo |
PreFreCCod | Frecuencia Pago Capital |
PreFreCPlanilla | Frecuencia Pago Planilla |
PreCtaNumero | Número Cuenta Captaciones |
ApCaCCod | Código de Categoría de Crédito |
ApEstCod | Código de Estado |
PreUsuCod | Usuario que Ingresa Préstamo |
PreUsuMod | Usuario que Modificó Préstamo |
PreNumeroRefinanciamiento | Número de préstamo de refinanciamiento |
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 POST
Este método para este Web Service en especifico permite la Creación de Prestamos en la Aplicación SIFCO WEB.
A continuación se mostraran tres ejemplos de uso de este Web Service, uno para cada valor del parámetro Modo, dado a su relevancia para este Web Service en particular.
EJEMPLO #1
El siguiente ejemplo consulta los datos de un cliente en la Aplicación SIFCO WEB, con el Parámetro Modo : “DSP“
Tipo de Mensaje HTTP
Ejemplo
REQUEST
URL:
Code Block | ||
---|---|---|
| ||
https://test.sifco.org/democoopgt/rest/WSIngresarPrestamo |
HEADERS:
Code Block | ||
---|---|---|
| ||
content-type: application/json
authorization: OAuth f2a9ec34-cf83-46f5-8862-f78........
genexus-agent: SmartDevice Application |
BODY:
Code Block | ||
---|---|---|
| ||
{
"Modo": "DSP",
"ConsultaNumero":"01011102038142",
"Prestamo":{}
} |
200 (Successful operation)
Operación Exitosa
Code Block | ||
---|---|---|
| ||
{
"PrestamoNumero": "01011102038142",
"PrestamoInfo": {},
"Messages": [],
"Result": ""
} |
400 (Bad Request).
Solicitud ErradaPrestamoInversionistas | Código del cliente en SIFCO |
PrestamoInversionistaPorcentajeMonto | Monto asignado al inversionista |
PrestamosInversionistasPromotorPorcentaje | % de Comisión Externa |
PrestamosInversionistasAgentePorcentaje | % Gestión del Préstamo |
PrestamosInversionistasContratoFlexible | ¿Tiene un contrato flexible?: |
CuentaRelacionadaClCliCod | Código del Cliente (Deudor, Codeudor) |
CuentaRelacionadaClNomSocio | Nombre del Cliente (Deudor, Codeudor) |
CuentaRelacionadaClReferencia | Referencia |
CuentaRelacionadaClCtaTipo | Tipo de Relación |
CuentaRelacionadaClCtaMonto | Monto del Crédito Asignado |
CuentaRelacionadaClNumID | Número de Identificación Cliente (Deudor, Codeudor) |
CuentaRelacionadaClCtaReferencia | No. Cuenta de Referencia |
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 POST
Este método para este Web Service en especifico permite la Creación de Prestamos en la Aplicación SIFCO WEB.
A continuación se mostraran tres ejemplos de uso de este Web Service, uno para cada valor del parámetro Modo, dado a su relevancia para este Web Service en particular.
EJEMPLO #1
El siguiente ejemplo consulta los datos de un cliente en la Aplicación SIFCO WEB, con el Parámetro Modo : “DSP“
Info |
---|
Información de campos “CuentaRelacionadaClCtaTipo“ |
NOMBRE | VALOR |
---|---|
Cliente Principal | P |
Cliente Mancomunado | M |
Dueño del Crédito | D |
Codeudor | C |
Fiador | F |
DeudorFactoring | G |
Tipo de Mensaje HTTP
Ejemplo
REQUEST
URL:
Code Block | ||
---|---|---|
| ||
https://test.sifco.org/democoopgt/rest/WSIngresarPrestamo |
HEADERS:
Code Block | ||
---|---|---|
| ||
content-type: application/json
authorization: OAuth f2a9ec34-cf83-46f5-8862-f78........
genexus-agent: SmartDevice Application |
BODY:
language | json |
---|
Tipo de Mensaje HTTP | Ejemplo | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
REQUEST | URL:
HEADERS:
BODY:
| |||||||||||||||
200 (Successful operation) Operación Exitosa |
| 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)
EJEMPLO #2
El siguiente ejemplo inserta un préstamo en la Aplicación SIFCO WEB, con el Parámetro Modo : “INS”
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
200 (Successful operation)
Operación Exitosa
language | json |
---|
|
|
|
|
|
|
|
|
|
|
|
400 (Bad Request).
Solicitud Errada
language | json |
---|
|
|
|
|
|
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) ).
language | json |
---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
404 (Not Found).
EJEMPLO #3
El siguiente ejemplo consulta los datos de un préstamo en la Aplicación SIFCO WEB, con el Parámetro Modo : “UPD“
Tipo de Mensaje HTTP
Ejemplo
REQUEST
URL:
Code Block | ||
---|---|---|
| ||
https://test.sifco.org/democoopgt/rest/WSIngresarPrestamo |
HEADERS:
Code Block | ||
---|---|---|
| ||
content-type: application/json
authorization: OAuth f2a9ec34-cf83-46f5-8862-f78........
genexus-agent: SmartDevice Application |
BODY:
language | json |
---|
| ||||||
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) |
EJEMPLO #2
El siguiente ejemplo inserta un préstamo en la Aplicación SIFCO WEB, con el Parámetro Modo : “INS”
Tipo de Mensaje HTTP | Ejemplo | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
REQUEST | URL:
HEADERS:
BODY:
| |||||||||||||||
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) |
EJEMPLO #3
El siguiente ejemplo consulta los datos de un préstamo en la Aplicación SIFCO WEB, con el Parámetro Modo : “UPD“
Tipo de Mensaje HTTP | Ejemplo | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
REQUEST | URL:
HEADERS:
BODY:
| |||||||||||||||
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) |
...