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

« Previous Version 2 Current »

DESCRIPCIÓN.

Este Web Service, permite consultar los Prestamos por Cliente registrados en la Aplicación SIFCO WEB, esto nos ayudará a tener una visión clara de todos los prestamos registrados de un cliente en específico.

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/WSVerPrestamosPorCliente

HEADERS

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

BODY:

{
    "ClCliCod":25
}

200 (Operación Exitosa)

{
    "Prestamos": [
        {
            "NumeroPrestamo": "01010105025910"
        },
        {
            "NumeroPrestamo": "01010105025920"
        },
        {
            "NumeroPrestamo": "01010105026010"
        },
        {
            "NumeroPrestamo": "01010105035000"
        }
    ],
    "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"
    }
}{
    "Prestamos": []
}

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

No existen préstamos para el cliente: Sucede cuando el sistema no tiene registrado prestamos para el cliente solicitado

{
    "Prestamos": [],
    "Mensaje": "No existen préstamos para el cliente"
}

No existe cliente registrado con ese código: Sucede cuando el código de cliente solicitado es inexistente en la plataforma

{
    "Prestamos": [],
    "Mensaje": "No existe cliente registrado con ese código."
}

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