DESCRIPCIÓN.
Este Web Service, permite Obtener los Descuentos de las Planillas de Transacciones Pendientes generados por un Sistema Externo o directamente desde la Aplicación SIFCO WEB, en el rango de fechas indicados.
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 |
|---|---|
TransaccionesMasivas_PlanillaSalida >TransaccionesMasivas_PlanillaSalida.Planillas | |
Frecuencia | |
TransaccionesMasivas_PlanillaSalida >TransaccionesMasivas_PlanillaSalida.Planillas >TransaccionesMasivas_PlanillaSalida.Planillas.Detalles | |
ClienteCodigoSifco |
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 Obtener los Descuentos de las Planillas de Transacciones Pendientes generados por un Sistema Externo o directamente desde la Aplicación SIFCO WEB.
Campo Modulo: El valor numérico representa el modulo al que pertenece.
Name | Description | Value |
|---|---|---|
Captacion | Captación | 1 |
Colocacion | Colocación | 2 |
Otros | Otros | 3 |
El siguiente ejemplo permite Obtener los Descuentos de las Planillas de Transacciones Pendientes en la Aplicación SIFCO WEB, en un rango de fechas especifico.
Tipo de Mensaje HTTP | Ejemplo |
|---|---|
REQUEST | URL: https://test.sifco.org/democoopgt/rest/TransaccionesMasivas_PlanillasPendientes HEADERS content-type: application/json authorization: OAuth f2a9ec34-cf83-46f5-8862-f78........ genexus-agent: SmartDevice Application BODY: {
"Desde":"2019-10-01",
"Hasta":"2019-10-30"
}
|
200 (Successful operation) Operación Exitosa | {
"Planillas": {
"Planillas": [
{
"ID": "SIFCO-1090",
"Descripcion": "Prueba 01-10-2019",
"Fecha": "2019-10-01",
"FrecuenciaCodigo": 1,
"FrecuenciaNombre": "N-D013",
"Detalles": [
{
"ID": "7ee44e82-a386-46b2-ae4e-e4e5662bf6fa",
"ClienteCodigoSifco": 1,
"ClienteReferencia": "0232028",
"Modulo": 2,
"TransaccionNumero": "010102101001796",
"TransaccionReferencia": "APORTE ORDINARIO APORTE ORDINARIO LABORAL",
"Valor": 25.00
},
{
"ID": "2cf89f64-94e7-4543-a671-222405878f47",
"ClienteCodigoSifco": 2,
"ClienteReferencia": "344222",
"Modulo": 2,
"TransaccionNumero": "010102101008036",
"TransaccionReferencia": "APORTE ORDINARIO APORTE ORDINARIO LABORAL",
"Valor": 25.00
},
{
"ID": "a36c830-cfa3-49a9-a849-202b916c6514",
"ClienteCodigoSifco": 3,
"ClienteReferencia": "352688",
"Modulo": 2,
"TransaccionNumero": "010102101009338",
"TransaccionReferencia": "APORTE ORDINARIO APORTE ORDINARIO LABORAL",
"Valor": 25.00
},
{
"ID": "2ab7de66-f3ae-47d1-a9f1-b6ab6e4322bd",
"ClienteCodigoSifco": 4,
"ClienteReferencia": "371213",
"Modulo": 2,
"TransaccionNumero": "010102101011344",
"TransaccionReferencia": "APORTE ORDINARIO APORTE ORDINARIO LABORAL",
"Valor": 25.00
},
]
}
]
}
}
1 |
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"
}
}
{
"Planillas": {
"Planillas": [
"Detalles":[]
]
}
}
|
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 Planillas de Transacciones Masivas, 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.
