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 format: "int64" GrAfCiclo: type: "integer" format: "int64" ApPrmCodGrAfCiclo: typedescription: "string"Ciclo de Grupo de Afiliación ApPrdCod: type: "integer" format: "int32int64" ApColCodApPrmCod: typedescription: "integer"Código de Préstamo formattype: "int32string" SoCrFecha:ApPrdCod: description: Código de Producto type: "stringinteger" format: "dateint32" SoCrFecFormalizacionApColCod: typedescription: "string"Código SubProducto Colocación formattype: "dateinteger" SoCrReferenciaformat: "int32" SoCrFecha: type: "string" SoCrMonSolicitado:description: Fecha de Crédito type: "numberstring" format: "doubledate" SoCrMonAutorizadoSoCrFecFormalizacion: typedescription: "number" Fecha de Formalizacion del Crédito formattype: "doublestring" SoCrTasaFoV format: "date" SoCrReferencia: type: "string" SoCrTasaBasedescription: Referencia type: "numberstring" SoCrMonSolicitado: format: "double" description: Monto SoCrSpreCorr:Solicitado type: "number" format: "double" SoCrBaseMoraSoCrMonAutorizado: typedescription: Monto "number"Autorizado formattype: "doublenumber" SoCrSpreMoraformat: "double" type: "number"SoCrTasaFoV: formatdescription: "double"Tasa Fija SoCrFacPlazo:o Variable type: "integerstring" SoCrTasaBase: format: "int32" description: Tasa SoCrPlazo:Base type: "integernumber" format: "int32double" SoCrDiasGraciaSoCrSpreCorr: typedescription: "integer"Correlativo de Spread format: "int32" SoCrFecVencimiento:de Crédito type: "stringnumber" format: "datedouble" SoCrTipComSoCrBaseMora: typedescription: "integer"Base de Mora del Crédito formattype: "int32number" SoCrFreCCodformat: "double" typeSoCrSpreMora: "integer" formatdescription: "int32"Spread de Interés x Mora del Crédito SoCrFreICod: type: "integernumber" format: "int32double" SoCrFecCapSoCrFacPlazo: typedescription: "string"Factor de Plazo format: "date" SoCrFecInt:del Crédito type: "stringinteger" format: "dateint32" SoCrFormaPagoSoCrPlazo: typedescription: "integer"Plazo de Crédito format type: "int32integer" PreFreCPlanilla format: "int32" type: "integer"SoCrDiasGracia: formatdescription: "int32"Días BaCtaCodPago:de Gracia type: "integer" format: "int64int32" ApAprCodSoCrFecVencimiento: typedescription: "integer"Fecha de Vencimiento de Crédito format: "int32" type: "string" FecAprobacion: typeformat: "stringdate" SoCrTipCom: format: "date" description: Tipo de ApGarCod:Compromiso type: "integer" format: "int32" ApOrgCodSoCrFreCCod: typedescription: "integer"Código de Frecuencia de Pago format: "int32" TipoDesem:a Capital type: "integer" format: "int32" BaCtaCodSoCrFreICod: typedescription: "integer"Código de Frecuencia de Pago Intereses a Préstamo format: "int64" ApGrDCod: type: "integer" format: "int32" ApAcDCodSoCrFecCap: typedescription: "integer"Fecha de Pago format: "int32" a Capital ApAgrCod: type: "integerstring" format: "int32date" ApTGaCodSoCrFecInt: type: "integer"description: Fecha de Pago de Interes formattype: "int32string" ApGruCod format: "date" type: "integer"SoCrFormaPago: formatdescription: "int32"Forma de Pago del Crédito SoCrEstado: type: "integer" format: "int32" FormaChequePreFreCPlanilla: typedescription: "string"Frecuencia Pago Planilla FormaTransferencia: type: "stringinteger" NombreCheque: typeformat: "stringint32" MiembrosBaCtaCodPago: description: Miembros Sol GrupalCódigo de Cuenta de Pago type: array"integer" items: $refformat: "#/definitions/MiembrosSolGrupal_MiembrosSolGrupalItemint64" ModeApAprCod: typedescription: "string"Código de Aprobación Error: type: "integer" format: "int32" MiembrosSolGrupal_MiembrosSolGrupalItem: FecAprobacion: properties: Iddescription: Fecha de Aprobación de Crédito description: Id type: "integerstring" format: "int64date" ClCliCodApGarCod: description: Código delde ClienteGarantía type: "integer" format: "int64int32" ClNomSocioApOrgCod: description: Nombre del ClienteCódigo de Origen de Fondos type: "stringinteger" CrSolMonCicloAnterior format: "int32" TipoDesem: description: MontoTipo ciclode anteriorDesembolso type: "numberinteger" format: "doubleint32" CrSolMonSolicitadoBaCtaCod: description: Monto Solicitado Código de Cuenta de Banco type: "numberinteger" format: "doubleint64" CrSolMonAutorizadoApGrDCod: description: Monto AutorizadoCódigo de Gran División type: "numberinteger" format: "doubleint32" CrSolTransfCuentaBancoClienteApAcDCod: descriptiontype: Cuenta bancaria del socio hacia donde se realiza la transacción "integer" format: "int32" typeApAgrCod: "string" CrSolTransfNumeroDocumentotype: "integer" description format: Número"int32" de documento de referencia de la transferenciaApTGaCod: type: "integer" format: "int64int32" CrSolTransfClienteUnaSolaTransferenciaApGruCod: description: IndicaCódigo side esGrupo el cliente seleccionado para una sola transferencia por todo el grupotype: "integer" typeformat: "booleanint32" PInsSoliGrupoOutput SoCrEstado: properties: description: Estado del ApEmpCod:Crédito type: "integer" format: "int32" ApSucCodFormaCheque: type: "integer"description: Si forma de pago es cheque formattype: "int32string" SoCrNumeroFormaTransferencia: typedescription: "integer"Si forma de pago es transferencia format type: "int64string" GrAfCodigoNombreCheque: typedescription: "integer" Titular del Cheque formattype: "int64string" GrAfCicloMiembros: typedescription: "integer"Miembros Sol Grupal format: "int64" type: array ApPrmCod: items: type: "string" ApPrdCod$ref: "#/definitions/MiembrosSolGrupal_MiembrosSolGrupalItem" type: "integer"Mode: formattype: "int32string" ApColCodError: type: "integer" format: "int32" MiembrosSolGrupal_MiembrosSolGrupalItem: SoCrFecha: properties: typeId: "string" formatdescription: "date" SoCrFecFormalizacion:Id type: "stringinteger" format: "dateint64" SoCrReferencia ClCliCod: typedescription: "string"Código del Cliente SoCrMonSolicitado: type: "numberinteger" format: "doubleint64" SoCrMonAutorizado ClNomSocio: typedescription: "number" Nombre del Cliente formattype: "doublestring" SoCrTasaFoVCrSolMonCicloAnterior: typedescription: "string"Monto SoCrTasaBase:ciclo anterior type: "number" format: "double" SoCrSpreCorr CrSolMonSolicitado: typedescription: Monto "number"Solicitado formattype: "number" format: "double" CrSolMonAutorizado: SoCrBaseMora: description: Monto Autorizado type: "number" format: "double" SoCrSpreMoraCrSolTransfCuentaBancoCliente: typedescription: "number" Cuenta bancaria del socio hacia donde se realiza la transacción formattype: "doublestring" SoCrFacPlazo CrSolTransfNumeroDocumento: type: "integer"description: Número de documento de referencia de la transferencia formattype: "int32integer" SoCrPlazo: 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" format: "double" SoCrMonAutorizado: description: Monto Autorizado type: "number" format: "double" SoCrTasaFoV: description: Tasa Fija o Variable type: "string" SoCrTasaBase: description: Tasa Base type: "number" format: "double" SoCrSpreCorr: description: Correlativo de Spread de Crédito type: "number" format: "double" SoCrBaseMora: description: Base de Mora del Crédito type: "number" format: "double" SoCrSpreMora: description: Spread de Interés x Mora del Crédito type: "number" format: "double" SoCrFacPlazo: description: Factor de Plazo del Crédito type: "integer" format: "int32" SoCrPlazo: description: Plazo de Crédito type: "integer" format: "int32" SoCrDiasGracia: description: Días de Gracia type: "integer" format: "int32" SoCrFecVencimiento: description: Fecha de Vencimiento de Crédito type: "string" format: "date" SoCrTipCom: description: Tipo de Compromiso type: "integer" format: "int32" SoCrFreCCod: description: Código de Frecuencia de Pago a Capital type: "integer" format: "int32" SoCrFreICod: description: Código de Frecuencia de Pago Intereses a Préstamo type: "integer" format: "int32" SoCrFecCap: description: Fecha de Pago a Capital type: "string" format: "date" SoCrFecInt: description: Fecha de Pago de Interes type: "integerstring" format: "int32"date" SoCrFormaPago: SoCrDiasGraciadescription: Forma de Pago del Crédito type: "integer" format: "int32" SoCrFecVencimientoPreFreCPlanilla: typedescription: "string" Frecuencia Pago Planilla formattype: "dateinteger" SoCrTipCom format: "int32" type: "integer"BaCtaCodPago: formatdescription: "int32"Código de Cuenta de SoCrFreCCod:Pago type: "integer" format: "int32int64" ApAprCod: SoCrFreICod: description: Código de Aprobación type: "integer" format: "int32" SoCrFecCapFecAprobacion: typedescription: "string"Fecha de Aprobación de Crédito format: "date" SoCrFecInt:type: "string" typeformat: "stringdate" ApGarCod: format: "date" description: Código de SoCrFormaPago:Garantía type: "integer" format: "int32" PreFreCPlanillaApOrgCod: typedescription: "integer" Código de Origen de Fondos formattype: "int32integer" BaCtaCodPago format: "int32" typeTipoDesem: "integer" format: "int64" ApAprCod:description: Tipo de Desembolso type: "integer" format: "int32" FecAprobacionBaCtaCod: type: "string"description: Código de Cuenta de Banco formattype: "dateinteger" ApGarCodformat: "int64" typeApGrDCod: "integer" formatdescription: "int32"Código de ApOrgCod:Gran División type: "integer" format: "int32" TipoDesemApAcDCod: type: "integer" format: "int32" BaCtaCodApAgrCod: type: "integer" format: "int64int32" ApGrDCodApTGaCod: type: "integer" format: "int32" ApAcDCodApGruCod: typedescription: "integer" format: "int32" ApAgrCod:Código de Grupo type: "integer" format: "int32" SoCrEstado: ApTGaCod:description: 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 transferencia FormaCheque: 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. |
| Enlaces Relevantes||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Artículos Relacionados
| ||||||||||||
Artículos Actualizados Recientemente
| ||||||||||||
|