Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Web Services para Crear Solicitud de Pago Grupal.
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: typedescription: "integer" Código de Empresa formattype: "int32integer" ApSucCod: format: "int32" typeApSucCod: "integer" formatdescription: "int32"Código SoCrNumero:de Sucursal type: "integer" format: "int64"int32" SoCrNumero: GrAfCodigo: description: Numero de Préstamo type: "integer" format: "int64" GrAfCodigo: GrAfCiclo:description: Código de Grupo de Afiliación 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: "int32"string" ApPrdCod: SoCrFecha: 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" SoCrMonAutorizado: SoCrBaseMora: description: Monto Autorizado type: "number" format: "double" SoCrSpreMoraSoCrTasaFoV: typedescription: "number"Tasa Fija o Variable formattype: "doublestring" SoCrFacPlazoSoCrTasaBase: typedescription: "integer"Tasa Base formattype: "int32number" SoCrPlazoformat: "double" type: "integer"SoCrSpreCorr: formatdescription: "int32"Correlativo de Spread de Crédito SoCrDiasGracia: type: "integernumber" format: "int32double" SoCrFecVencimientoSoCrBaseMora: typedescription: "string"Base de Mora format: "date" del Crédito SoCrTipCom: type: "integernumber" format: "int32double" SoCrFreCCodSoCrSpreMora: typedescription: "integer"Spread de Interés x Mora format: "int32" SoCrFreICod:del Crédito type: "integernumber" format: "int32double" SoCrFecCapSoCrFacPlazo: typedescription: "string"Factor de Plazo del Crédito format: "date" SoCrFecInttype: "integer" type format: "stringint32" SoCrPlazo: format: "date" description: Plazo de SoCrFormaPago:Crédito type: "integer" format: "int32" PreFreCPlanillaSoCrDiasGracia: typedescription: "integer" Días de Gracia formattype: "int32integer" BaCtaCodPagoformat: "int32" type: "integer"SoCrFecVencimiento: formatdescription: "int64"Fecha de Vencimiento de Crédito ApAprCod: type: "integerstring" format: "int32date" FecAprobacionSoCrTipCom: typedescription: "string"Tipo de Compromiso formattype: "dateinteger" ApGarCod format: "int32" typeSoCrFreCCod: "integer" formatdescription: "int32"Código de Frecuencia de Pago a ApOrgCod:Capital type: "integer" format: "int32" TipoDesemSoCrFreICod: typedescription: "integer"Código de Frecuencia de Pago Intereses format: "int32" BaCtaCod:a Préstamo type: "integer" format: "int64int32" ApGrDCodSoCrFecCap: type: "integer"description: Fecha de Pago a Capital formattype: "int32string" ApAcDCodformat: "date" type: "integer"SoCrFecInt: formatdescription: "int32"Fecha de Pago de Interes ApAgrCod: type: "integerstring" format: "int32date" ApTGaCodSoCrFormaPago: typedescription: "integer"Forma de Pago del Crédito format: "int32" type: "integer" ApGruCod: typeformat: "integerint32" PreFreCPlanilla: format: "int32" description: Frecuencia Pago SoCrEstado:Planilla type: "integer" format: "int32" FormaChequeBaCtaCodPago: typedescription: "string"Código de Cuenta de FormaTransferencia:Pago type: "stringinteger" NombreCheque: typeformat: "stringint64" MiembrosApAprCod: description: MiembrosCódigo Solde GrupalAprobación type: array"integer" itemsformat: "int32" $ref: "#/definitions/MiembrosSolGrupal_MiembrosSolGrupalItem"FecAprobacion: Mode: typedescription: "string"Fecha de Aprobación de Error:Crédito type: "integerstring" format: "int32date" MiembrosSolGrupal_MiembrosSolGrupalItem: propertiesApGarCod: Id: description: Código de Garantía description: Id type: "integer" format: "int64int32" ClCliCodApOrgCod: description: Código del Clientede Origen de Fondos type: "integer" format: "int64int32" ClNomSocioTipoDesem: description: NombreTipo delde ClienteDesembolso type: "string" integer" format: "int32" CrSolMonCicloAnteriorBaCtaCod: description: Código de MontoCuenta ciclode anteriorBanco type: "numberinteger" format: "doubleint64" CrSolMonSolicitadoApGrDCod: description: Código Montode Gran SolicitadoDivisión type: "numberinteger" format: "double"int32" ApAcDCod: CrSolMonAutorizadotype: "integer" description: Monto Autorizado format: "int32" ApAgrCod: type: "numberinteger" format: "doubleint32" CrSolTransfCuentaBancoClienteApTGaCod: descriptiontype: Cuenta bancaria del socio hacia donde se realiza la transacción"integer" typeformat: "stringint32" CrSolTransfNumeroDocumentoApGruCod: description: NúmeroCódigo de documento deGrupo referencia de la transferencia type: "integer" format: "int64int32" CrSolTransfClienteUnaSolaTransferenciaSoCrEstado: description: IndicaEstado sidel esCrédito el cliente seleccionado para una sola transferencia por todo el grupotype: "integer" typeformat: "booleanint32" PInsSoliGrupoOutput: FormaCheque: properties: ApEmpCoddescription: Si forma de pago es cheque type: "integer" formattype: "int32string" ApSucCodFormaTransferencia: type: "integer"description: Si forma de pago es transferencia formattype: "int32string" SoCrNumeroNombreCheque: typedescription: "integer" Titular del Cheque formattype: "int64string" GrAfCodigoMiembros: typedescription: "integer" Miembros Sol Grupal formattype: array "int64" GrAfCicloitems: type $ref: "integer#/definitions/MiembrosSolGrupal_MiembrosSolGrupalItem" Mode: format: "int64" ApPrmCod: type: "string" ApPrdCodError: type: "integer" format: "int32" MiembrosSolGrupal_MiembrosSolGrupalItem: ApColCod: properties: typeId: "integer" description: Id format: "int32" SoCrFechatype: "integer" typeformat: "stringint64" ClCliCod: format: "date" SoCrFecFormalizacion:description: Código del Cliente type: "stringinteger" format: "dateint64" SoCrReferencia ClNomSocio: typedescription: "string"Nombre del Cliente SoCrMonSolicitado: type: "string" type: "number" CrSolMonCicloAnterior: format: "double" description: Monto ciclo SoCrMonAutorizado:anterior type: "number" format: "double" SoCrTasaFoVCrSolMonSolicitado: typedescription: "string" SoCrTasaBase:Monto Solicitado type: "number" format: "double" SoCrSpreCorr CrSolMonAutorizado: typedescription: Monto "number"Autorizado formattype: "doublenumber" SoCrBaseMoraformat: "double" typeCrSolTransfCuentaBancoCliente: "number" description: Cuenta format: "double" SoCrSpreMora:bancaria del socio hacia donde se realiza la transacción type: "numberstring" format: "double" SoCrFacPlazo:CrSolTransfNumeroDocumento: description: Número de documento de referencia de la transferencia type: "integer" format: "int32int64" SoCrPlazo CrSolTransfClienteUnaSolaTransferencia: type: "integer"description: Indica si es el cliente seleccionado para una sola transferencia por todo el grupo formattype: "int32boolean" PInsSoliGrupoOutput: SoCrDiasGracia: properties: typeApEmpCod: "integer" description: Código format: "int32" SoCrFecVencimiento: type: "string" format: "date" SoCrTipCom: type: "integer" format: "int32" SoCrFreCCod: type: "integer" format: "int32" SoCrFreICod: type: "integer" format: "int32" SoCrFecCap: type: "string" format: "date" SoCrFecInt: type: "string" format: "date" SoCrFormaPago: type: "integer" format: "int32" PreFreCPlanilla: type: "integer" format: "int32" BaCtaCodPago: type: "integer" format: "int64" ApAprCod: type: "integer" format: "int32" FecAprobacion: type: "string" format: "date" ApGarCod: type: "integer" format: "int32" ApOrgCod: type: "integer" format: "int32" TipoDesem: type: "integer" format: "int32" BaCtaCod: type: "integer" format: "int64" ApGrDCod: type: "integer" format: "int32" ApAcDCod: type: "integer" format: "int32" ApAgrCod: type: "integer" format: "int32" ApTGaCod: type: "integer" format: "int32" ApGruCod: type: "integer" format: "int32" SoCrEstado: type: "integer" format: "int32" FormaCheque: type: "string" FormaTransferencia: type: "string" 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"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: "string" format: "date" SoCrFormaPago: description: Forma de Pago del Crédito type: "integer" format: "int32" PreFreCPlanilla: description: Frecuencia Pago Planilla type: "integer" format: "int32" BaCtaCodPago: description: Código de Cuenta de Pago type: "integer" format: "int64" ApAprCod: description: Código de Aprobación type: "integer" format: "int32" FecAprobacion: description: Fecha de Aprobación de Crédito type: "string" format: "date" ApGarCod: description: Código de Garantía type: "integer" format: "int32" ApOrgCod: description: Código de Origen de Fondos type: "integer" format: "int32" TipoDesem: description: Tipo de Desembolso type: "integer" format: "int32" BaCtaCod: description: Código de Cuenta de Banco type: "integer" format: "int64" ApGrDCod: description: Código de Gran División type: "integer" format: "int32" ApAcDCod: type: "integer" format: "int32" ApAgrCod: type: "integer" format: "int32" ApTGaCod: type: "integer" format: "int32" ApGruCod: description: 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" 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
| ||||||||||||
|