WSIngresarClientesV2

Owned by H. Samuel Casuy D.
Last updated: Jan 19, 2022
19 min read

 

DESCRIPCIÓN.

 

Este Web Service, es uno de los fundamentales de este grupo de API’s RESTful debido a que el mismo permite la consulta, el ingreso o la actualización de clientes (asociados / socios), incluyendo todos sus datos claves como por ejemplo, Datos Generales, Cuentas de Ahorro Iniciales, Campos Definidos por el Usuario (Calificadores Adicionales), Cuentas Bancarias, Teléfonos, Direcciones. Ademas de quedar registrado en la Aplicación SIFCO WEB, como un cliente (en el caso de ingreso).

Es importante acotar que para la correcta carga de todos los parámetros de un cliente se deben consumir todos los Web Services de Consulta de Categorías Generales, y las Constantes preestablecidas asociadas a variables o parámetros de la Aplicación SIFCO WEB dado a que ellos les permitan conocer todas las diferentes opciones de parámetros de clientes a consultar, ingresar o actualizar en la Aplicación SIFCO WEB.

Adicionalmente se debe indicar que las opciones de Consulta, Ingreso o Actualización depende del parámetro Modo tal como se explica en el Flujo de Trabajo de Clientes, y se refresca en la tabla a continuación por su importancia para este WS en particular.

Modo

Modo de Acceso al Cliente en el Sistema.

Valor

Significado

DSP

Permite Obtener toda la información del Cliente, cargada en el Sistema.

INS

Permite Incluir un Cliente en el Sistema.

UPD

Permite Actualizar solos los campos de Datos Generales, y Cuentas de Ahorro del Cliente en el Sistema.

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

WSIngresarClientesInput

 

Modo

Constantes asociadas a variables preestablecidas por la Aplicación SIFCO WEB.

ConsultaFormaIdentificar

Constantes asociadas a variables preestablecidas por la Aplicación SIFCO WEB.

WSIngresarClientesInput

>WSInformacionCliente

 

TipoDePersona

Constantes asociadas a variables preestablecidas por la Aplicación SIFCO WEB.

TipoIdentificacion

WSApTiposIdentificacionLista

DocumentoIdentificacionPais

WSApPaisLista

DocumentoIdentificacionDepartamento

WSApDepartamentoLista

DocumentoIdentificacionMunicipio

WSApMunicipioLista

Sexo

Constantes asociadas a variables preestablecidas por la Aplicación SIFCO WEB.

Estado Civil

Constantes asociadas a variables preestablecidas por la Aplicación SIFCO WEB.

Grupo

WSClGruposLista

Promotor

WSApUsuariosSistemaLista

AfectoAImpuestos

Constantes asociadas a variables preestablecidas por la Aplicación SIFCO WEB.

EstadoCliente

Constantes asociadas a variables preestablecidas por la Aplicación SIFCO WEB.

ActividadEconomica

WSActividadEconomicaLista

WSIngresarClientesInput

>WSInformacionCliente

>WSInformacionCliente.Prestamo

 

Producto

WSApColocacionProductosLista.

SubProducto

WSApColocacionProductosLista.

WSIngresarClientesInput

>WSInformacionCliente

>WSInformacionCliente.CuentasAhorro

 

Producto

WSApCaptacionProductosLista

SubProducto

WSApCaptacionProductosLista

TieneCondicionesEspeciales

Constantes asociadas a variables preestablecidas por la Aplicación SIFCO WEB.

FrecuenciaDescuentoPlanilla

WSApFrecuenciasLista

WSIngresarClientesInput

>WSInformacionCliente

>WSInformacionCliente.CalificadoresAdicionales

 

CodigoCalificador

WSApCamposDefinidosUsuarioLista

WSIngresarClientesInput

>WSInformacionCliente

>WSInformacionCliente.CuentasBancarias

 

CodigoBanco

WSApBancosLista

TipoCuenta

Constantes asociadas a variables preestablecidas por la Aplicación SIFCO WEB.

EstadoReferencia

Constantes asociadas a variables preestablecidas por la Aplicación SIFCO WEB.

WSIngresarClientesInput

>WSInformacionCliente

>WSInformacionCliente.Telefonos

 

TipoTelefono

Constantes asociadas a variables preestablecidas por la Aplicación SIFCO WEB.

WSIngresarClientesInput

>WSInformacionCliente

>WSInformacionCliente.Direcciones

 

TipoDireccion

Constantes asociadas a variables preestablecidas por la Aplicación SIFCO WEB.

DireccionPais

WSApPaisLista

DireccionDepartamento

WSApDepartamentoLista

DireccionMunicipio

WSApMunicipioLista

WSIngresarClientesInput

>WSInformacionCliente

>WSInformacionCliente.RefPersonales

 

TipoPersona

Constantes asociadas a variables preestablecidas por la Aplicación SIFCO WEB.

TipoRelacion

Constantes asociadas a variables preestablecidas por la Aplicación SIFCO WEB.

Estatus

Constantes asociadas a variables preestablecidas por la Aplicación SIFCO WEB.

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 la Creación de Clientes en la Aplicación SIFCO WEB.

A continuación se mostraran tres ejemplos de uso de este Web Service, uno para cada valor del parámetro Modo, dado a su relevancia para este Web Service en particular.

EJEMPLO #1

El siguiente ejemplo consulta los datos de un cliente en la Aplicación SIFCO WEB, con el Parámetro Modo : “DSP“

Tipo de Mensaje HTTP

Ejemplo

REQUEST

URL:

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

HEADERS:

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

BODY:

{ "Modo": "DSP", "ConsultaFormaIdentificar": 1, "ConsultaValorIdentificador": "12345", "WSCliente": {} }

200 (Successful operation)

Operación Exitosa

400 (Bad Request).

Solicitud Errada

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) ).

404 (Not Found).

Respuesta Vacía (Web Service, no encontrado )

500 (Internal Server Error)

(Error Interno del Servidor de las API’s REST).

 

EJEMPLO #2

El siguiente ejemplo inserta un cliente en la Aplicación SIFCO WEB, con el Parámetro Modo : “INS”

Tipo de Mensaje HTTP

Ejemplo

REQUEST

URL:

HEADERS

BODY:

200 (Successful operation)

Operación Exitosa

400 (Bad Request).

Solicitud Errada

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) ).

404 (Not Found).

Respuesta Vacía (Web Service, no encontrado )

500 (Internal Server Error)

(Error Interno del Servidor de las API’s REST).

EJEMPLO #3

El siguiente ejemplo consulta los datos de un cliente en la Aplicación SIFCO WEB, con el Parámetro Modo : “UPD“

Tipo de Mensaje HTTP

Ejemplo

REQUEST

URL:

HEADERS:

BODY:

200 (Successful operation)

Operación Exitosa

200 (Successful operation)

Operación Con Errores

 

200 (Successful operation)

Operación Con Errores

 

400 (Bad Request).

Solicitud Errada

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) ).

404 (Not Found).

Respuesta Vacía (Web Service, no encontrado )

500 (Internal Server Error)

(Error Interno del Servidor de las API’s REST).

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

Antes de consumir este Web Service, debe consultar cada una de los WS descritos en Web Services de Consulta de Categorías Generales, dado a que en ellos se listan los valores ya cargados de un conjunto de parámetros necesarios para ingresar un cliente al sistema, y dichos parámetros deben coincidir con los ya existentes en el para evitar errores y/o inconsistencias durante el ingreso de clientes, igualmente se debe respetar las constantes ya definida en el sistema, indicadas en la pagina de Constantes asociadas a variables preestablecidas en la Aplicación SIFCO WEB.

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.

Tome en cuenta estos como los campos mínimos:

Cuando es una persona individual:


Cuando es una persona jurídica:

 

 

 

 

Búsqueda en esta Pagina

Enlaces Relevantes

Artículos Relacionados

Artículos Actualizados Recientemente

Show More Please wait
Version Date Comment
Current Version (v. 3) Jan 19, 2022 20:03 H. Samuel Casuy D.
v. 2 Jan 19, 2022 19:40 H. Samuel Casuy D.
v. 1 Jan 19, 2022 19:30 H. Samuel Casuy D.



 

 

(c) 2020 por SIFC.O, S.A.