Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Web Services para Ingresar Clientes al Sistema.
Note |
---|
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 Sistema 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. |
DESCRIPCIÓN.
Este Web Service, es uno de los fundamentales de este grupo de API’s RESTfuldebido 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 WEBdado 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. |
Swagger open api macro |
---|
swagger: '2.0' info: title: "SIFCO_REST_API" version: "1.0" termsOfService: "https://sifco.org/sobre-nosotros/" contact: email: "soporte@sifco.org" license: name: "Apache 2.0" url: "http://www.apache.org/licenses/LICENSE-2.0.html" host: "<SERVER>" schemes: - https - http basePath: /<APPDIR>/rest tags: - name: "WSIngresarClientes" externalDocs: description: "NotManual foundSIFCO" url: "https://sifco.atlassian.net/wiki/x/9ISo" produces: - application/json schemapaths: /WSIngresarClientes: post: $ref tags: "#/definitions/GxJsonError" - 400:WSIngresarClientes operationId: "WSIngresarClientes" description: "Bad request" summary: "WSIngresar Clientes" schemaparameters: - $refname: "#/definitions/GxJsonErrorWSIngresarClientesInput" 500 in: "body" descriptionrequired: "Internal server error"false schema: $ref: "#/definitions/GxJsonErrorWSIngresarClientesInput" security: - OAuth2responses: [] ApiKeyAuth1200: [] securityDefinitions: OAuth2: typedescription: "Successful oauth2operation" flow: password tokenUrl: https://schema: $ref: "#/definitions/WSIngresarClientesOutput" 404: description: "Not found" security: - OAuth2: [] ApiKeyAuth1: [] securityDefinitions: OAuth2: type: oauth2 flow: password tokenUrl: https://test.sifco.org/DemoCoopGT/oauth/access_token scopes: Execute: Permite el método tipo GET Insert: Permite el método tipo POST Update: Permite el método tipo PUT Delete: Permite el método tipo DELETE FullControl: Permite el manejo de los Cuatro Métodos GET, POST, PUT,DELETE, sobre el Web Service ApiKeyAuth1: type: apiKey in: header name: granttype definitions: WSIngresarClientesInput: properties: Modo: type: "string" ConsultaFormaIdentificar: type: "integer" format: "int32" ConsultaValorIdentificador: type: "string" WSCliente: description: WSInformacion Cliente $ref: "#/definitions/WSInformacionCliente" WSInformacionCliente: properties: CodigoCliente: description: Código del Cliente type: "integer" format: "int64" TipoDePersona: description: Tipo de Persona type: "string" TipoIdentificacion: description: Tipo de Identificación type: "integer" format: "int32" DocumentoIdentificacionPais: description: PaísPais de Emisión Documento type: "integer" format: "int64" DocumentoIdentificacionDepartamento: description: Código Región Emisión IdentificaciónIdentifi type: "integer" format: "int64" DocumentoIdentificacionMunicipio: description: Departamento Emisión IdentificaciónIdentific type: "integer" format: "int64" DocumentoIdentificacionZona: description: Código Municipio Emisión IdentificaciónIdent type: "integer" format: "int64" NumeroIdentificacion: description: Número de Identificación ClientesClien type: "string" PrimerNombre: description: Primer Nombre type: "string" SegundoNombre: description: Segundo Nombre type: "string" PrimeApellido: description: Primer Apellido type: "string" SegundoApellido: description: Segundo Apellido type: "string" ApellidoCasada: description: Apellido de Casada type: "string" Sexo: description: Sexo Cliente type: "string" FechaNacimiento: description: Fecha de Nacimiento type: "string" format: "date" EstadoCivil: description: Estado Civil type: "integer" format: "int32" NombreJuridico: description: Nombre de Empresa o Sociedad type: "string" RepresentanteLegal: description: Nombre del Representante Legal type: "string" NumeroRegistroMercantil: description: Número de Registro Mercantil type: "string" FechaConstitucion: description: Fecha de Constitución type: "string" format: "date" Grupo: description: Código del Grupo de Afinidad type: "integer" format: "int64" NumeroIdentificacionTributaria: description: Número de Identificación Tributaria type: "string" Promotor: description: Código Promotor type: "string" AfectoAImpuestos: description: Afecto a Impuestos type: "string" EstadoCliente: description: Estado del Cliente type: "string" CodigoReferencia: description: Referencia type: "string" ActividadEconomica: description: Código de actividad económica type: "integer" format: "int32" DireccionEMailPrincipal: description: Correo Electrónico type: "string" DireccionEMailSecundario: description: Correo Electrónico Alternativo type: "string" ExcluirDeMensajesDeCorreo: description: Excluir de Correos ElectrónicosElectronicos type: "integer" format: "int32" ParametrosExtendidos_B1Integration: description: ParámetrosParametros Extendidos_B1 Integration $ref: "#/definitions/ParametrosExtendidos_B1Integration" Prestamos: type: array items: description: PréstamoPrestamo $ref: "#/definitions/WSInformacionCliente.Prestamos" CuentasAhorro: type: array items: description: CuentaAhorro $ref: "#/definitions/WSInformacionCliente.CuentasAhorro" CalificadoresAdicionales: type: array items: description: CalificadorAdicional $ref: "#/definitions/WSInformacionCliente.CalificadoresAdicionales" CuentasBancarias: type: array items: description: CuentaBancaria $ref: "#/definitions/WSInformacionCliente.CuentasBancarias" Telefonos: type: array items: description: TeléfonoTelefono $ref: "#/definitions/WSInformacionCliente.Telefonos" Direcciones: type: array items: description: DirecciónDireccion $ref: "#/definitions/WSInformacionCliente.Direcciones" ParametrosExtendidos_B1Integration: properties: CentrosDeCostoRefPersonales: type: array items: description: CentroDeCostoReferencia $ref: "#/definitions/ParametrosExtendidos_B1IntegrationWSInformacionCliente.CentrosDeCostoRefPersonales" WSInformacionCliente.Prestamos: Proyectos: properties: typeNumeroPrestamo: array description: items:Número del Préstamo descriptiontype: Proyecto"string" NombrePrestamo: $ref: "#/definitions/ParametrosExtendidos_B1Integration.Proyectos" description: Nombre del Transacciones:Préstamo type: array"string" itemsProducto: description: TransaccionesCodigo Producto $reftype: "#/definitions/ParametrosExtendidos_B1Integration.Transacciones"integer" Seriesformat: "int32" typeSubProducto: array description: items:Código SubProducto Colocacion descriptiontype: Serie"integer" $refformat: "#/definitions/ParametrosExtendidos_B1Integration.Seriesint32" ParametrosExtendidos_B1Integration.CentrosDeCosto Saldo: properties: description: Saldo de Secuencia:Capital descriptiontype: Secuencia"number" typeformat: "integerdouble" x-gx-level: "WSInformacionCliente" formatWSInformacionCliente.CuentasAhorro: "int32" properties: CodigoCCSAP NumeroCuenta: description: CódigoNumero CCSAPCuenta type: "string" NombreCCSAPProducto: description: NombreCodigo CCSAPProducto type: "integer" format: "stringint32" CodigoCCSifcoSubProducto: description: Código del CCSifcoSubProducto type: "integer" format: "int32" NombreCCSifcoTieneCondicionesEspeciales: description: NombreTiene Condiciones CCSifcoEspeciales type: "string" x-gx-level: "ParametrosExtendidos_B1Integration" ParametrosExtendidos_B1Integration.Proyectos FrecuenciaCondicionesEspeciales: properties: Secuenciadescription: Código de la Frecuencia description: Secuencia type: "integer" format: "int32" CodigoProyectoSAPMontoDescuentoPlanilla: description: CódigoMonto ProyectoDescuento SAPPlanilla type: "stringnumber" NombreCCSAPformat: "double" descriptionFrecuenciaDescuentoPlanilla: Nombre CCSAP typedescription: "string"Código de la Frecuencia CodigoCCSifco: type: "integer" description: Código CCSifcoformat: "int32" Referencia: typedescription: "integer"Cuenta de Referencia formattype: "int32string" NombreCCSifcoMonto: description: Nombre CCSifcoMonto type: "number" typeformat: "stringdouble" x-gx-level: "ParametrosExtendidos_B1IntegrationWSInformacionCliente" ParametrosExtendidos_B1IntegrationWSInformacionCliente.TransaccionesCalificadoresAdicionales: properties: InterfazarCodigosDeTransaccionCodigoCalificador: description: Interfazar Códigos De TransacciónCódigo type: "integer" typeformat: "booleanint32" NombreCampoSAPValorCalificador: description: NombreValor del Campocalificador SAPadicional type: "string" x-gx-level: "ParametrosExtendidos_B1IntegrationWSInformacionCliente" ParametrosExtendidos_B1IntegrationWSInformacionCliente.SeriesCuentasBancarias: properties: ObjetoDeNegocioCorrelativo: description: ObjetoReferencia DeBancaria Negocio type: "integer" format: "int32" CodigoSerieSAPCodigoBanco: description: CódigoCodigo Serie SAPBanco type: "stringinteger" NombreSerieSAPformat: "int32" descriptionTipoCuenta: Nombre Serie SAP description: Tipo de Cuenta type: "string" x-gx-leveltype: "ParametrosExtendidos_B1Integrationinteger" WSInformacionCliente.Prestamos: format: "int32" properties: NumeroPrestamoNumeroCuenta: description: Número delde la PréstamoCuenta type: "string" NombrePrestamoEstadoReferencia: description: Estatus de Nombrela delReferencia PréstamoBanca type: "string" Producto:x-gx-level: "WSInformacionCliente" WSInformacionCliente.Telefonos: description properties: Codigo Producto Correlativo: description: Correlativo por cliente type: "integer" format: "int32" SubProductoTipoTelefono: description: CódigoTipo SubProductode Colocacióntelefono type: "integer" format: "int32" SaldoNumeroTelefono: description: SaldoNúmero de Capitaltelefonico type: "numberstring" formatObservacionTelefono: description: Observaciones type: "doublestring" x-gx-level: "WSInformacionCliente" WSInformacionCliente.CuentasAhorroDirecciones: properties: NumeroCuentaCorrelativo: description: Correlativo Numerode CuentaDirección type: "integer" format: "stringint32" ProductoTipoDireccion: description: CódigoTipo de ProductoDirección type: "integer" format: "int32" SubProductoDireccionPais: description: Código delpais SubProductodirección type: "integer" format: "int32int64" TieneCondicionesEspecialesDireccionDepartamento: description: TieneCódigo CondicionesRegión EspecialesDirección type: "integer" format: "stringint64" FrecuenciaCondicionesEspecialesDireccionMunicipio: description: Código deDepartamento laDirección Frecuencia type: "integer" format: "int32int64" MontoDescuentoPlanillaDireccionZona: description: MontoCódigo DescuentoMunicipio PlanillaDirección type: "numberinteger" format: "doubleint64" FrecuenciaDescuentoPlanillaDireccion: description: CódigoDirección de la Frecuencia type: "integerstring" formatCodigoPostal: "int32" Referencia: description: CuentaCódigo de ReferenciaPostal type: "string" MontoGeolocalizacion: description: MontoGeolocalización type: "numberstring" DireccionEmpresaDondeLabora: format: "double" x-gx-leveldescription: "WSInformacionCliente"Nombre de la empresa WSInformacionCliente.CalificadoresAdicionales: properties: CodigoCalificador: donde labora description: Código type: "integerstring" formatPuesto: "int32" ValorCalificador: description: ValorPuesto delen calificadorla adicionalempresa type: "string" x-gx-level: "WSInformacionCliente" WSInformacionCliente.CuentasBancariasRefPersonales: properties: Correlativo: description: Correlativo de Referencia BancariaPersonal type: "integer" format: "int32" CodigoBancoTipoPersona: description: Código BancoTipo de Persona Referencia type: "integerstring" formatNombre: "int32" TipoCuentadescription: Referencia Nombre description: Tipo de Cuentatype: "string" typeDireccion: "integer" formatdescription: Dirección Referencia Personal type: "int32string" NumeroCuentaCodigoPostal: description: NúmeroCódigo dePostal laRef. CuentaPersonal type: "stringinteger" EstadoReferencia format: "int64" descriptionTelefono: Estatus de la description: Teléfono Referencia BancariaPersonal type: "string" x-gx-level: "WSInformacionCliente" Fax: WSInformacionCliente.Telefonosdescription: FAX Referencia Personal properties: Correlativotype: "string" descriptionemail: Correlativo por cliente description: Correo Electrónico type: "integer"Ref. Per. formattype: "int32string" TipoTelefonoTipoRelalcion: description: Tipo de teléfonoRelación type: "integer" string" Detalle: description: Detalles de la Referencia format type: "int32string" NumeroTelefonoEstatus: description: Número telefónico Estatus de la Referencia Per. type: "string" ObservacionTelefonoCelular: description: ObservacionesCelular referencia personal type: "string" x-gx-level: "WSInformacionCliente" WSInformacionCliente.DireccionesParametrosExtendidos_B1Integration: properties: CorrelativoCentrosDeCosto: descriptiontype: Correlativoarray de Dirección items: type: "integer" formatdescription: "int32"CentroDeCosto TipoDireccion: $ref: "#/definitions/ParametrosExtendidos_B1Integration.CentrosDeCosto" description: Tipo de DirecciónProyectos: type: "integer"array format: "int32" items: DireccionPais: description: CódigoProyecto país dirección type$ref: "integer#/definitions/ParametrosExtendidos_B1Integration.Proyectos" formatTransacciones: "int64" DireccionDepartamento$ref: "#/definitions/ParametrosExtendidos_B1Integration.Transacciones" descriptionSeries: Código Región Dirección type: "integer"array formatitems: "int64" DireccionMunicipiodescription: Serie description: Código Departamento Dirección $ref: "#/definitions/ParametrosExtendidos_B1Integration.Series" typeFormaDePago: "integer" format$ref: "int64#/definitions/ParametrosExtendidos_B1Integration.FormaDePago" DireccionZonaPagosTransferencia: descriptiontype: Código Municipioarray Dirección items: type: "integer" formatdescription: "int64"PagoTransferencia Direccion: $ref: "#/definitions/ParametrosExtendidos_B1Integration.PagosTransferencia" descriptionParametrosExtendidos_B1Integration.CentrosDeCosto: Dirección properties: type Secuencia: "string" CodigoPostaldescription: Secuencia descriptiontype: Código Postal"integer" typeformat: "stringint32" GeolocalizacionCodigoCCSAP: description: Codigo GeolocalizaciónCCSAP type: "string" DireccionEmpresaDondeLaboraNombreCCSAP: description: Nombre de la empresa donde laboraCCSAP type: "string" PuestoCodigoCCSifco: description: PuestoCodigo enCCSifco la empresa type: "stringinteger" x-gx-level format: "WSInformacionClienteint32" WSIngresarClientesOutput: NombreCCSifco: properties:description: Nombre CCSifco CodigoClientetype: "string" typex-gx-level: "integerParametrosExtendidos_B1Integration" ParametrosExtendidos_B1Integration.Proyectos: formatproperties: "int64" ConsultaResultadosSecuencia: description: WSInformacion ClienteSecuencia type: "integer" typeformat: array"int32" CodigoProyectoSAP: itemsdescription: Codigo Proyecto SAP $reftype: "#/definitions/WSInformacionClientestring" Messages NombreCCSAP: description: Messages Nombre CCSAP type: array items: $ref: "#/definitions/Messages_Message" Result: type: "string" Messages_Message: properties: Id: description: Id type: "string" Type: description: Type type: "integer" format: "int32" Description: description: Description type: "string" GxJsonError: properties: error: $ref: "#/definitions/GxJsonError.error" GxJsonError.error: properties: code: description: Código de Error type: "string" message: description: Mensaje de Error type: "string" x-gx-level: "GxJsonError" |
Note |
---|
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. |
Note |
---|
RESPETE LOS ENCABEZADOS OBLIGATORIOS para que pueda consumir el WEB SERVICE respectivo. |
Code Block |
---|
Content-Type: application/json
Authorization: OAuth f2a9ec34-cf83-46f5-8862-f78ac03670d1!171380a787a9152688ab61a94d66e0eb77...
GENEXUS-AGENT: SmartDevice Application |
Warning |
---|
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.type: "string"
CodigoCCSifco:
description: Codigo CCSifco
type: "integer"
format: "int32"
NombreCCSifco:
description: Nombre CCSifco
type: "string"
x-gx-level: "ParametrosExtendidos_B1Integration"
ParametrosExtendidos_B1Integration.Transacciones:
properties:
InterfazarCodigosDeTransaccion:
description: Interfazar Codigos De Transaccion
type: "boolean"
NombreCampoSAP:
description: Nombre Campo SAP
type: "string"
x-gx-level: "ParametrosExtendidos_B1Integration"
ParametrosExtendidos_B1Integration.Series:
properties:
ObjetoDeNegocio:
description: Objeto De Negocio
type: "integer"
format: "int32"
CodigoSerieSAP:
description: Codigo Serie SAP
type: "string"
NombreSerieSAP:
description: Nombre Serie SAP
type: "string"
x-gx-level: "ParametrosExtendidos_B1Integration"
ParametrosExtendidos_B1Integration.FormaDePago:
properties:
InterfazFormaDePago:
description: Interfaz Forma De Pago
type: "boolean"
TarjetasDeCredito:
type: array
items:
description: TarjetaDeCredito
$ref: "#/definitions/ParametrosExtendidos_B1Integration.FormaDePago.TarjetasDeCredito"
x-gx-level: "ParametrosExtendidos_B1Integration"
ParametrosExtendidos_B1Integration.FormaDePago.TarjetasDeCredito:
properties:
CodigoTarjetaCredito:
description: Codigo Tarjeta Credito
type: "string"
FormatoTarjetaCredito:
description: Formato de Identificación
type: "string"
ExpresionTarjetaCredito:
description: Expresión Regular
type: "string"
x-gx-level: "ParametrosExtendidos_B1Integration.FormaDePago"
ParametrosExtendidos_B1Integration.PagosTransferencia:
properties:
CodigoPagoTransferencia:
description: Codigo Pago Transferencia
type: "integer"
format: "int32"
DescripcionPagoTransferencia:
description: Descripcion Pago Transferencia
type: "string"
CtaContablePagoTransferencia:
description: Cta Contable Pago Transferencia
type: "string"
EmpCodPagoTransferencia:
description: Código Empresa
type: "integer"
format: "int32"
TrxCodPagoTransferencia:
description: Código de Transacción
type: "integer"
format: "int32"
UsoPagoTransferencia:
description: Uso Pago Transferencia
type: "string"
x-gx-level: "ParametrosExtendidos_B1Integration"
WSIngresarClientesOutput:
properties:
CodigoCliente:
type: "integer"
format: "int64"
ConsultaResultados:
description: WSInformacion Cliente
type: array
items:
$ref: "#/definitions/WSInformacionCliente"
Messages:
description: Messages
type: array
items:
$ref: "#/definitions/Messages_Message"
Result:
type: "string"
Messages_Message:
properties:
Id:
description: Id
type: "string"
Type:
description: Type
type: "integer"
format: "int32"
Description:
description: Description
type: "string"
GxJsonError:
properties:
error:
$ref: "#/definitions/GxJsonError.error"
GxJsonError.error:
properties:
code:
type: "string"
message:
type: "string"
x-gx-level: "GxJsonError" |
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 | WSApColocacionProductosLista. |
SubProducto | WSApColocacionProductosLista. |
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 | |
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:
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 #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 |
| |||||||||||||||
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). |
|
Info |
---|
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. |
Note |
---|
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. |
Note |
---|
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. |
Note |
---|
RESPETE LOS ENCABEZADOS OBLIGATORIOS para que pueda consumir el WEB SERVICE respectivo. |
Code Block | ||
---|---|---|
| ||
Content-Type: application/json
Authorization: OAuth f2a9ec34-cf83-46f5-8862-f78ac03670d1!171380a787a9152688ab61a94d66e0eb77...
GENEXUS-AGENT: SmartDevice Application |
Warning |
---|
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. |
Tome en cuenta estos como los campos mínimos:
Cuando es una persona individual:
Code Block | ||
---|---|---|
| ||
{
"Modo": "INS",
"ConsultaFormaIdentificar": 0,
"ConsultaValorIdentificador": "",
"WSCliente": {
"TipoIdentificacion": 1,
"NumeroIdentificacion": "9999999999",
"PrimerNombre": "XXXXXX",
"SegundoNombre": "XXXXXXXX",
"PrimeApellido": "XXXXXXXX",
"SegundoApellido": "XXXXXXX",
"ApellidoCasada": "",
"FechaNacimiento": "1995-09-18",
"EstadoCivil": 2,
"ActividadEconomica": 1,
"DireccionEMailPrincipal": "XXX@sifco.org"
}
|
Cuando es una persona jurídica:
Code Block |
---|
{
"Modo": "INS",
"ConsultaFormaIdentificar": 1,
"ConsultaValorIdentificador": "0",
"WSCliente": {
"CodigoCliente": "0",
"TipoDePersona": "J",
"TipoIdentificacion": 2,
"NombreJuridico": "XXXXXXXXX",
"RepresentanteLegal": "PENDIENTE",
"NumeroIdentificacionTributaria": "99999",
}
} |
| ||||||||
---|---|---|---|---|---|---|---|---|
Enlaces Relevantes |
Artículos Relacionados
| ||||||||||||
Artículos Actualizados Recientemente
|
|