DESCRIPCIÓN.
Este Web Service, permite dar Apertura a la CAJA, para el inicio de las transacciones en la Aplicación SIFCO WEB, es importante indicar que se deben incluir detalles como empresa, sucursal, moneda, saldo inicial, ingreso, egreso y demás detalles para la apertura de la misma.
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 |
|---|---|
PCJApeCajeroInput | |
ApUsuCod |
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 dar Apertura a la CAJA, para el inicio de las transacciones en la Aplicación SIFCO WEB.
El siguiente ejemplo permite dar Apertura a la CAJA en la Aplicación SIFCO WEB.
Tipo de Mensaje HTTP | Ejemplo |
|---|---|
REQUEST | URL: https://test.sifco.org/democoopgt/rest/PCJApeCajero HEADERS content-type: application/json authorization: OAuth f2a9ec34-cf83-46f5-8862-f78........ genexus-agent: SmartDevice Application BODY: {
"ApEmpCod": 1,
"ApSucCod": 1,
"ApUsuCod": "admin",
"ApMonCod": 1,
"SaldoIni": 1000,
"SIngreso": "1500",
"SEgreso": "1300",
"ApCajRecCodigo": 1,
"mensaje": "string",
"ok": true
}
|
200 (Successful operation) Operación Exitosa | {
"ApEmpCod": 1,
"ApSucCod": 1,
"ApUsuCod": "admin",
"ApMonCod": 1,
"SaldoIni": "1000.00",
"SIngreso": "1500",
"SEgreso": "1300",
"ApCajRecCodigo": 1,
"mensaje": "CAJA ABIERTA EXITOSAMENTE",
"ok": true
}
|
400 (Bad Request). Solicitud Errada | {
"error": {
"code": "string",
"message": "string"
}
}
|
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) ). | {
"error": {
"code":"0",
"message":"This service needs an Authorization Header"
}
}
|
404 (Not Found). | Respuesta Vacía (Web Service, no encontrado ) |
500 (Internal Server Error) (Error Interno del Servidor de las API’s REST). | {
"error": {
"code": "string",
"message": "string"
}
}
|
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.
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.
RESPETE LOS ENCABEZADOS OBLIGATORIOS para que pueda consumir el WEB SERVICE respectivo.
Content-Type: application/json Authorization: OAuth f2a9ec34-cf83-46f5-8862-f78ac03670d1!171380a787a9152688ab61a94d66e0eb77... GENEXUS-AGENT: SmartDevice Application
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 | |||||||||||||||||||||||||||||||||||||||
|
