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 | |
DocumentoIdentificacionPais | |
DocumentoIdentificacionDepartamento | |
DocumentoIdentificacionMunicipio | |
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 | |
Promotor | |
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 | |
WSIngresarClientesInput >WSInformacionCliente >WSInformacionCliente.Prestamo | |
Producto | |
SubProducto | |
WSIngresarClientesInput >WSInformacionCliente >WSInformacionCliente.CuentasAhorro | |
Producto | |
SubProducto | |
TieneCondicionesEspeciales | Constantes asociadas a variables preestablecidas por la Aplicación SIFCO WEB. |
FrecuenciaDescuentoPlanilla | |
WSIngresarClientesInput >WSInformacionCliente >WSInformacionCliente.CalificadoresAdicionales | |
CodigoCalificador | |
WSIngresarClientesInput >WSInformacionCliente >WSInformacionCliente.CuentasBancarias | |
CodigoBanco | |
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 | |
DireccionDepartamento | |
DireccionMunicipio |
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.
El siguiente ejemplo inserta un cliente en la Aplicación SIFCO WEB.
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": "string",
"ConsultaFormaIdentificar": 0,
"ConsultaValorIdentificador": "string",
"WSCliente": {
"CodigoCliente": 0,
"TipoDePersona": "string",
"TipoIdentificacion": 0,
"DocumentoIdentificacionPais": 0,
"DocumentoIdentificacionDepartamento": 0,
"DocumentoIdentificacionMunicipio": 0,
"DocumentoIdentificacionZona": 0,
"NumeroIdentificacion": "string",
"PrimerNombre": "string",
"SegundoNombre": "string",
"PrimeApellido": "string",
"SegundoApellido": "string",
"ApellidoCasada": "string",
"Sexo": "string",
"FechaNacimiento": "2019-09-18",
"EstadoCivil": 0,
"NombreJuridico": "string",
"RepresentanteLegal": "string",
"NumeroRegistroMercantil": "string",
"FechaConstitucion": "2019-09-18",
"Grupo": 0,
"NumeroIdentificacionTributaria": "string",
"Promotor": "string",
"AfectoAImpuestos": "string",
"EstadoCliente": "string",
"CodigoReferencia": "string",
"ActividadEconomica": 0,
"DireccionEMailPrincipal": "string",
"DireccionEMailSecundario": "string",
"ExcluirDeMensajesDeCorreo": 0,
"ParametrosExtendidos_B1Integration": {
"CentrosDeCosto": [
{
"Secuencia": 0,
"CodigoCCSAP": "string",
"NombreCCSAP": "string",
"CodigoCCSifco": 0,
"NombreCCSifco": "string"
}
],
"Proyectos": [
{
"Secuencia": 0,
"CodigoProyectoSAP": "string",
"NombreCCSAP": "string",
"CodigoCCSifco": 0,
"NombreCCSifco": "string"
}
],
"Transacciones": [
{
"InterfazarCodigosDeTransaccion": true,
"NombreCampoSAP": "string"
}
],
"Series": [
{
"ObjetoDeNegocio": 0,
"CodigoSerieSAP": "string",
"NombreSerieSAP": "string"
}
]
},
"Prestamos": [
{
"NumeroPrestamo": "string",
"NombrePrestamo": "string",
"Producto": 0,
"SubProducto": 0,
"Saldo": 0
}
],
"CuentasAhorro": [
{
"NumeroCuenta": "string",
"Producto": 0,
"SubProducto": 0,
"TieneCondicionesEspeciales": "string",
"FrecuenciaCondicionesEspeciales": 0,
"MontoDescuentoPlanilla": 0,
"FrecuenciaDescuentoPlanilla": 0,
"Referencia": "string",
"Monto": 0
}
],
"CalificadoresAdicionales": [
{
"CodigoCalificador": 0,
"ValorCalificador": "string"
}
],
"CuentasBancarias": [
{
"Correlativo": 0,
"CodigoBanco": 0,
"TipoCuenta": 0,
"NumeroCuenta": "string",
"EstadoReferencia": "string"
}
],
"Telefonos": [
{
"Correlativo": 0,
"TipoTelefono": 0,
"NumeroTelefono": "string",
"ObservacionTelefono": "string"
}
],
"Direcciones": [
{
"Correlativo": 0,
"TipoDireccion": 0,
"DireccionPais": 0,
"DireccionDepartamento": 0,
"DireccionMunicipio": 0,
"DireccionZona": 0,
"Direccion": "string",
"CodigoPostal": "string",
"Geolocalizacion": "string",
"DireccionEmpresaDondeLabora": "string",
"Puesto": "string"
}
]
}
}
|
200 (Successful operation) Operación Exitosa | {
"CodigoCliente": 0,
"ConsultaResultados": [
{
"CodigoCliente": 0,
"TipoDePersona": "string",
"TipoIdentificacion": 0,
"DocumentoIdentificacionPais": 0,
"DocumentoIdentificacionDepartamento": 0,
"DocumentoIdentificacionMunicipio": 0,
"DocumentoIdentificacionZona": 0,
"NumeroIdentificacion": "string",
"PrimerNombre": "string",
"SegundoNombre": "string",
"PrimeApellido": "string",
"SegundoApellido": "string",
"ApellidoCasada": "string",
"Sexo": "string",
"FechaNacimiento": "2019-09-18",
"EstadoCivil": 0,
"NombreJuridico": "string",
"RepresentanteLegal": "string",
"NumeroRegistroMercantil": "string",
"FechaConstitucion": "2019-09-18",
"Grupo": 0,
"NumeroIdentificacionTributaria": "string",
"Promotor": "string",
"AfectoAImpuestos": "string",
"EstadoCliente": "string",
"CodigoReferencia": "string",
"ActividadEconomica": 0,
"DireccionEMailPrincipal": "string",
"DireccionEMailSecundario": "string",
"ExcluirDeMensajesDeCorreo": 0,
"ParametrosExtendidos_B1Integration": {
"CentrosDeCosto": [
{
"Secuencia": 0,
"CodigoCCSAP": "string",
"NombreCCSAP": "string",
"CodigoCCSifco": 0,
"NombreCCSifco": "string"
}
],
"Proyectos": [
{
"Secuencia": 0,
"CodigoProyectoSAP": "string",
"NombreCCSAP": "string",
"CodigoCCSifco": 0,
"NombreCCSifco": "string"
}
],
"Transacciones": [
{
"InterfazarCodigosDeTransaccion": true,
"NombreCampoSAP": "string"
}
],
"Series": [
{
"ObjetoDeNegocio": 0,
"CodigoSerieSAP": "string",
"NombreSerieSAP": "string"
}
]
},
"Prestamos": [
{
"NumeroPrestamo": "string",
"NombrePrestamo": "string",
"Producto": 0,
"SubProducto": 0,
"Saldo": 0
}
],
"CuentasAhorro": [
{
"NumeroCuenta": "string",
"Producto": 0,
"SubProducto": 0,
"TieneCondicionesEspeciales": "string",
"FrecuenciaCondicionesEspeciales": 0,
"MontoDescuentoPlanilla": 0,
"FrecuenciaDescuentoPlanilla": 0,
"Referencia": "string",
"Monto": 0
}
],
"CalificadoresAdicionales": [
{
"CodigoCalificador": 0,
"ValorCalificador": "string"
}
],
"CuentasBancarias": [
{
"Correlativo": 0,
"CodigoBanco": 0,
"TipoCuenta": 0,
"NumeroCuenta": "string",
"EstadoReferencia": "string"
}
],
"Telefonos": [
{
"Correlativo": 0,
"TipoTelefono": 0,
"NumeroTelefono": "string",
"ObservacionTelefono": "string"
}
],
"Direcciones": [
{
"Correlativo": 0,
"TipoDireccion": 0,
"DireccionPais": 0,
"DireccionDepartamento": 0,
"DireccionMunicipio": 0,
"DireccionZona": 0,
"Direccion": "string",
"CodigoPostal": "string",
"Geolocalizacion": "string",
"DireccionEmpresaDondeLabora": "string",
"Puesto": "string"
}
]
}
],
"Messages": [
{
"Id": "string",
"Type": 0,
"Description": "string"
}
],
"Result": "string"
}
|
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"
}
}
{
"CodigoCliente": 0,
"ConsultaResultados": []
}
|
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 Errores) External Call Out, donde se describe el listado de errores 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.
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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
