Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
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: "Manual SIFCO" url: "https://sifco.atlassian.net/wiki/x/9ISo" produces: - application/json paths: /WSIngresarClientes: post: tags: - WSIngresarClientes operationId: "WSIngresarClientes" summary: "IngresarWSIngresar Clientes al Sistema" parameters: - inname: header"WSIngresarClientesInput" namein: Content-Type"body" typerequired: "string"false requiredschema: true default$ref: application/json"#/definitions/WSIngresarClientesInput" - inresponses: header name200: Authorization typedescription: "stringSuccessful operation" requiredschema: true default$ref: OAuth <Access Token>"#/definitions/WSIngresarClientesOutput" 404: - in: header description: "Not found" namesecurity: GENEXUS-AGENT - OAuth2: [] ApiKeyAuth1: [] typesecurityDefinitions: "string" OAuth2: type: oauth2 required: true flow: password default: SmartDevice ApplicationtokenUrl: https://test.sifco.org/DemoCoopGT/oauth/access_token scopes: - nameExecute: "WSIngresarClientesInput"Permite el método tipo GET inInsert: "body"Permite el método tipo POST requiredUpdate: falsePermite el método tipo PUT schemaDelete: Permite el método tipo DELETE $refFullControl: "#/definitions/WSIngresarClientesInput" responses: 200Permite el manejo de los Cuatro Métodos GET, POST, PUT,DELETE, sobre el Web Service ApiKeyAuth1: type: apiKey descriptionin: "Successfulheader operation" name: granttype definitions: schemaWSIngresarClientesInput: properties: $refModo: "#/definitions/WSIngresarClientesOutput" 401type: "string" descriptionConsultaFormaIdentificar: "Not Authenticated" schematype: "integer" $refformat: "#/definitions/GxJsonErrorint32" ConsultaValorIdentificador: 404: type: "string" description: "Not found" WSCliente: schemadescription: WSInformacion Cliente $ref: "#/definitions/GxJsonErrorWSInformacionCliente" WSInformacionCliente: 400properties: CodigoCliente: description: "Bad request" description: Código del Cliente schema: type: "integer" $refformat: "#/definitions/GxJsonErrorint64" TipoDePersona: 500: description: Tipo de description:Persona "Internal server error" type: "string" schema: TipoIdentificacion: $refdescription: "#/definitions/GxJsonError" security: Tipo de Identificación - OAuth2: [] ApiKeyAuth1type: [] securityDefinitions:"integer" OAuth2: typeformat: oauth2"int32" flow: password DocumentoIdentificacionPais: tokenUrl: https://test.sifco.org/DemoCoopGT/oauth/access_token scopesdescription: Pais de Emisión Documento Execute: Permite el método tipo GETtype: "integer" Insert: Permite el método tipo POSTformat: "int64" UpdateDocumentoIdentificacionDepartamento: Permite el método tipo PUT description: Código Región Delete:Emisión PermiteIdentifi el método tipo DELETE type: "integer" FullControl: Permite el manejo de los Cuatro Métodos GET, POST, PUT,DELETE, sobre el Web Serviceformat: "int64" ApiKeyAuth1DocumentoIdentificacionMunicipio: typedescription: apiKeyDepartamento Emisión Identific in: header nametype: granttype"integer" definitions: WSIngresarClientesInput: format: "int64" properties: ModoDocumentoIdentificacionZona: description: ModoCódigo deMunicipio Acceso al Cliente en el SistemaEmisión Ident type: "stringinteger" ConsultaFormaIdentificar: format: "int64" description: Manera como se identifica el Cliente en el Sistema. NumeroIdentificacion: description: Número de Identificación Clien type: "integer" formattype: "int32string" ConsultaValorIdentificadorPrimerNombre: description: ValorPrimer comoNombre se identifica el Cliente en el Sistema. type: "string" WSCliente SegundoNombre: description: WSInformacionSegundo ClienteNombre $reftype: "#/definitions/WSInformacionCliente"string" WSInformacionClientePrimeApellido: propertiesdescription: Primer Apellido CodigoCliente: type: "string" description: Código del ClienteSegundoApellido: typedescription: Segundo "integer"Apellido formattype: "int64string" TipoDePersonaApellidoCasada: description: TipoApellido de PersonaCasada type: "string" TipoIdentificacionSexo: description: TipoSexo de IdentificaciónCliente type: "integerstring" format: "int32" DocumentoIdentificacionPaisFechaNacimiento: description: PaísFecha de Emisión DocumentoNacimiento type: "integerstring" format: "int64date" DocumentoIdentificacionDepartamentoEstadoCivil: description: Código Región Emisión IdentificaciónEstado Civil type: "integer" format: "int64int32" DocumentoIdentificacionMunicipioNombreJuridico: description: DepartamentoNombre Emisiónde IdentificaciónEmpresa o Sociedad type: "integer" format type: "int64string" DocumentoIdentificacionZonaRepresentanteLegal: description: CódigoNombre Municipiodel EmisiónRepresentante IdentificaciónLegal type: "integerstring" format: "int64" NumeroRegistroMercantil: NumeroIdentificacion: description: Número de IdentificaciónRegistro ClientesMercantil type: "string" PrimerNombreFechaConstitucion: description: Fecha Primerde NombreConstitución type: "string" SegundoNombreformat: "date" descriptionGrupo: Segundo Nombre description: typeCódigo del Grupo de Afinidad type: "integer" format: "stringint64" PrimeApellidoNumeroIdentificacionTributaria: description: Número de PrimerIdentificación ApellidoTributaria type: "string" SegundoApellidoPromotor: description: SegundoCódigo ApellidoPromotor type: "string" ApellidoCasadaAfectoAImpuestos: description: ApellidoAfecto dea CasadaImpuestos type: "string" SexoEstadoCliente: description: SexoEstado del Cliente type: "string" FechaNacimientoCodigoReferencia: description: Fecha de NacimientoReferencia type: "string" formatActividadEconomica: "date" EstadoCivildescription: Código de description: Estado Civilactividad económica type: "integer" format: "int32" NombreJuridicoDireccionEMailPrincipal: description: Nombre de Empresa o SociedadCorreo Electrónico type: "string" RepresentanteLegalDireccionEMailSecundario: description: NombreCorreo delElectrónico Representante LegalAlternativo type: "string" NumeroRegistroMercantilExcluirDeMensajesDeCorreo: description: NúmeroExcluir de RegistroCorreos MercantilElectronicos type: "stringinteger" FechaConstitucionformat: "int32" descriptionParametrosExtendidos_B1Integration: Fecha de Constitución description: Parametros type: "string"Extendidos_B1 Integration format$ref: "date#/definitions/ParametrosExtendidos_B1Integration" GrupoPrestamos: descriptiontype: Códigoarray del Grupo de Afinidad items: type: "integer" description: Prestamo format: "int64" NumeroIdentificacionTributaria$ref: "#/definitions/WSInformacionCliente.Prestamos" description: Número de Identificación TributariaCuentasAhorro: type: array "string" Promotoritems: description: CuentaAhorro Código Promotor type$ref: "string#/definitions/WSInformacionCliente.CuentasAhorro" AfectoAImpuestosCalificadoresAdicionales: descriptiontype: Afectoarray a Impuestos items: type: "string" EstadoClientedescription: CalificadorAdicional description: Estado del Cliente $ref: "#/definitions/WSInformacionCliente.CalificadoresAdicionales" CuentasBancarias: type: array "string" CodigoReferenciaitems: description: CuentaBancaria Referencia type$ref: "string#/definitions/WSInformacionCliente.CuentasBancarias" ActividadEconomicaTelefonos: descriptiontype: array Código de actividad económica items: type: "integer" description: Telefono format: "int32" DireccionEMailPrincipal$ref: "#/definitions/WSInformacionCliente.Telefonos" descriptionDirecciones: Correo Electrónico type: array "string" DireccionEMailSecundarioitems: description: CorreoDireccion Electrónico Alternativo type$ref: "string#/definitions/WSInformacionCliente.Direcciones" ExcluirDeMensajesDeCorreoRefPersonales: descriptiontype: Excluirarray de Correos Electrónicos items: type: "integer" formatdescription: "int32"Referencia ParametrosExtendidos_B1Integration: $ref: "#/definitions/WSInformacionCliente.RefPersonales" descriptionWSInformacionCliente.Prestamos: Parámetros Extendidos_B1 Integration properties: $refNumeroPrestamo: "#/definitions/ParametrosExtendidos_B1Integration" Prestamos:description: Número del Préstamo type: array"string" itemsNombrePrestamo: description: PréstamoNombre del Préstamo $reftype: "#/definitions/WSInformacionCliente.Prestamosstring" CuentasAhorroProducto: typedescription: Codigo arrayProducto itemstype: "integer" descriptionformat: CuentaAhorro"int32" SubProducto: $ref: "#/definitions/WSInformacionCliente.CuentasAhorro" description: Código SubProducto CalificadoresAdicionales:Colocacion type: array"integer" itemsformat: "int32" Saldo: description: CalificadorAdicionalSaldo de Capital $reftype: "#/definitions/WSInformacionCliente.CalificadoresAdicionales"number" CuentasBancariasformat: "double" typex-gx-level: "WSInformacionCliente" WSInformacionCliente.CuentasAhorro: array properties: items: NumeroCuenta: description: CuentaBancariaNumero Cuenta $reftype: "#/definitions/WSInformacionCliente.CuentasBancariasstring" TelefonosProducto: typedescription: Codigo arrayProducto itemstype: "integer" descriptionformat: Teléfono"int32" SubProducto: $ref: "#/definitions/WSInformacionCliente.Telefonos" description: Código del Direcciones:SubProducto type: array"integer" itemsformat: "int32" descriptionTieneCondicionesEspeciales: Dirección description: Tiene Condiciones Especiales $ref: "#/definitions/WSInformacionCliente.Direcciones" RefPersonalestype: "string" typeFrecuenciaCondicionesEspeciales: array itemsdescription: Código de la Frecuencia description: Referencia type: "integer" $refformat: "#/definitions/WSInformacionCliente.RefPersonalesint32" ParametrosExtendidos_B1Integration MontoDescuentoPlanilla: properties: description: Monto Descuento CentrosDeCosto:Planilla type: array"number" items:format: "double" FrecuenciaDescuentoPlanilla: description: Código CentroDeCostode la Frecuencia $reftype: "#/definitions/ParametrosExtendidos_B1Integration.CentrosDeCosto"integer" Proyectosformat: "int32" typeReferencia: array description: items:Cuenta de Referencia descriptiontype: Proyecto"string" Monto: $ref: "#/definitions/ParametrosExtendidos_B1Integration.Proyectos" Transacciones:description: Monto type: array"number" itemsformat: "double" x-gx-level: "WSInformacionCliente" descriptionWSInformacionCliente.CalificadoresAdicionales: Transacciones properties: $refCodigoCalificador: "#/definitions/ParametrosExtendidos_B1Integration.Transacciones" Seriesdescription: Código type: array"integer" items:format: "int32" ValorCalificador: description: Serie Valor del calificador adicional type: "string" $ref x-gx-level: "#/definitions/ParametrosExtendidos_B1Integration.SeriesWSInformacionCliente" ParametrosExtendidos_B1IntegrationWSInformacionCliente.CentrosDeCostoCuentasBancarias: properties: SecuenciaCorrelativo: description: SecuenciaReferencia Bancaria type: "integer" format: "int32" CodigoCCSAPCodigoBanco: description: CódigoCodigo CCSAPBanco type: "integer" format: "stringint32" NombreCCSAPTipoCuenta: description: Tipo Nombrede CCSAPCuenta type: "stringinteger" CodigoCCSifcoformat: "int32" descriptionNumeroCuenta: Código CCSifco description: Número type: "integer"de la Cuenta formattype: "int32string" NombreCCSifcoEstadoReferencia: description: Nombre CCSifco Estatus de la Referencia Banca type: "string" x-gx-level: "ParametrosExtendidos_B1IntegrationWSInformacionCliente" ParametrosExtendidos_B1IntegrationWSInformacionCliente.ProyectosTelefonos: properties: SecuenciaCorrelativo: description: Correlativo por Secuenciacliente type: "integer" format: "int32" CodigoProyectoSAPTipoTelefono: description: CódigoTipo Proyectode SAPtelefono type: "string"integer" format: "int32" NombreCCSAPNumeroTelefono: description: NombreNúmero CCSAPtelefonico type: "string" CodigoCCSifcoObservacionTelefono: description: CódigoObservaciones CCSifco type: "integerstring" x-gx-level: "WSInformacionCliente" format: "int32" WSInformacionCliente.Direcciones: properties: NombreCCSifcoCorrelativo: description: NombreCorrelativo de CCSifcoDirección type: "stringinteger" x-gx-levelformat: "ParametrosExtendidos_B1Integrationint32" ParametrosExtendidos_B1Integration.Transacciones: TipoDireccion: properties: InterfazarCodigosDeTransacciondescription: Tipo de Dirección description: Interfazar Códigos De Transaccióntype: "integer" typeformat: "booleanint32" NombreCampoSAPDireccionPais: description: NombreCódigo Campopais SAPdirección type: "stringinteger" x-gx-levelformat: "ParametrosExtendidos_B1Integrationint64" ParametrosExtendidos_B1Integration.Series: DireccionDepartamento: properties: ObjetoDeNegociodescription: Código Región Dirección description: Objeto De Negocio type: "type: "integer" format: "int32int64" CodigoSerieSAPDireccionMunicipio: description: Código SerieDepartamento SAPDirección type: "stringinteger" NombreSerieSAPformat: "int64" descriptionDireccionZona: Nombre Serie SAP description: Código Municipio Dirección type: "string" x-gx-leveltype: "ParametrosExtendidos_B1Integrationinteger" WSInformacionCliente.Prestamos: format: "int64" properties: NumeroPrestamoDireccion: description: Número del PréstamoDirección type: "string" NombrePrestamoCodigoPostal: description: NombreCódigo del PréstamoPostal type: "string" ProductoGeolocalizacion: description: Codigo ProductoGeolocalización type: "integerstring" formatDireccionEmpresaDondeLabora: "int32" SubProductodescription: Nombre de la empresa donde labora description: Código SubProducto Colocación type: "integerstring" formatPuesto: "int32" Saldodescription: Puesto en description: Saldo de Capitalla empresa type: "number" format: "double"string" x-gx-level: "WSInformacionCliente" WSInformacionCliente.CuentasAhorroRefPersonales: properties: NumeroCuentaCorrelativo: description: Correlativo de NumeroReferencia CuentaPersonal type: "stringinteger" Producto format: "int32" descriptionTipoPersona: Código Producto description: Tipo de type: "integer"Persona Referencia formattype: "int32string" SubProductoNombre: description: CódigoReferencia del SubProductoNombre type: "integerstring" format: "int32" Direccion: TieneCondicionesEspeciales: description: TieneDirección CondicionesReferencia EspecialesPersonal type: "string" FrecuenciaCondicionesEspecialesCodigoPostal: description: Código dePostal laRef. FrecuenciaPersonal type: "integer" format: "int32int64" MontoDescuentoPlanillaTelefono: description: MontoTeléfono DescuentoReferencia PlanillaPersonal type: "numberstring" formatFax: "double" FrecuenciaDescuentoPlanilla:description: FAX Referencia Personal description: Código de la Frecuenciatype: "string" email: type: "integer"description: Correo Electrónico Ref. Per. formattype: "int32string" ReferenciaTipoRelalcion: description: CuentaTipo de ReferenciaRelación type: "string" MontoDetalle: description: Monto Detalles de la Referencia type: "numberstring" Estatus: format: "double" x-gx-level: "WSInformacionCliente" description: Estatus de la Referencia Per. WSInformacionCliente.CalificadoresAdicionales: propertiestype: "string" CodigoCalificadorCelular: description: Celular referencia Códigopersonal type: "integerstring" formatx-gx-level: "int32WSInformacionCliente" ParametrosExtendidos_B1Integration: ValorCalificadorproperties: CentrosDeCosto: description: Valor del calificador adicional type: array type: "string" items: x-gx-level: "WSInformacionCliente" WSInformacionCliente.CuentasBancariasdescription: CentroDeCosto properties: Correlativo$ref: "#/definitions/ParametrosExtendidos_B1Integration.CentrosDeCosto" descriptionProyectos: Referencia Bancaria type: "integer"array formatitems: "int32" CodigoBancodescription: Proyecto description: Código Banco $ref: "#/definitions/ParametrosExtendidos_B1Integration.Proyectos" typeTransacciones: "integer" format$ref: "int32#/definitions/ParametrosExtendidos_B1Integration.Transacciones" TipoCuentaSeries: descriptiontype: Tipoarray de Cuenta items: type: "integer" format: "int32"description: Serie NumeroCuenta$ref: "#/definitions/ParametrosExtendidos_B1Integration.Series" descriptionFormaDePago: Número de la Cuenta $ref: "#/definitions/ParametrosExtendidos_B1Integration.FormaDePago" typePagosTransferencia: "string" EstadoReferenciatype: array descriptionitems: Estatus de la Referencia Bancaria description: PagoTransferencia type: "string" x-gx-level$ref: "WSInformacionCliente#/definitions/ParametrosExtendidos_B1Integration.PagosTransferencia" WSInformacionClienteParametrosExtendidos_B1Integration.TelefonosCentrosDeCosto: properties: CorrelativoSecuencia: description: Correlativo por clienteSecuencia type: "integer" format: "int32" TipoTelefonoCodigoCCSAP: description: TipoCodigo de teléfonoCCSAP type: "integerstring" formatNombreCCSAP: "int32" NumeroTelefonodescription: Nombre CCSAP description: Número telefónico type: "string" CodigoCCSifco: description: Codigo CCSifco type: "string"integer" format: "int32" ObservacionTelefonoNombreCCSifco: description: ObservacionesNombre CCSifco type: "string" x-gx-level: "WSInformacionClienteParametrosExtendidos_B1Integration" WSInformacionClienteParametrosExtendidos_B1Integration.DireccionesProyectos: properties: CorrelativoSecuencia: description: Correlativo de DirecciónSecuencia type: "integer" format: "int32" TipoDireccionCodigoProyectoSAP: description: TipoCodigo deProyecto DirecciónSAP type: "integer"string" NombreCCSAP: description: formatNombre CCSAP type: "int32string" DireccionPaisCodigoCCSifco: description: CódigoCodigo país direcciónCCSifco type: "integer" format: "int64int32" DireccionDepartamentoNombreCCSifco: description: CódigoNombre RegiónCCSifco Dirección type: "integerstring" formatx-gx-level: "int64ParametrosExtendidos_B1Integration" ParametrosExtendidos_B1Integration.Transacciones: DireccionMunicipio: properties: descriptionInterfazarCodigosDeTransaccion: Código Departamento Dirección description: Interfazar Codigos type: "integer"De Transaccion formattype: "int64boolean" DireccionZonaNombreCampoSAP: description: CódigoNombre MunicipioCampo DirecciónSAP type: "integerstring" formatx-gx-level: "int64ParametrosExtendidos_B1Integration" ParametrosExtendidos_B1Integration.Series: Direccion: properties: descriptionObjetoDeNegocio: Dirección typedescription: "string"Objeto De Negocio CodigoPostal: descriptiontype: Código"integer" Postal typeformat: "stringint32" GeolocalizacionCodigoSerieSAP: description: GeolocalizaciónCodigo Serie SAP type: "string" DireccionEmpresaDondeLaboraNombreSerieSAP: description: Nombre deSerie laSAP empresa donde labora type: "string" Puesto: description: Puesto en la empresa type: "string" x-gx-level: "WSInformacionClienteParametrosExtendidos_B1Integration" WSInformacionClienteParametrosExtendidos_B1Integration.RefPersonalesFormaDePago: properties: CorrelativoInterfazFormaDePago: description: CorrelativoInterfaz deForma ReferenciaDe PersonalPago type: "integerboolean" formatTarjetasDeCredito: "int32" TipoPersonatype: array descriptionitems: Tipo de Persona Referencia description: TarjetaDeCredito type: "string" Nombre$ref: "#/definitions/ParametrosExtendidos_B1Integration.FormaDePago.TarjetasDeCredito" descriptionx-gx-level: Referencia"ParametrosExtendidos_B1Integration" Nombre ParametrosExtendidos_B1Integration.FormaDePago.TarjetasDeCredito: type: "string"properties: DireccionCodigoTarjetaCredito: description: DirecciónCodigo ReferenciaTarjeta PersonalCredito type: "string" CodigoPostalFormatoTarjetaCredito: description: CódigoFormato Postalde Ref.Identificación Personal type: "integerstring" format: "int64" ExpresionTarjetaCredito: Telefono: description: TeléfonoExpresión Referencia PersonalRegular type: "string" Faxx-gx-level: "ParametrosExtendidos_B1Integration.FormaDePago" descriptionParametrosExtendidos_B1Integration.PagosTransferencia: FAX Referencia Personal properties: typeCodigoPagoTransferencia: "string" emaildescription: Codigo Pago Transferencia description: Correo Electrónico Ref. Per.type: "integer" typeformat: "stringint32" TipoRelalcionDescripcionPagoTransferencia: description: TipoDescripcion dePago RelaciónTransferencia type: "string" DetalleCtaContablePagoTransferencia: description: DetallesCta deContable laPago ReferenciaTransferencia type: "string" EmpCodPagoTransferencia: description: Código Empresa Estatus type: "integer" format: "int32" TrxCodPagoTransferencia: description: EstatusCódigo de la Referencia Per. Transacción type: "integer" typeformat: "stringint32" CelularUsoPagoTransferencia: description: CelularUso referenciaPago personalTransferencia type: "string" x-gx-level: "WSInformacionClienteParametrosExtendidos_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: descriptiontype: Código de Error"string" typemessage: "string" messagetype: "string" description: Mensaje de Error 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
language | json |
---|
|
|
|
| ||||||
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
| ||||||||||||
|