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.
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" summaryurl: "Web Services para Crear Solicitud de Pago Grupal" parameters: - in: header http://www.apache.org/licenses/LICENSE-2.0.html" host: "<SERVER>" schemes: - https - http basePath: /<APPDIR>/rest tags: - name: "PInsSoliGrupo" externalDocs: namedescription: Content-Type "Manual SIFCO" typeurl: "string" https://sifco.atlassian.net/wiki/x/RQCx" produces: - application/json paths: required/PInsSoliGrupo: true post: defaulttags: application/json - PInsSoliGrupo - in: header operationId: "PInsSoliGrupo" namesummary: Authorization"Web Services para Crear Solicitud de Pago Grupal" type: "string" parameters: - requiredin: trueheader defaultname: OAuthContent-Type <Access Token> - intype: header"string" namerequired: GENEXUS-AGENTtrue typedefault: "string"application/json - requiredin: trueheader defaultname: SmartDeviceAuthorization Application - nametype: "PInsSoliGrupoInputstring" inrequired: "body"true requireddefault: OAuth false<Access Token> - schemain: header name: GENEXUS-AGENT $ref: "#/definitions/PInsSoliGrupoInput" responses:type: "string" 200required: true description: "Successful operation" default: SmartDevice Application - schemaname: "PInsSoliGrupoInput" $refin: "#/definitions/PInsSoliGrupoOutputbody" 401: descriptionrequired: "Notfalse Authenticated" schema: $ref: "#/definitions/GxJsonErrorPInsSoliGrupoInput" 404responses: 200: description: "NotSuccessful foundoperation" schema: $ref: "#/definitions/GxJsonErrorPInsSoliGrupoOutput" 400 401: description: "BadNot requestAuthenticated" schema: $ref: "#/definitions/GxJsonError" 500404: description: "InternalNot server errorfound" schema: $ref: "#/definitions/GxJsonError" security: - OAuth2: [] 400: ApiKeyAuth1: [] securityDefinitions: OAuth2: description: type: oauth2"Bad request" flow: password tokenUrlschema: https://test.sifco.org/DemoCoopGT/oauth/access_token scopes: Execute$ref: Permite el método tipo GET"#/definitions/GxJsonError" Insert500: Permite el método tipo POST Updatedescription: Permite"Internal elserver métodoerror" tipo PUT Delete: Permite elschema: método tipo DELETE FullControl: Permite el manejo de los Cuatro Métodos GET, POST, PUT,DELETE, sobre el Web Service $ref: "#/definitions/GxJsonError" security: - OAuth2: [] ApiKeyAuth1: [] securityDefinitions: typeOAuth2: apiKey intype: headeroauth2 nameflow: granttypepassword definitions: tokenUrl: PInsSoliGrupoInput:https://test.sifco.org/DemoCoopGT/oauth/access_token propertiesscopes: ApEmpCodExecute: Permite el método tipo GET type: "integer" Insert: Permite el método tipo POST format: "int32" Update: Permite el ApSucCod:método tipo PUT typeDelete: "integer" Permite el método tipo DELETE formatFullControl: "int32"Permite el manejo de los Cuatro Métodos SoCrNumero:GET, POST, PUT,DELETE, sobre el Web Service typeApiKeyAuth1: "integer" type: apiKey format: "int64" in: header GrAfCodigoname: granttype definitions: typePInsSoliGrupoInput: "integer" formatproperties: "int64" GrAfCicloApEmpCod: type: "integer" format: "int64int32" ApPrmCodApSucCod: type: "string" ApPrdCod: type: "integer" format: "int32" ApColCodSoCrNumero: type: "integer" format: "int32int64" SoCrFechaGrAfCodigo: type: "stringinteger" format: "dateint64" SoCrFecFormalizacionGrAfCiclo: type: "stringinteger" format: "dateint64" SoCrReferenciaApPrmCod: type: "string" SoCrMonSolicitadoApPrdCod: type: "numberinteger" format: "doubleint32" SoCrMonAutorizadoApColCod: type: "numberinteger" format: "doubleint32" SoCrTasaFoVSoCrFecha: type: "string" SoCrTasaBase format: "date" type: "number"SoCrFecFormalizacion: formattype: "doublestring" SoCrSpreCorr format: "date" typeSoCrReferencia: "number" formattype: "doublestring" SoCrBaseMoraSoCrMonSolicitado: type: "number" format: "double" SoCrSpreMoraSoCrMonAutorizado: type: "number" format: "double" SoCrFacPlazoSoCrTasaFoV: type: "integerstring" format: "int32"SoCrTasaBase: SoCrPlazo: type: "integernumber" format: "int32double" SoCrDiasGraciaSoCrSpreCorr: type: "integernumber" format: "int32double" SoCrFecVencimientoSoCrBaseMora: type: "stringnumber" format: "datedouble" SoCrTipComSoCrSpreMora: type: "integernumber" format: "int32double" SoCrFreCCodSoCrFacPlazo: type: "integer" format: "int32" SoCrFreICodSoCrPlazo: type: "integer" format: "int32" SoCrFecCapSoCrDiasGracia: type: "stringinteger" format: "dateint32" SoCrFecIntSoCrFecVencimiento: type: "string" format: "date" SoCrFormaPagoSoCrTipCom: type: "integer" format: "int32" PreFreCPlanillaSoCrFreCCod: type: "integer" format: "int32" BaCtaCodPagoSoCrFreICod: type: "integer" format: "int64int32" ApAprCodSoCrFecCap: type: "integerstring" format: "int32date" FecAprobacionSoCrFecInt: type: "string" format: "date" ApGarCodSoCrFormaPago: type: "integer" format: "int32" ApOrgCodPreFreCPlanilla: type: "integer" format: "int32" TipoDesemBaCtaCodPago: type: "integer" format: "int32int64" BaCtaCodApAprCod: type: "integer" format: "int64int32" ApGrDCodFecAprobacion: type: "integerstring" format: "int32date" ApAcDCodApGarCod: type: "integer" format: "int32" ApAgrCodApOrgCod: type: "integer" format: "int32" ApTGaCodTipoDesem: type: "integer" format: "int32" ApGruCodBaCtaCod: type: "integer" format: "int32int64" SoCrEstadoApGrDCod: type: "integer" format: "int32" FormaChequeApAcDCod: type: "stringinteger" FormaTransferenciaformat: "int32" ApAgrCod: type: "string" NombreChequetype: "integer" type format: "stringint32" MiembrosApTGaCod: descriptiontype: Miembros Sol Grupal"integer" typeformat: array"int32" itemsApGruCod: $reftype: "#/definitions/MiembrosSolGrupal_MiembrosSolGrupalIteminteger" Mode: typeformat: "stringint32" ErrorSoCrEstado: type: "integer" format: "int32" MiembrosSolGrupal_MiembrosSolGrupalItem: FormaCheque: properties: Idtype: "string" descriptionFormaTransferencia: Id type: "integerstring" NombreCheque: format type: "int64string" ClCliCodMiembros: description: CódigoMiembros delSol ClienteGrupal type: "integer"array formatitems: "int64" ClNomSocio$ref: "#/definitions/MiembrosSolGrupal_MiembrosSolGrupalItem" descriptionMode: Nombre del Cliente type: "string" CrSolMonCicloAnteriorError: descriptiontype: Monto"integer" ciclo anterior typeformat: "numberint32" MiembrosSolGrupal_MiembrosSolGrupalItem: formatproperties: "double" CrSolMonSolicitadoId: description: MontoId Solicitado type: "numberinteger" format: "doubleint64" CrSolMonAutorizadoClCliCod: description: MontoCódigo del AutorizadoCliente type: "numberinteger" format: "doubleint64" CrSolTransfCuentaBancoClienteClNomSocio: description: Cuenta bancariaNombre del socioCliente hacia donde se realiza la transacción type: "string" CrSolTransfNumeroDocumentoCrSolMonCicloAnterior: description: NúmeroMonto deciclo documentoanterior de referencia de la transferencia type: "integernumber" format: "int64double" CrSolTransfClienteUnaSolaTransferenciaCrSolMonSolicitado: description: IndicaMonto siSolicitado es el cliente seleccionado para una sola transferencia por todo el grupotype: "number" typeformat: "booleandouble" PInsSoliGrupoOutput: CrSolMonAutorizado: properties: ApEmpCoddescription: Monto Autorizado type: "integernumber" format: "int32double" ApSucCodCrSolTransfCuentaBancoCliente: typedescription: "integer" format: "int32"Cuenta bancaria del socio hacia donde se realiza la transacción SoCrNumerotype: "string" typeCrSolTransfNumeroDocumento: "integer" formatdescription: "int64"Número de documento de referencia de la GrAfCodigo:transferencia type: "integer" format: "int64" GrAfCicloCrSolTransfClienteUnaSolaTransferencia: typedescription: "integer"Indica si es el cliente seleccionado para una format: "int64"sola transferencia por todo el grupo ApPrmCodtype: "boolean" PInsSoliGrupoOutput: type properties: "string" ApPrdCodApEmpCod: type: "integer" format: "int32" ApColCodApSucCod: type: "integer" format: "int32" SoCrFechaSoCrNumero: type: "stringinteger" format: "dateint64" SoCrFecFormalizacionGrAfCodigo: type: "stringinteger" format: "dateint64" SoCrReferenciaGrAfCiclo: type: "stringinteger" SoCrMonSolicitadoformat: "int64" type: "number"ApPrmCod: formattype: "doublestring" SoCrMonAutorizadoApPrdCod: type: "numberinteger" format: "doubleint32" SoCrTasaFoVApColCod: type: "stringinteger" format: "int32" SoCrTasaBaseSoCrFecha: type: "numberstring" format: "doubledate" SoCrSpreCorrSoCrFecFormalizacion: type: "numberstring" format: "doubledate" SoCrReferencia: type: "string" SoCrBaseMoraSoCrMonSolicitado: type: "number" format: "double" SoCrSpreMoraSoCrMonAutorizado: type: "number" format: "double" SoCrFacPlazoSoCrTasaFoV: type: "integerstring" format: "int32" SoCrPlazoSoCrTasaBase: type: "integernumber" format: "int32double" SoCrDiasGraciaSoCrSpreCorr: type: "integer" 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" type: "number" format: "double" SoCrBaseMora: type: "number" format: "double" SoCrSpreMora: type: "number" format: "double" SoCrFacPlazo: type: "integer" format: "int32" SoCrPlazo: type: "integer" format: "int32" SoCrDiasGracia: type: "integer" 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" |
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
| ||||||||||||
|