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 cargar de forma masiva Calificadores Adicionales en la Aplicación SIFCO WEB, los cuales permite establecer categorías y parámetros adicionales a los clientes que no vienen cargados por defecto en la Aplicación SIFCO WEB, logrando describir de forma mas detallada y precisa características de los clientes registrados en la Aplicación SIFCO WEB.

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

WSCalificadoresRegistroInput

>WSCalificadoresRegistroInput.WSCalificadoresClienteSDT

FormaIdentificar

Constantes preestablecidas asociadas a variables o parámetros de la Aplicación SIFCO WEB.

WSCalificadoresClienteSDT

>WSCalificadoresClienteSDT.Calificadores

CodigoCalificador

WSApCamposDefinidosUsuarioLista

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 agregar en la Aplicación SIFCO WEB, Calificadores Adicionales de forma masiva.

El siguiente ejemplo un Calificador Adicional en la Aplicación SIFCO WEB.

Información de Campos para el envió de información “Entrada

Campo:FormaIdentificar


NOMBRE

DESCRIPCIÓN

VALOR

CodigoSIFCO

Código de cliente

1

Referencia

Referencia del Cliente

2

Identificacion

Identificación del cliente

3

Nombre

Nombre del cliente

4

NumeroCredito

Número de crédito o préstamo

5

Tipo de Mensaje HTTP

Ejemplo

REQUEST

URL:

https://test.sifco.org/democoopgt/rest/WSCalificadoresRegistroV2

HEADERS:

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

BODY:

{
  "Entrada": [
    {
      "FormaIdentificar": 5,
      "Identificacion": "01022101930286",
      "Entidad": "15",
      "Calificadores": [
        {
          "CodigoCalificador": 143,
          "ValorCalificador": "19/07/1991"
        },
        {
          "CodigoCalificador": 144,
          "ValorCalificador": "22"
        },
        {
          "CodigoCalificador": 145,
          "ValorCalificador": "1000.25"
        },
        {
          "CodigoCalificador": 146,
          "ValorCalificador": "Prestamo de caracter urgente"
        },
        {
          "CodigoCalificador": 147,
          "ValorCalificador": "33 calle 20-58 san jose"
        },
        {
          "CodigoCalificador": 148,
          "ValorCalificador": "3"
        }
      ]
    }
  ]
}

200 (Successful operation)

Operación Exitosa

{
  "Salida": [
    {
      "FormaIdentificar": 2,
      "Identificacion": "1",
      "Calificadores": [
        {
          "CodigoCalificador": 3,
          "ValorCalificador": "EGRESOS POR MES"
        }
      ]
    }
  ]
}

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"
  }
}
{
  "Salida": []
}

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 Clientes, 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

Version Date Comment
Current Version (v. 2) Jun 23, 2022 05:49 H. Samuel Casuy D.
v. 2 Jun 23, 2022 05:49 H. Samuel Casuy D.
v. 1 Jun 23, 2022 05:35 H. Samuel Casuy D.


  • No labels