Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
DESCRIPCIÓN.
Este Web Service, permite cargar una Planilla de Solicitud de Pago Grupal en la Aplicación SIFCO WEB. Esto solo carga los montos y detalles del crédito para su cancelación, mas el Pago debe ser Aprobado Manualmente desde la Aplicación SIFCO WEB, o Aplicado a través del WS PCrGrPagoGrupal.
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: "PInsSoliGrupo" externalDocs: description: "Manual SIFCO" url: "https://sifco.atlassian.net/wiki/x/RQCx" produces: - application/json paths: /PInsSoliGrupo: post: tags: - PInsSoliGrupo operationId: "PInsSoliGrupo" summary: "Web Services para Crear Solicitud de Pago Grupal" 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: "PInsSoliGrupoInput" in: "body" required: false schema: $ref: "#/definitions/PInsSoliGrupoInput" responses: 200: description: "Successful operation" schema: $ref: "#/definitions/PInsSoliGrupoOutput" 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: PInsSoliGrupoInput: properties: ApEmpCod: description: Código de Empresa type: "integer" format: "int32" ApSucCod: description: Código de Sucursal type: "integer" format: "int32" SoCrNumero: description: Numero de Préstamo type: "integer" format: "int64" GrAfCodigo: typedescription: "integer" Código de Grupo de Afiliación formattype: "int64integer" format: "int64" GrAfCiclo: description: Ciclo de Grupo de Afiliación type: "integer" format: "int64" ApPrmCod: typedescription: "string"Código de Préstamo ApPrdCod: type: "integerstring" ApPrdCod: format: "int32" description: Código de ApColCod:Producto type: "integer" format: "int32" SoCrFechaApColCod: typedescription: "string" Código SubProducto Colocación formattype: "dateinteger" SoCrFecFormalizacion format: "int32" SoCrFecha: description: Fecha de Crédito type: "string" format: "date" SoCrReferenciaSoCrFecFormalizacion: typedescription: "string"Fecha de Formalizacion del Crédito SoCrMonSolicitado: type: "numberstring" format: "doubledate" SoCrMonAutorizadoSoCrReferencia: typedescription: "number"Referencia formattype: "doublestring" SoCrTasaFoVSoCrMonSolicitado: typedescription: "string" SoCrTasaBase:Monto Solicitado type: "number" format: "double" SoCrSpreCorrSoCrMonAutorizado: typedescription: "number"Monto Autorizado formattype: "doublenumber" SoCrBaseMora format: "double" type: "number"SoCrTasaFoV: formatdescription: "double"Tasa Fija o Variable SoCrSpreMora: type: "numberstring" SoCrTasaBase: format: "double" description: Tasa SoCrFacPlazo:Base type: "integernumber" format: "int32double" SoCrPlazoSoCrSpreCorr: typedescription: "integer"Correlativo de Spread format: "int32" SoCrDiasGracia:de Crédito type: "integernumber" format: "int32double" SoCrFecVencimientoSoCrBaseMora: typedescription: "string"Base de Mora del Crédito formattype: "datenumber" SoCrTipComformat: "double" typeSoCrSpreMora: "integer" formatdescription: "int32"Spread de Interés x Mora del SoCrFreCCod:Crédito type: "integernumber" format: "int32double" SoCrFreICodSoCrFacPlazo: description: Factor de Plazo del Crédito type: "integer" format: "int32" SoCrPlazo: SoCrFecCap description: Plazo de Crédito type: "stringinteger" format: "dateint32" SoCrFecIntSoCrDiasGracia: typedescription: "string" Días de Gracia formattype: "dateinteger" SoCrFormaPagoformat: "int32" typeSoCrFecVencimiento: "integer" formatdescription: "int32"Fecha de Vencimiento de Crédito PreFreCPlanilla: type: "integerstring" format: "int32date" BaCtaCodPagoSoCrTipCom: typedescription: "integer" Tipo de Compromiso formattype: "int64integer" ApAprCod format: "int32" typeSoCrFreCCod: "integer" formatdescription: "int32"Código de Frecuencia de Pago a Capital FecAprobacion: type: "stringinteger" format: "dateint32" ApGarCodSoCrFreICod: typedescription: "integer"Código de Frecuencia de Pago Intereses a Préstamo format: "int32" ApOrgCod: type: "integer" format: "int32" TipoDesemSoCrFecCap: typedescription: "integer" Fecha de Pago a Capital formattype: "int32string" BaCtaCodformat: "date" typeSoCrFecInt: "integer" formatdescription: "int64"Fecha de Pago de Interes ApGrDCod: type: "integerstring" format: "int32date" ApAcDCodSoCrFormaPago: typedescription: "integer"Forma de Pago format: "int32" del Crédito ApAgrCod: type: "integer" format: "int32" ApTGaCodPreFreCPlanilla: typedescription: "integer" Frecuencia Pago Planilla formattype: "int32integer" ApGruCod format: "int32" type: "integer"BaCtaCodPago: formatdescription: "int32"Código de Cuenta de SoCrEstado:Pago type: "integer" format: "int32int64" FormaChequeApAprCod: typedescription: "string"Código de Aprobación FormaTransferencia: type: "stringinteger" NombreCheque: type format: "stringint32" MiembrosFecAprobacion: description: MiembrosFecha Solde GrupalAprobación de Crédito type: array itemstype: "string" $refformat: "#/definitions/MiembrosSolGrupal_MiembrosSolGrupalItemdate" ModeApGarCod: typedescription: "string"Código de Garantía Error: type: "integer" format: "int32" MiembrosSolGrupal_MiembrosSolGrupalItem: propertiesApOrgCod: Id: description: Código de Origen de Fondos description: Id type: "integer" format: "int64int32" ClCliCodTipoDesem: description: CódigoTipo delde ClienteDesembolso type: "integer" format: "int64int32" ClNomSocioBaCtaCod: description: Código de NombreCuenta delde ClienteBanco type: "stringinteger" CrSolMonCicloAnteriorformat: "int64" descriptionApGrDCod: Monto ciclo anterior description: Código de type: "number"Gran División formattype: "doubleinteger" CrSolMonSolicitadoformat: "int32" descriptionApAcDCod: Monto Solicitado type: "numberinteger" format: "doubleint32" CrSolMonAutorizadoApAgrCod: descriptiontype: Monto"integer" Autorizado typeformat: "numberint32" formatApTGaCod: "double" CrSolTransfCuentaBancoClientetype: "integer" format: "int32" ApGruCod: description: Cuenta bancaria del socio hacia donde se realiza la transacción Código de Grupo type: "integer" format: "int32" SoCrEstado: description: Estado del Crédito type: "integer" format: "int32" FormaCheque: description: Si forma de pago es cheque type: "string" FormaTransferencia: description: Si forma de pago es transferencia type: "string" NombreCheque: description: Titular del Cheque type: "string" Miembros: description: Miembros Sol Grupal type: array items: $ref: "#/definitions/MiembrosSolGrupal_MiembrosSolGrupalItem" Mode: type: "string" Error: type: "integer" format: "int32" MiembrosSolGrupal_MiembrosSolGrupalItem: properties: Id: description: Id type: "integer" format: "int64" ClCliCod: description: Código del Cliente type: "integer" format: "int64" ClNomSocio: description: Nombre del Cliente type: "string" CrSolMonCicloAnterior: description: Monto ciclo anterior type: "number" format: "double" CrSolMonSolicitado: description: Monto Solicitado type: "number" format: "double" CrSolMonAutorizado: description: Monto Autorizado type: "number" format: "double" CrSolTransfCuentaBancoCliente: description: Cuenta bancaria del socio hacia donde se realiza la transacción type: "string" CrSolTransfNumeroDocumento: description: Número de documento de referencia de la transferencia type: "integer" format: "int64" CrSolTransfClienteUnaSolaTransferencia: description: Indica si es el cliente seleccionado para una sola transferencia por todo el grupo type: "boolean" PInsSoliGrupoOutput: properties: ApEmpCod: description: Código de Empresa type: "integer" format: "int32" ApSucCod: description: Código de Sucursal type: "integer" format: "int32" SoCrNumero: description: Numero de Préstamo type: "integer" format: "int64" GrAfCodigo: description: Código de Grupo de Afiliación type: "integer" format: "int64" GrAfCiclo: description: Ciclo de Grupo de Afiliación type: "integer" format: "int64" ApPrmCod: description: Código de Préstamo type: "string" ApPrdCod: description: Código de Producto type: "integer" format: "int32" ApColCod: description: Código SubProducto Colocación type: "integer" format: "int32" SoCrFecha: description: Fecha de Crédito type: "string" format: "date" SoCrFecFormalizacion: description: Fecha de Formalizacion del Crédito type: "string" format: "date" SoCrReferencia: description: Referencia type: "string" SoCrMonSolicitado: description: Monto Solicitado type: "number" typeformat: "stringdouble" CrSolTransfNumeroDocumentoSoCrMonAutorizado: description: Número de documento de referencia de la transferenciaMonto Autorizado type: "integernumber" format: "int64double" CrSolTransfClienteUnaSolaTransferenciaSoCrTasaFoV: description: Tasa Fija Indicao siVariable es el cliente seleccionado para una sola transferencia por todo el grupotype: "string" SoCrTasaBase: type: "boolean" PInsSoliGrupoOutputdescription: Tasa Base properties: ApEmpCod:type: "number" typeformat: "integerdouble" SoCrSpreCorr: format: "int32" ApSucCod: description: Correlativo de Spread de Crédito type: "integernumber" format: "int32double" SoCrNumeroSoCrBaseMora: type: "integer"description: Base de Mora del Crédito formattype: "int64number" GrAfCodigoformat: "double" typeSoCrSpreMora: "integer" formatdescription: "int64"Spread de Interés x Mora del Crédito GrAfCiclo: type: "integernumber" format: "int64double" ApPrmCodSoCrFacPlazo: typedescription: "string"Factor de Plazo del Crédito ApPrdCod: type: "integer" format: "int32" SoCrPlazo: ApColCod:description: Plazo de Crédito type: "integer" format: "int32" SoCrFechaSoCrDiasGracia: typedescription: "string" Días de Gracia formattype: "dateinteger" SoCrFecFormalizacion format: "int32" typeSoCrFecVencimiento: "string" formatdescription: "date"Fecha de Vencimiento de SoCrReferencia:Crédito type: "string" SoCrMonSolicitado format: "date" typeSoCrTipCom: "number" formatdescription: "double"Tipo de SoCrMonAutorizado:Compromiso type: "numberinteger" format: "doubleint32" SoCrTasaFoVSoCrFreCCod: type: "string" SoCrTasaBase:description: Código de Frecuencia de Pago a Capital type: "numberinteger" format: "doubleint32" SoCrSpreCorrSoCrFreICod: typedescription: "number"Código de Frecuencia de Pago Intereses a Préstamo format: "double" SoCrBaseMora: type: "numberinteger" format: "doubleint32" SoCrSpreMoraSoCrFecCap: typedescription: "number" Fecha de Pago a Capital formattype: "doublestring" SoCrFacPlazoformat: "date" typeSoCrFecInt: "integer" format: "int32" SoCrPlazo:description: Fecha de Pago de Interes type: "integerstring" format: "int32date" SoCrDiasGraciaSoCrFormaPago: typedescription: "integer"Forma de Pago del Crédito format: "int32" type: "integer" SoCrFecVencimiento: typeformat: "stringint32" PreFreCPlanilla: format: "date" description: Frecuencia Pago SoCrTipCom:Planilla type: "integer" format: "int32" SoCrFreCCodBaCtaCodPago: typedescription: "integer"Código de Cuenta de format: "int32"Pago SoCrFreICod: type: "integer" format: "int32int64" SoCrFecCapApAprCod: typedescription: "string" Código de Aprobación formattype: "dateinteger" SoCrFecIntformat: "int32" typeFecAprobacion: "string" formatdescription: "date"Fecha de Aprobación de Crédito SoCrFormaPago: type: "integerstring" format: "int32date" PreFreCPlanillaApGarCod: typedescription: "integer" Código de Garantía formattype: "int32integer" BaCtaCodPago format: "int32" type: "integer"ApOrgCod: formatdescription: "int64"Código de Origen de ApAprCod:Fondos type: "integer" format: "int32" FecAprobacionTipoDesem: typedescription: "string" Tipo de Desembolso formattype: "dateinteger" ApGarCodformat: "int32" type: "integer"BaCtaCod: formatdescription: "int32"Código de Cuenta de Banco ApOrgCod: type: "integer" format: "int32"int64" ApGrDCod: TipoDesem description: Código de Gran División type: "integer" format: "int32" BaCtaCodApAcDCod: type: "integer" format: "int64int32" ApGrDCodApAgrCod: type: "integer" format: "int32" ApAcDCodApTGaCod: type: "integer" format: "int32" ApGruCod: description: Código de ApAgrCod:Grupo type: "integer" format: "int32" SoCrEstado: ApTGaCoddescription: Estado del Crédito type: "integer" format: "int32" ApGruCodFormaCheque: typedescription: "integer"Si forma de pago es cheque format: "int32" SoCrEstadotype: "string" type: "integer"FormaTransferencia: formatdescription: "int32"Si forma de pago es FormaCheque:transferencia type: "string" FormaTransferenciaNombreCheque: typedescription: "string"Titular del Cheque NombreCheque: type: "string" Miembros: description: Miembros Sol Grupal type: array items: $ref: "#/definitions/MiembrosSolGrupal_MiembrosSolGrupalItem" Mode: type: "string" Error: type: "integer" format: "int32" 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" |
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 cargar una Planilla de Solicitud de Pago Grupal en la Aplicación SIFCO WEB.
El siguiente ejemplo permite realizar una Solicitud de Pago Grupal en la Aplicación SIFCO WEB.
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) | |||||||||||||||
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. |
| ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Artículos Relacionados
| ||||||||||||
Artículos Actualizados Recientemente
| ||||||||||||
|