Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
DESCRIPCIÓN.
Este Web Service, permite registrar una operación de Deposito o Retiro fuera de Caja (BackOffice) en 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" url: "http://www.apache.org/licenses/LICENSE-2.0.html" host: "<SERVER>" schemes: - https - http basePath: /<APPDIR>/rest tags: - name: "WSCaDepositosRetiros" externalDocs: description: "Manual SIFCO" url: "https://sifco.atlassian.net/wiki/x/gwDQ" produces: - application/json paths: /WSCaDepositosRetiros: post: tags: - WSCaDepositosRetiros operationId: "WSCaDepositosRetiros" summary: "Web Service para Registro de Depositos y/o Retiros por BackOffice, fuera de Caja" 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: "WSCaDepositosRetirosInput" in: "body" required: false schema: $ref: "#/definitions/WSCaDepositosRetirosInput" responses: 200: description: "Successful operation" schema: $ref: "#/definitions/WSCaDepositosRetirosOutput" 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: WSCaDepositosRetirosInput: properties: BackOffice: description: WSCa Depositos Retiros SDT $ref: "#/definitions/WSCaDepositosRetirosSDT" WSCaDepositosRetirosOutput: properties: Resultado: description: WSCa Depositos Retiros SDT_Result $ref: "#/definitions/WSCaDepositosRetirosSDT_Result" WSCaDepositosRetirosSDT: properties: DepositosRetiros: type: array items: description: DepositosRetirosItem $ref: "#/definitions/WSCaDepositosRetirosSDT.DepositosRetiros" WSCaDepositosRetirosSDT.DepositosRetiros: properties: CodigoSocio: description: Código del Cliente type: "integer" format: "int64" NumeroCuenta: description: Número de Cuenta Captaciones type: "string" TipoMovimiento: description: Tipo Movimiento type: "string" EsMovimientoBancario: description: Es Movimiento Bancario type: "string" TipoMovimientoBancario: description: Tipo Movimiento Bancario type: "string" EsCheque: description: Es Cheque type: "string" EsDeposito: description: Es Deposito type: "string" CodigoCuentaBancaria: description: Código de Cuenta Bancaria type: "integer" format: "int64" NumeroBoleta: description: Numero Boleta Deposito type: "integer" format: "int64" NombreEmiteCheque: description: Nombre a quien Emite Cheque type: "string" Monto: description: Monto type: "number" format: "double" Referencia: description: Referencia Documento type: "string" NumeroMovimiento: description: Número del Movimiento Diario type: "integer" format: "int64" NumeroCuentaBancaria: description: Número de la Cuenta type: "string" x-gx-level: "WSCaDepositosRetirosSDT" WSCaDepositosRetirosSDT_Result: properties: Success: description: Success type: "boolean" NumeroCuenta: description: Numero Cuenta type: "string" Descripcion: description: Descripción type: "string" 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" |
RELACIONES ENTRE EL MODELO DE DATOS DE ESTE WEB SERVICE, Y EL RESTO DEL API’s RESTful DE LA APLICACIÓN SIFCO WEB.
Modelo de Datos de este Web Service | Web Service a Constantes del Sistema Relacionados |
---|---|
InformacionTransaccion_Caja_SDT >TransaccionWSCaDepositosRetirosInput >WSCaDepositosRetirosSDT >WSCaDepositosRetirosSDT.DepositosRetiros | |
CodigoCuentaBancaria | |
NumeroCuenta | |
CodigoSocio |
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 registrar una operación de Deposito o Retiro fuera de Caja (BackOffice) en la Aplicación SIFCO WEB..
El siguiente ejemplo permite registrar una operación de Deposito fuera de Caja (BackOffice) 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 |
---|
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
| ||||||||||||
|