Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

DESCRIPCIÓN.

Este Web Service, permite consultar las fechas de cierre sistema contra la fecha real de cierre registrados en la Aplicación SIFCO WEB , esto nos ayudará a tener una visión clara de las fechas de cierre y la diferencia de fechas contra la fecha real en la que el cierre se realizó

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 el Listado de Productos de Captación registrados en la Aplicación SIFCO WEB

El siguiente ejemplo permite obtener dicho listado de la Aplicación SIFCO WEB.

Tipo de Mensaje HTTP

Ejemplo

REQUEST

URL:

https://test.sifco.org/instancia/rest/WSVerFechaCierreFechaReal

HEADERS

content-type: application/json
authorization: OAuth f2a9ec34-cf83-46f5-8862-f78........

BODY

{
    "FechaDesde":"2024-05-30",
    "FechaHasta": "2024-06-30"
}

200 (Operación Exitosa)

{
    "Respuesta": [
        {
            "FechaCierre": "2024-05-01",
            "FechaReal": "2024-05-02"
        },
        {
            "FechaCierre": "2024-05-02",
            "FechaReal": "2024-05-02"
        },
        {
            "FechaCierre": "2024-05-03",
            "FechaReal": "2024-05-03"
        },
        {
            "FechaCierre": "2024-05-04",
            "FechaReal": "2024-05-04"
        },
        {
            "FechaCierre": "2024-05-05",
            "FechaReal": "2024-05-04"
        }
    ],
    "Mensaje": "Consumo Exitoso"
}

400 (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"
    }
}{
    "Respuesta": []
}

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"
  }
}

Tipo de Mensaje SIFCO

Ejemplo

Fecha inválida, revise por favor: Sucede cuando se envían fechas que no esten correctamente digitadas. El problema puede suceder por las siguientes causas:

  • Fecha desde es mayor a la fecha hasta

  • Alguna de las fechas envíadas son incorrectas

{
    "Respuesta": [],
    "Mensaje": "Fecha inválida, revise por favor."
}

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.

RESPETE LOS ENCABEZADOS OBLIGATORIOS para que pueda consumir el WEB SERVICE respectivo.

Content-Type: application/json
Authorization: OAuth f2a9ec34-cf83-46f5-8862-f78ac03670d1!171380a787a9152688ab61a94d66e0eb77...

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.

  • No labels