Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
DESCRIPCIÓN.
Este Web Service, permite consultar los campos necesarios para registrar una Transacción de Caja en la Aplicación SIFCO WEB, para dicha consulta es imprescindible tener el numero de transacción correspondiente (Estos deben consultarse en la Aplicación SIFCO WEB), adicionalmente se debe respetar el Flujograma Indicado en Web Services de Caja, dado a que ello garantizara que las transacciones se puedan ejecutar sin errores y perfectamente aceptadas y procesadas por 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: "WSInformacionTransaccion"
externalDocs:
description: "Manual SIFCO"
url: "https://sifco.atlassian.net/wiki/x/DgCq"
produces:
- application/json
paths:
/WSInformacionTransaccion:
post:
tags:
- WSInformacionTransaccion
operationId: "WSInformacionTransaccion"
summary: "Consulta de Campos para Registrar Movimiento en 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: "WSInformacionTransaccionCajaInput"
in: "body"
required: false
schema:
$ref: "#/definitions/WSInformacionTransaccionInput"
responses:
200:
description: "Successful operation"
schema:
$ref: "#/definitions/WSInformacionTransaccionOutput"
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:
WSInformacionTransaccionInput:
properties:
Empresa:
description: Código Empresa
type: "integer"
format: "int32"
TransaccionCodigo:
description: Numero de Transacción a Consultar
type: "integer"
format: "int32"
WSInformacionTransaccionOutput:
properties:
InformacionTransaccion_Caja_SDT:
description: Informacion Transaccion_Caja_SDT
$ref: "#/definitions/InformacionTransaccion_Caja_SDT"
InformacionTransaccion_Caja_SDT:
properties:
ApEmpCodigo:
description: Código Empresa
type: "integer"
format: "int32"
ApEmpNombre:
description: Nombre Empresa
type: "string"
ApTrxCod:
description: Código de Transacción
type: "integer"
format: "int32"
ApTrxDes:
description: Descripción
type: "string"
ApModCod:
description: Código Modulo
type: "string"
ApModNom:
description: Nombre Modulo
type: "string"
ApTrxUso:
description: Grupo de Uso
type: "integer"
format: "int32"
ApTrxNaturaleza:
description: Naturaleza
type: "integer"
format: "int32"
ApTrxSigla:
description: Siglas para Estado de Cuenta
type: "string"
ApTrxEstadisticas:
description: Acumula en Estadísticas
type: "string"
ApTrxTipCer:
description: Tipo de Certificación en Caja
type: "integer"
format: "int32"
ApTrxTC1Rut:
description: Rutina Certificación Estándar
type: "integer"
format: "int32"
ApTrxTC1Des:
description: Descripción Rutina
type: "string"
ApTrxTC2Rut:
description: Rutina Impresión Documento
type: "integer"
format: "int32"
ApTrxTC2Des:
description: Descripción de rutina
type: "string"
ApTrxAutoSup:
description: Requiere Autorización del Supervisor
type: "string"
ApTrxUltPar:
description: Ultimo Correlativo de Partidas
type: "integer"
format: "int64"
ApTrxConta:
description: Se contabiliza la transacción
type: "string"
ApTrxActiva:
description: Transacción Activa/Desactiva
type: "string"
ApTrxEsAjuste:
description: Transaccion Tipo Ajuste
type: "string"
ApTrxRptCertifica:
description: Rpt Imprime Certificación
type: "string"
ApTrxEnlace:
description: Enlace con otros Módulos
type: "integer"
format: "int32"
Transaccion:
$ref: "#/definitions/InformacionTransaccion_Caja_SDT.Transaccion"
Campos:
type: array
items:
description: Campo
$ref: "#/definitions/InformacionTransaccion_Caja_SDT.Campos"
Rutinas:
type: array
items:
description: Rutina
$ref: "#/definitions/InformacionTransaccion_Caja_SDT.Rutinas"
InformacionTransaccion_Caja_SDT.Transaccion:
properties:
FechaValor:
description: Fecha Valor
type: "string"
format: "date"
Total:
description: Total
type: "number"
format: "double"
Cuenta:
description: Campos para Número de Cuenta
type: "string"
LibNumero:
description: Número de Libreta
type: "integer"
format: "int64"
ApEmpCodigo:
description: Código Empresa
type: "integer"
format: "int32"
ApSucCodigo:
description: Código de Sucursal
type: "integer"
format: "int32"
ApUsuCod:
description: Codigo del Usuario
type: "string"
ApMonCod:
description: Codigo Moneda
type: "integer"
format: "int32"
NumeroDocumento:
description: Número Documento
type: "integer"
format: "int64"
ApCajRecCodigo:
description: Codigo Caja Receptora
type: "integer"
format: "int32"
ClCliCod:
description: Código del Cliente
type: "integer"
format: "int64"
Cuotas:
description: Cuotas
type: "integer"
format: "int32"
CrUltimaTrx:
description: Número del Movimiento Créditos
type: "integer"
format: "int64"
x-gx-level: "InformacionTransaccion_Caja_SDT"
InformacionTransaccion_Caja_SDT.Campos:
properties:
ApCamCod:
description: Código del Campo
type: "integer"
format: "int32"
ApCtxOrden:
description: Orden de Campos en Transacción
type: "integer"
format: "int32"
ApCamClase:
description: Tipo de Campo
type: "integer"
format: "int32"
ApCamEti:
description: Etiqueta Campo
type: "string"
ApCamTipo:
description: Tipo de Campo
type: "string"
ApPResCod:
description: Código del Periodo
type: "integer"
format: "int32"
ApPResDes:
description: Descripción
type: "string"
ApCamModifica:
description: ApCamModifica
type: "string"
ValorTXT:
description: Valor TXT
type: "string"
ValorNumerico:
description: Valor Numérico
type: "number"
format: "double"
ValorCuenta:
description: Campos para Número de Cuenta
type: "string"
ValorFecha:
description: Valor fecha
type: "string"
format: "date"
ValorDocumento:
description: Campos para Nos. de Documentos
type: "integer"
format: "int64"
x-gx-level: "InformacionTransaccion_Caja_SDT"
InformacionTransaccion_Caja_SDT.Rutinas:
properties:
ApRutxTrx:
description: Código Rutina
type: "integer"
format: "int32"
ApRutxDes:
description: Descripción rutina
type: "string"
ApRutSec:
description: Secuencia Rutina
type: "integer"
format: "int32"
ApRutxTip:
description: Tipo de Rutina
type: "string"
x-gx-level: "InformacionTransaccion_Caja_SDT"
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 >Transaccion | |||
ApUsuCod | |||
Código | Descripción | Modulo | |
TransaccionCodigo | 2030 | PAGOS GRUPALES | CAJA |
3004 | RECEPCIÓN DE EFECTIVO DE BOVEDA | CAJA | |
3005 | ENVIO DEPOSITOS BANCARIOS | CAJA | |
3036 | EXCEDENTE DE CAJA | CAJA | |
3037 | FALTANTE DE CAJA | CAJA | |
8888 | VENTA DE XXX | CAJA |
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 consultar los campos necesarios para registrar una Transacción de Caja en la Aplicación SIFCO WEB.
El siguiente ejemplo permite consultar los campos necesarios para registrar una Transacción de Caja 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 Caja, 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
| ||||||||||||
|