Web Services para Ingresar Clientes al Sistema.

Swagger open api macroswagger: '2.0' info: title: "SIFCO_REST_API" version: "1.0" description: "La presente documentación busca detallar los métodos que permite ejecutar este **Web Services**, como es Ingresar clientes en la **Aplicación SIFCO WEB** ." 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: "Ingresar Clientes al Sistema" parameters: - in: header name: Content-Type type: "string" required: true default: application/json - in: header name: Authorization type: "string" required: true default: OAuth <Access Token> - in: header name: GENEXUS-AGENT type: "string" required: true default: SmartDevice Application - name: "WSIngresarClientesInput" in: "body" required: false schema: $ref: "#/definitions/WSIngresarClientesInput" responses: 200: description: "Successful operation" schema: $ref: "#/definitions/WSIngresarClientesOutput" 401: description: "Not Authenticated" schema: $ref: "#/definitions/GxJsonError" 404: description: "Not found" schema: $ref: "#/definitions/GxJsonError" 400: description: "Bad request" schema: $ref: "#/definitions/GxJsonError" 500: description: "Internal server error" schema:

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: "WSIngresar Clientes"
      parameters:
        - $refname: "#/definitions/GxJsonErrorWSIngresarClientesInput"
security:   - OAuth2: []     ApiKeyAuth1in: []
securityDefinitions:"body"
     OAuth2:     typerequired: oauth2false
    flow: password     tokenUrlschema:
https://test.sifco.org/DemoCoopGT/oauth/access_token      scopes:       Execute$ref: Permite el método tipo GET"#/definitions/WSIngresarClientesInput"


        Insertresponses:
Permite el método tipo POST       Update200:
Permite el método tipo PUT       Deletedescription: Permite"Successful operation"
el método tipo DELETE       FullControlschema:
Permite  el manejo de los Cuatro Métodos GET, POST, PUT,DELETE, sobre el Web Service$ref: "#/definitions/WSIngresarClientesOutput"
   ApiKeyAuth1:     type404:
apiKey     in: header     namedescription: granttype"Not found"
definitionssecurity:
  - WSIngresarClientesInputOAuth2: []
    propertiesApiKeyAuth1: []
securityDefinitions:
    Modo:
   OAuth2:
    type: "string"oauth2
      ConsultaFormaIdentificarflow: password
    tokenUrl: https://test.sifco.org/DemoCoopGT/oauth/access_token
 type: "integer"  scopes:
      formatExecute: "int32"Permite el método tipo GET
  ConsultaValorIdentificador:    Insert: Permite el método  type: "string"tipo POST
      WSClienteUpdate: Permite el método tipo PUT
   description: WSInformacion Cliente Delete: Permite el método tipo DELETE
  $ref: "#/definitions/WSInformacionCliente"    WSInformacionClienteFullControl: Permite el manejo de properties:los Cuatro Métodos GET, POST, PUT,DELETE, sobre CodigoCliente:el Web Service
      descriptionApiKeyAuth1:
Código del Cliente  type: apiKey
     typein: "integer"header
    name: granttype

 formatdefinitions:
"int64"
  WSIngresarClientesInput:
    TipoDePersonaproperties:
        description: Tipo de PersonaModo:
        type: "string"
       TipoIdentificacionConsultaFormaIdentificar:
        descriptiontype: Tipo de Identificación"integer"
        typeformat: "integer"int32"
      ConsultaValorIdentificador:
        formattype: "int32string"
       DocumentoIdentificacionPaisWSCliente:
        description: PaísWSInformacion deCliente
Emisión Documento         type$ref: "integer#/definitions/WSInformacionCliente"

  WSInformacionCliente:
    formatproperties:
"int64"        DocumentoIdentificacionDepartamentoCodigoCliente:
        description: Código Regióndel EmisiónCliente
Identificación         type: "integer"
        format: "int64"

      DocumentoIdentificacionMunicipioTipoDePersona:
        description: DepartamentoTipo Emisiónde IdentificaciónPersona
        type: "integerstring"

       format: "int64"

      DocumentoIdentificacionZonaTipoIdentificacion:
        description: CódigoTipo Municipio Emisiónde Identificación
        type: "integer"
        format: "int64int32"

      NumeroIdentificacionDocumentoIdentificacionPais:
        description: NúmeroPais de IdentificaciónEmisión ClientesDocumento
        type: "stringinteger"
        PrimerNombreformat: "int64"

      descriptionDocumentoIdentificacionDepartamento:
Primer Nombre         typedescription: "string"Código Región Emisión Identifi
    SegundoNombre:         descriptiontype: Segundo"integer"
Nombre         typeformat: "stringint64"

      PrimeApellidoDocumentoIdentificacionMunicipio:
        description: PrimerDepartamento Emisión ApellidoIdentific
        type: "stringinteger"
       SegundoApellido format: "int64"

      descriptionDocumentoIdentificacionZona:
Segundo Apellido       description: Código Municipio type: "string"Emisión Ident
       ApellidoCasada:
        description: Apellido de Casada type: "integer"
          typeformat: "stringint64"

      SexoNumeroIdentificacion:
        description: Sexo ClienteNúmero de Identificación Clien
        type: "string"

      FechaNacimientoPrimerNombre:
        description: FechaPrimer de NacimientoNombre
        type: "string"

       formatSegundoNombre:
"date"        EstadoCivildescription: Segundo Nombre
        description: Estado Civiltype: "string"

      PrimeApellido:
        typedescription: Primer "integer"Apellido
        formattype: "int32string"

      NombreJuridicoSegundoApellido:
        description: NombreSegundo deApellido
Empresa o Sociedad
        type: "string"

      RepresentanteLegalApellidoCasada:
        description: NombreApellido delde RepresentanteCasada
Legal         type: "string"

      NumeroRegistroMercantilSexo:
        description: Número de Registro MercantilSexo Cliente
        type: "string"

      FechaConstitucionFechaNacimiento:
        description: Fecha de ConstituciónNacimiento
        type: "string"
        format: "date"

      GrupoEstadoCivil:
        description: CódigoEstado delCivil
Grupo de Afinidad
        type: "integer"
        format: "int64int32"

      NumeroIdentificacionTributariaNombreJuridico:
        description: NúmeroNombre de Empresa Identificacióno TributariaSociedad
        type: "string"

      PromotorRepresentanteLegal:
        description: Código PromotorNombre del Representante Legal
        type: "string"

      AfectoAImpuestosNumeroRegistroMercantil:
        description: Número Afectode aRegistro ImpuestosMercantil
        type: "string"

      EstadoClienteFechaConstitucion:
        description: EstadoFecha delde ClienteConstitución
        type: "string"

      CodigoReferencia:         description: Referencia
        typeformat: "stringdate"

      ActividadEconomicaGrupo:
        description: Código del Grupo de actividadAfinidad
económica         type: "integer"
        format: "int32int64"

      DireccionEMailPrincipalNumeroIdentificacionTributaria:
        description: Número de CorreoIdentificación ElectrónicoTributaria
        type: "string"

      DireccionEMailSecundarioPromotor:
        description: CorreoCódigo ElectrónicoPromotor
Alternativo         type: "string"

      ExcluirDeMensajesDeCorreoAfectoAImpuestos:
        description: ExcluirAfecto dea CorreosImpuestos
Electrónicos         type: "integerstring"

       formatEstadoCliente:
"int32"        ParametrosExtendidos_B1Integrationdescription: Estado del Cliente
     description: Parámetros Extendidos_B1 Integrationtype: "string"

      $refCodigoReferencia:
"#/definitions/ParametrosExtendidos_B1Integration"        Prestamosdescription: Referencia
        type: array"string"

       itemsActividadEconomica:
 
        description: PréstamoCódigo de actividad económica
       $ref type: "#/definitions/WSInformacionCliente.Prestamos"integer"
        CuentasAhorroformat: "int32"

      typeDireccionEMailPrincipal:
array         itemsdescription: Correo Electrónico
        descriptiontype: CuentaAhorro"string"

      DireccionEMailSecundario:
  $ref: "#/definitions/WSInformacionCliente.CuentasAhorro"     description: Correo Electrónico CalificadoresAdicionales:Alternativo
        type: array"string"

       itemsExcluirDeMensajesDeCorreo:
          description: CalificadorAdicionalExcluir de Correos Electronicos
        $reftype: "#/definitions/WSInformacionCliente.CalificadoresAdicionales"
integer"
      CuentasBancarias:         typeformat: array"int32"

       itemsParametrosExtendidos_B1Integration:

         description: CuentaBancariaParametros Extendidos_B1 Integration
        $ref: "#/definitions/WSInformacionCliente.CuentasBancariasParametrosExtendidos_B1Integration"

      TelefonosPrestamos:
        type: array
        items:
          description: TeléfonoPrestamo
          $ref: "#/definitions/WSInformacionCliente.TelefonosPrestamos"

      DireccionesCuentasAhorro:
        type: array
        items:
          description: DirecciónCuentaAhorro
          $ref: "#/definitions/WSInformacionCliente.DireccionesCuentasAhorro"

     ParametrosExtendidos_B1Integration:
    properties:
      CentrosDeCosto CalificadoresAdicionales:
        type: array
        items:
          description: CentroDeCostoCalificadorAdicional
          $ref: "#/definitions/ParametrosExtendidos_B1IntegrationWSInformacionCliente.CentrosDeCostoCalificadoresAdicionales"

      ProyectosCuentasBancarias:
        type: array
        items:
          description: ProyectoCuentaBancaria
          $ref: "#/definitions/ParametrosExtendidos_B1IntegrationWSInformacionCliente.ProyectosCuentasBancarias"

      TransaccionesTelefonos:
        type: array
        items:
          description: TransaccionesTelefono
          $ref: "#/definitions/ParametrosExtendidos_B1IntegrationWSInformacionCliente.TransaccionesTelefonos"

      SeriesDirecciones:
        type: array
        items:
          description: SerieDireccion
          $ref: "#/definitions/ParametrosExtendidos_B1IntegrationWSInformacionCliente.SeriesDirecciones"

      ParametrosExtendidos_B1Integration.CentrosDeCostoRefPersonales:
     properties:   type: array
        Secuenciaitems:
          description: Referencia
Secuencia          type$ref: "integer#/definitions/WSInformacionCliente.RefPersonales"


  WSInformacionCliente.Prestamos:
   format properties:
"int32"        CodigoCCSAPNumeroPrestamo:
        description: Número Códigodel CCSAPPréstamo
        type: "string"

      NombreCCSAPNombrePrestamo:
        description: Nombre del CCSAPPréstamo
        type: "string"

      CodigoCCSifcoProducto:
        description: CódigoCodigo CCSifcoProducto
        type: "integer"
        format: "int32"

      NombreCCSifcoSubProducto:
        description: Código NombreSubProducto CCSifcoColocacion
        type: "stringinteger"
       x-gx-level format: "ParametrosExtendidos_B1Integration"int32"

      ParametrosExtendidos_B1Integration.ProyectosSaldo:
    properties:    description: Saldo de Secuencia:Capital
        descriptiontype: Secuencia"number"
        typeformat: "integerdouble"


    x-gx-level: "WSInformacionCliente"


  format: "int32"
WSInformacionCliente.CuentasAhorro:
    properties:
      CodigoProyectoSAPNumeroCuenta:
        description: CódigoNumero Proyecto SAPCuenta
        type: "string"

      NombreCCSAPProducto:
        description: NombreCodigo CCSAPProducto
        type: "stringinteger"
        format: "int32"

      CodigoCCSifcoSubProducto:
        description: Código del CCSifcoSubProducto
        type: "integer"
        format: "int32"

      NombreCCSifcoTieneCondicionesEspeciales:
        description: NombreTiene Condiciones CCSifcoEspeciales
        type: "string"

     x-gx-level: "ParametrosExtendidos_B1Integration" FrecuenciaCondicionesEspeciales:
        ParametrosExtendidos_B1Integration.Transaccionesdescription: Código de la Frecuencia
properties:        InterfazarCodigosDeTransacciontype: "integer"
        descriptionformat: "int32"
Interfazar
Códigos De Transacción    MontoDescuentoPlanilla:
    type: "boolean"

      NombreCampoSAP:
        description: NombreMonto CampoDescuento SAPPlanilla
        type: "stringnumber"
      x-gx-level  format: "ParametrosExtendidos_B1Integrationdouble"

   ParametrosExtendidos_B1Integration.Series:     properties:
      ObjetoDeNegocioFrecuenciaDescuentoPlanilla:
        description: Código Objetode Dela NegocioFrecuencia
        type: "integer"
        format: "int32"

      CodigoSerieSAPReferencia:
        description: CódigoCuenta Seriede SAPReferencia
        type: "string"

      NombreSerieSAPMonto:
        description: Nombre Serie SAP Monto
        type: "number"
        typeformat: "stringdouble"


    x-gx-level: "ParametrosExtendidos_B1IntegrationWSInformacionCliente"


  WSInformacionCliente.PrestamosCalificadoresAdicionales:
    properties:
      NumeroPrestamoCodigoCalificador:
        description: Número del PréstamoCódigo
        type: "stringinteger"
       NombrePrestamo format: "int32"

      ValorCalificador:
        description: NombreValor del calificador Préstamoadicional
        type: "string"


     Productox-gx-level: "WSInformacionCliente"


  WSInformacionCliente.CuentasBancarias:
    properties:
      Correlativo:
        description: CodigoReferencia ProductoBancaria
        type: "integer"
        format: "int32"

      SubProductoCodigoBanco:
        description: CódigoCodigo SubProducto ColocaciónBanco
        type: "integer"
        format: "int32"

      SaldoTipoCuenta:
        description: SaldoTipo de CapitalCuenta
        type: "numberinteger"
        format: "doubleint32"

     x-gx-level: "WSInformacionCliente"


  WSInformacionCliente.CuentasAhorro NumeroCuenta:
    properties:       NumeroCuentadescription: Número de       description: Numero la Cuenta
        type: "string"

      ProductoEstadoReferencia:
        description: Código ProductoEstatus de la Referencia Banca
        type: "string"


    x-gx-level: "WSInformacionCliente"


  WSInformacionCliente.Telefonos:
    properties:
      Correlativo:
        description: Correlativo por cliente
        type: "integer"
        format: "int32"

      SubProductoTipoTelefono:
        description: CódigoTipo delde SubProductotelefono
        type: "integer"
        format: "int32"

      TieneCondicionesEspeciales:
        description: Tiene Condiciones Especiales
        type: "string"

      FrecuenciaCondicionesEspeciales:
        description: Código de la Frecuencia
        type: "integer"
        format: "int32"

      MontoDescuentoPlanilla:
        description: Monto Descuento Planilla
        type: "number"
        format: "double"

      FrecuenciaDescuentoPlanilla:
        description: Código de la Frecuencia
        type: "integer"
        format: "int32"

      Referencia:
        description: Cuenta de Referencia
        type: "string"

      Monto:
        description: Monto
        type: "number"
        format: "double"


    x-gx-level: "WSInformacionCliente"


  WSInformacionCliente.CalificadoresAdicionales:
    properties:
      CodigoCalificador:
        description: Código
        type: "integer"
        format: "int32"

      ValorCalificador:
        description: Valor del calificador adicional
        type: "string"


    x-gx-level: "WSInformacionCliente"


  WSInformacionCliente.CuentasBancarias:
    properties:
      Correlativo:
        description: Referencia Bancaria
        type: "integer"
        format: "int32"

      CodigoBanco:
        description: Código Banco
        type: "integer"
        format: "int32"

      TipoCuenta:
        description: Tipo de Cuenta
        type: "integer"
        format: "int32"

      NumeroCuenta:
        description: Número de la Cuenta
        type: "string"

      EstadoReferencia:
        description: Estatus de la Referencia Bancaria
        type: "string"


    x-gx-level: "WSInformacionCliente"


  WSInformacionCliente.Telefonos:
    properties:
      Correlativo:
        description: Correlativo por cliente
        type: "integer"
        format: "int32"

      TipoTelefono:
        description: Tipo de teléfono
        type: "integer"
        format: "int32"

      NumeroTelefono:
        description: Número telefónico
        type: "string"

      ObservacionTelefono:
        description: Observaciones
        type

      NumeroTelefono:
        description: Número telefonico
        type: "string"

      ObservacionTelefono:
        description: Observaciones
        type: "string"


    x-gx-level: "WSInformacionCliente"


  WSInformacionCliente.Direcciones:
    properties:
      Correlativo:
        description: Correlativo de Dirección
        type: "integer"
        format: "int32"

      TipoDireccion:
        description: Tipo de Dirección
        type: "integer"
        format: "int32"

      DireccionPais:
        description: Código pais dirección
        type: "integer"
        format: "int64"

      DireccionDepartamento:
        description: Código Región Dirección
        type: "integer"
        format: "int64"

      DireccionMunicipio:
        description: Código Departamento Dirección
        type: "integer"
        format: "int64"

      DireccionZona:
        description: Código Municipio Dirección
        type: "integer"
        format: "int64"

      Direccion:
        description: Dirección
        type: "string"

      CodigoPostal:
        description: Código Postal
        type: "string"

      Geolocalizacion:
        description: Geolocalización
        type: "string"

      DireccionEmpresaDondeLabora:
        description: Nombre de la empresa donde labora
        type: "string"

      Puesto:
        description: Puesto en la empresa
        type: "string"


    x-gx-level: "WSInformacionCliente"


  WSInformacionCliente.RefPersonales:
    properties:
      Correlativo:
        description: Correlativo de Referencia Personal
        type: "integer"
        format: "int32"

      TipoPersona:
        description: Tipo de Persona Referencia
        type: "string"

      Nombre:
        description: Referencia Nombre
        type: "string"

      Direccion:
        description: Dirección Referencia Personal
        type: "string"

      CodigoPostal:
        description: Código Postal Ref. Personal
        type: "integer"
        format: "int64"

      Telefono:
        description: Teléfono Referencia Personal
        type: "string"

      Fax:
        description: FAX Referencia Personal
        type: "string"

      email:
        description: Correo Electrónico Ref. Per.
        type: "string"

      TipoRelalcion:
        description: Tipo de Relación
        type: "string"

      Detalle:
        description: Detalles de la Referencia
        type: "string"

      Estatus:
        description: Estatus de la Referencia Per.
        type: "string"

      Celular:
        description: Celular referencia personal
        type: "string"


    x-gx-level: "WSInformacionCliente"
  ParametrosExtendidos_B1Integration:
    properties:
      CentrosDeCosto:
        type: array
        items:
          description: CentroDeCosto
          $ref: "#/definitions/ParametrosExtendidos_B1Integration.CentrosDeCosto"

      Proyectos:
        type: array
        items:
          description: Proyecto
          $ref: "#/definitions/ParametrosExtendidos_B1Integration.Proyectos"

      Transacciones:
        $ref: "#/definitions/ParametrosExtendidos_B1Integration.Transacciones"

      Series:
        type: array
        items:
          description: Serie
          $ref: "#/definitions/ParametrosExtendidos_B1Integration.Series"

      FormaDePago:
        $ref: "#/definitions/ParametrosExtendidos_B1Integration.FormaDePago"

      PagosTransferencia:
        type: array
        items:
          description: PagoTransferencia
          $ref: "#/definitions/ParametrosExtendidos_B1Integration.PagosTransferencia"


  ParametrosExtendidos_B1Integration.CentrosDeCosto:
    properties:
      Secuencia:
        description: Secuencia
        type: "integer"
        format: "int32"

      CodigoCCSAP:
        description: Codigo CCSAP
        type: "string"

      NombreCCSAP:
        description: Nombre CCSAP
        type: "string"

      CodigoCCSifco:
        description: Codigo CCSifco
        type: "integer"
        format: "int32"

      NombreCCSifco:
        description: Nombre CCSifco
        type: "string"


    x-gx-level: "ParametrosExtendidos_B1Integration"


  ParametrosExtendidos_B1Integration.Proyectos:
    properties:
      Secuencia:
        description: Secuencia
        type: "integer"
        format: "int32"

      CodigoProyectoSAP:
        description: Codigo Proyecto SAP
        type: "string"

      NombreCCSAP:
        description: Nombre CCSAP
        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	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:

Code Block

language	html

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

HEADERS:

Code Block

language	json

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

BODY:

Code Block

language	json

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

200 (Successful operation)

Operación Exitosa

Code Block

language	json

{
  "CodigoCliente":"0",
  "ConsultaResultados":[],
  "Messages":[],
  "Result":""
}

400 (Bad Request).

Solicitud Errada

Code Block

language	json

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

Code Block

language	json

{
  "error": {
    "code":"0",
    "message":"This service needs an Authorization Header"
  }
}
{
  "CodigoCliente":"",
  "ConsultaResultados":[],
  "Messages":[],
  "Result":""
}

404 (Not Found).

Respuesta Vacía (Web Service, no encontrado)

500 (Internal Server Error)

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

Code Block

language	json

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

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:

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

HEADERS

Code Block

language	json

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

BODY:

Code Block

language	json

{
  "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,
    "ProfesionUOficio": "string",
    "ParametrosExtendidos_B1Integration": {
      "CentrosDeCosto": [
        {
          "Secuencia": 0,
          "CodigoCCSAP": "string",
          "NombreCCSAP": "string",
          "CodigoCCSifco": 0,
          "NombreCCSifco": "string"

x-gx-level:

"WSInformacionCliente"
}
WSInformacionCliente.Direcciones:
],
properties:
"Proyectos": [
Correlativo:
{
description:

Correlativo

de

Dirección
"Secuencia": 0,
type:

"integer"

format
"CodigoProyectoSAP": "
int32
string",
TipoDireccion:
"NombreCCSAP": "string",
description:

Tipo

de

Dirección
"CodigoCCSifco": 0,
type:

"integer"

format
"NombreCCSifco": "
int32
string"

DireccionPais:
}
description:

Código

país

dirección
],
type:
"
integer
Transacciones": [
format:

"int64"
{
DireccionDepartamento:
"InterfazarCodigosDeTransaccion": true,
description:

Código

Región

Dirección
"NombreCampoSAP": "string"
type:

"integer"
}
format: "int64"
],
DireccionMunicipio
"Series": [
description:

Código
{
Departamento

Dirección

type: "integer"
"ObjetoDeNegocio": 0,
format
"CodigoSerieSAP": "
int64
string",
DireccionZona:
"NombreSerieSAP": "string"
description:

Código

Municipio

Dirección
} ]
type:

"integer"
},
format:
"
int64
Prestamos": [
Direccion:
{
description
"NumeroPrestamo":
Dirección
"string",
type
"NombrePrestamo": "string",
CodigoPostal:
"Producto": 0,
description
"SubProducto":
Código
0,
Postal

type
"Saldo":
"string"
0 }
Geolocalizacion:
],
description: Geolocalización
"CuentasAhorro": [ {
type
"NumeroCuenta": "string",
DireccionEmpresaDondeLabora:
"Producto": 0,
description
"SubProducto":
Nombre
0,
de

la

empresa

donde

labora

type
"TieneCondicionesEspeciales": "string",
Puesto:
"FrecuenciaCondicionesEspeciales": 0,
description
"MontoDescuentoPlanilla":
Puesto
0,
en la

empresa
"FrecuenciaDescuentoPlanilla": 0,
type:

"string"

x-gx-level
"Referencia": "
WSInformacionCliente
string",
WSIngresarClientesOutput:
"Monto": 0
properties:
}
CodigoCliente:
],
type:
"
integer
CalificadoresAdicionales": [ {
format:

"int64"

ConsultaResultados
"CodigoCalificador": 0,
description
"ValorCalificador":
WSInformacion Cliente
"string" }
type:

array
],
items
"CuentasBancarias": [ {
$ref:

"#/definitions/WSInformacionCliente"
"Correlativo": 0,
Messages:

description
"CodigoBanco":
Messages
0,
type
"TipoCuenta":
array
0,
items
"NumeroCuenta": "string",
$ref
"EstadoReferencia": "
#/definitions/Messages_Message
string"
Result:
} ],
type:
"
string
Telefonos": [
Messages_Message:
{
properties:

Id:
"Correlativo": 0,
description
"TipoTelefono":
Id
0,
type
"NumeroTelefono": "string",
Type:
"ObservacionTelefono": "string" } ],
description:

Type
"Direcciones": [
type:

"integer"
{
format:
"
int32
Correlativo": 0,
Description
"TipoDireccion": 0,
description
"DireccionPais":
Description
0,
type
"DireccionDepartamento":
"string"
0,
GxJsonError
"DireccionMunicipio":

0,
properties:

error:
"DireccionZona": 0,
$ref
"Direccion": "
#/definitions/GxJsonError.error"
string",
GxJsonError.error:

properties:
"CodigoPostal": "string",
code
"Geolocalizacion": "string",
description
"DireccionEmpresaDondeLabora":
Código
"string",
de

Error

type
"Puesto": "string" }
message:
],
description
"RefPersonales":[
Mensaje de Error type: "string" x-gx-level: "GxJsonError"
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:
Status
colour Green
title POST
Code Block
https://test.sifco.org/democoopgt/rest/wsingresarclientes
HEADERS
Code Block
language html
content-type: application/json authorization: OAuth f2a9ec34-cf83-46f5-8862-f78........ genexus-agent: SmartDevice Application
BODY:
{ "Correlativo":0, "TipoPersona":string, "Nombre":string, "Direccion":string, "CodigoPostal":0, "Telefono":string, "Fax":string, "email":string, "TipoRelalcion":string, "Detalle":string, "Estatus":string, "Celular":string } ] } }
200 (Successful operation)
Operación Exitosa
Code Block
language json
{ "
Modo
CodigoCliente":
"string"
0, "
ConsultaFormaIdentificar
ConsultaResultados":
0,
[
"ConsultaValorIdentificador":

"string",
{
"WSCliente": {
"CodigoCliente": 0, "TipoDePersona": "string", "TipoIdentificacion": 0,
"DocumentoIdentificacionPais": 0,
"
DocumentoIdentificacionDepartamento
DocumentoIdentificacionPais": 0,

"DocumentoIdentificacionMunicipio":

0,
"
DocumentoIdentificacionZona
DocumentoIdentificacionDepartamento": 0,

"NumeroIdentificacion":

"string",
"
PrimerNombre
DocumentoIdentificacionMunicipio":
"string"
0,
"SegundoNombre": "string",

"
PrimeApellido
DocumentoIdentificacionZona":
"string", "SegundoApellido": "string",
0, "
ApellidoCasada
NumeroIdentificacion": "string", "
Sexo
PrimerNombre": "string", "
FechaNacimiento
SegundoNombre": "
2019-09-18
string", "
EstadoCivil
PrimeApellido":
0
"string", "
NombreJuridico
SegundoApellido": "string",

"
RepresentanteLegal
ApellidoCasada": "string", "
NumeroRegistroMercantil
Sexo": "string", "
FechaConstitucion
FechaNacimiento": "2019-09-18", "
Grupo
EstadoCivil": 0, "
NumeroIdentificacionTributaria
NombreJuridico": "string", "
Promotor
RepresentanteLegal": "string", "
AfectoAImpuestos
NumeroRegistroMercantil": "string", "
EstadoCliente
FechaConstitucion": "
string
2019-09-18",

"CodigoReferencia":

"string",
"
ActividadEconomica
Grupo": 0, "
DireccionEMailPrincipal
NumeroIdentificacionTributaria": "string", "
DireccionEMailSecundario
Promotor": "string", "
ExcluirDeMensajesDeCorreo
AfectoAImpuestos":
0, "ParametrosExtendidos_B1Integration": { "CentrosDeCosto": [
"string", "EstadoCliente": "string",
{
"CodigoReferencia": "string", "
Secuencia
ActividadEconomica": 0,

"
CodigoCCSAP
DireccionEMailPrincipal": "string",

"
NombreCCSAP
DireccionEMailSecundario": "string",

"
CodigoCCSifco
ExcluirDeMensajesDeCorreo": 0,

"
NombreCCSifco
ProfesionUOficio": "string",
} ],
"ParametrosExtendidos_B1Integration": { "
Proyectos
CentrosDeCosto": [ { "Secuencia": 0, "
CodigoProyectoSAP
CodigoCCSAP": "string", "NombreCCSAP": "string", "CodigoCCSifco": 0, "NombreCCSifco": "string" } ], "
NombreCCSifco
Proyectos":
"string"
[
}
{
],
"
Transacciones
Secuencia":
[
0,
{

"
InterfazarCodigosDeTransaccion
CodigoProyectoSAP":
true
"string", "
NombreCampoSAP
NombreCCSAP": "string",
}
"CodigoCCSifco": 0,
],
"
Series
NombreCCSifco":
[
"string"
{
}
"ObjetoDeNegocio": 0,
], "
CodigoSerieSAP
Transacciones":
"string",
[
"NombreSerieSAP": "string"
{
}
"InterfazarCodigosDeTransaccion": true,
]

},
"
Prestamos
NombreCampoSAP":
[
"string"
{
}
"NumeroPrestamo": "string"
], "
NombrePrestamo
Series":
"string",
[ {
"Producto":

0,
"
SubProducto
ObjetoDeNegocio": 0,
"Saldo":

0
"CodigoSerieSAP": "string",
}

],
"
CuentasAhorro
NombreSerieSAP":
[
"string"
{
}
"NumeroCuenta":

"string",
]
"Producto":

0
},

"
SubProducto
Prestamos":
0,
[ {
"TieneCondicionesEspeciales":

"string",
"
FrecuenciaCondicionesEspeciales
NumeroPrestamo":
0
"string", "
MontoDescuentoPlanilla
NombrePrestamo":
0
"string", "
FrecuenciaDescuentoPlanilla
Producto": 0, "
Referencia
SubProducto":
"string"
0, "
Monto
Saldo": 0 } ], "
CalificadoresAdicionales
CuentasAhorro": [
{

"CodigoCalificador": 0,
{ "
ValorCalificador
NumeroCuenta": "string",
}
"Producto":
]
0,
"CuentasBancarias":

[
"SubProducto": 0,
{
"
Correlativo
TieneCondicionesEspeciales":
0
"string", "
CodigoBanco
FrecuenciaCondicionesEspeciales": 0, "
TipoCuenta
MontoDescuentoPlanilla": 0, "
NumeroCuenta
FrecuenciaDescuentoPlanilla":
"string"
0, "
EstadoReferencia
Referencia": "string"
}
,
],
"
Telefonos
Monto":
[
0
{
}
"Correlativo": 0,
], "
TipoTelefono
CalificadoresAdicionales": [
0,
{
"NumeroTelefono":

"string",
"
ObservacionTelefono
CodigoCalificador":
"string"
0,
}

], "Direcciones
"ValorCalificador":
[
"string"
{

}
"Correlativo":

0
],

"
TipoDireccion
CuentasBancarias": [
0,
{
"DireccionPais":

0,
"
DireccionDepartamento
Correlativo": 0, "
DireccionMunicipio
CodigoBanco": 0, "
DireccionZona
TipoCuenta": 0, "
Direccion
NumeroCuenta": "string", "
CodigoPostal
EstadoReferencia": "string"
,

"Geolocalizacion": "string",
}
"DireccionEmpresaDondeLabora": "string",
], "
Puesto
Telefonos": [
"string"

}
{
]

}

}
200 (Operación Exitosa)
Code Block
language json
{
"
CodigoCliente
Correlativo": 0, "
ConsultaResultados
TipoTelefono":
[
0,
{
"
CodigoCliente
NumeroTelefono":
0
"string", "
TipoDePersona
ObservacionTelefono": "string"
,

"TipoIdentificacion":

0,
}
"DocumentoIdentificacionPais":

0
], "
DocumentoIdentificacionDepartamento
Direcciones":
0,
[ {
"DocumentoIdentificacionMunicipio":

0,
"
DocumentoIdentificacionZona
Correlativo": 0, "
NumeroIdentificacion
TipoDireccion":
"string"
0, "
PrimerNombre
DireccionPais":
"string"
0, "
SegundoNombre
DireccionDepartamento":
"string",
0, "
PrimeApellido
DireccionMunicipio":
"string",
0, "
SegundoApellido
DireccionZona":
"string"
0, "
ApellidoCasada
Direccion": "string",
"Sexo":

"string",

"
FechaNacimiento
CodigoPostal": "
2019-09-18
string",
"EstadoCivil": 0,
"
NombreJuridico
Geolocalizacion": "string", "
RepresentanteLegal
DireccionEmpresaDondeLabora": "string", "
NumeroRegistroMercantil
Puesto": "string"
,
}
"FechaConstitucion":

"2019-09-18",
]
"Grupo": 0,
} ], "RefPersonales":[ { "
NumeroIdentificacionTributaria
Correlativo":0, "TipoPersona":string, "Nombre":string, "Direccion":string, "CodigoPostal":0, "Telefono":string,
"Promotor": "string", "AfectoAImpuestos": "string", "EstadoCliente": "string", "CodigoReferencia": "string", "ActividadEconomica": 0, "DireccionEMailPrincipal": "string",
"Fax":string, "email":string, "TipoRelalcion":string, "Detalle":string, "Estatus":string, "Celular":string } ], "Messages": [ { "
DireccionEMailSecundario
Id": "string", "
ExcluirDeMensajesDeCorreo
Type": 0, "
ParametrosExtendidos_B1Integration
Description":
{ "CentrosDeCosto": [ {
"string" }

], "
Secuencia
Result":
0,
"string" }
400 (Bad Request).
Solicitud Errada
Code Block
language json
{ "error":

{

"
CodigoCCSAP
code": "string",
"NombreCCSAP
"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) ).
Code Block
language json
{ "error":

{

"
CodigoCCSifco
code":

"0
,
", "
NombreCCSifco
message":

"
string"
This service needs an Authorization Header"

} } { "CodigoCliente":"",

"ConsultaResultados":[],

"
Proyectos
Messages":

[], "Result":""

}
404 (Not Found).
Respuesta Vacía (Web Service, no encontrado)
500 (Internal Server Error)
(Error Interno del Servidor de las API’s REST).
Code Block
language json
{ "error": { "code": "string",

"message": "
Secuencia": 0, "CodigoProyectoSAP": "string
string" } }
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:
Code Block
language html
https://test.sifco.org/democoopgt/rest/wsingresarclientes
HEADERS:
Code Block
language json
content-type: application/json authorization: OAuth f2a9ec34-cf83-46f5-8862-f78........ genexus-agent: SmartDevice Application
BODY:
Code Block
language json
{ "Modo": "UPD",

"ConsultaFormaIdentificar": 1, "
NombreCCSAP
ConsultaValorIdentificador": "
string
1",

"WSCliente": {

"
CodigoCCSifco
CodigoCliente":
0,
"193", "
NombreCCSifco
TipoDePersona": "
string
N", "TipoIdentificacion": 1,
}
"DocumentoIdentificacionPais": 320,
],
"DocumentoIdentificacionDepartamento": 13, "
Transacciones
DocumentoIdentificacionMunicipio":
[ {
6, "
InterfazarCodigosDeTransaccion
DocumentoIdentificacionZona":
true
0, "NumeroIdentificacion": "7885 88363 9839", "
NombreCampoSAP
PrimerNombre": "
string
SIFCO", "SegundoNombre": "PRUEBA",
}
"PrimeApellido": "OFICINA", "SegundoApellido": "GENERAL",
],
"ApellidoCasada": "", "
Series
Sexo":
[
"M", "FechaNacimiento": "1982-05-11",
{
"EstadoCivil": 1, "NombreJuridico": "",

"
ObjetoDeNegocio
RepresentanteLegal":
0
"", "NumeroRegistroMercantil": "",

"
CodigoSerieSAP
FechaConstitucion": "
string
0000-00-00",

"Grupo": 2, "
NombreSerieSAP
NumeroIdentificacionTributaria": "
string
3454534", "Promotor": "admin",
}
"AfectoAImpuestos": "S", "EstadoCliente": "A",
]

}
"CodigoReferencia": "4040",

"
Prestamos
ActividadEconomica":
[
6,
{
"DireccionEMailPrincipal": "rmatheu@sifco.org",

"
NumeroPrestamo
DireccionEMailSecundario": "
string
", "ExcluirDeMensajesDeCorreo": 0, "
NombrePrestamo
ProfesionUOficio": "
string
Ingeniero"
,
"Prestamos": [], "
Producto
CuentasAhorro":
0,
[ { "
SubProducto
NumeroCuenta":
0
"78997786",

"
Saldo
Producto":
0
1,
}
"SubProducto": 1,
],
"
CuentasAhorro
TieneCondicionesEspeciales":
[
"N",
{
"FrecuenciaCondicionesEspeciales": 8,

"
NumeroCuenta
MontoDescuentoPlanilla": "
string
50.00",

"
Producto
FrecuenciaDescuentoPlanilla":
0
11,

"
SubProducto
Referencia":
0,
"Nueva cuenta 3", "
TieneCondicionesEspeciales
Monto": "
string
1000"
,
},
"FrecuenciaCondicionesEspeciales":

0,
{ "
MontoDescuentoPlanilla
NumeroCuenta":
0
"6878786786",

"
FrecuenciaDescuentoPlanilla
Producto":
0
1,

"
Referencia
SubProducto":
"string"
1,

"
Monto
TieneCondicionesEspeciales":
0
"N",
}
"FrecuenciaCondicionesEspeciales": 8,
],

"
CalificadoresAdicionales
MontoDescuentoPlanilla":
[
"50.00",
{
"FrecuenciaDescuentoPlanilla": 11, "
CodigoCalificador
Referencia":
0,
"Nueva cuenta 4", "
ValorCalificador
Monto": "
string
1000"

}

],

"
CuentasBancarias
CalificadoresAdicionales": [], "CuentasBancarias": [],
{
"Telefonos": [],

"
Correlativo
Direcciones":
0
[], "RefPersonales":[] } }
200 (Successful operation)
Operación Exitosa
Code Block
language json
{ "CodigoCliente": "1", "
CodigoBanco
ConsultaResultados":
0
[], "Messages": [],

"Result": "OK" }
400 (Bad Request).
Solicitud Errada
Code Block
language json
{

"
TipoCuenta
error":
0,
{ "
NumeroCuenta
code": "string",
"EstadoReferencia
"message": "string"
} ], "Telefonos": [ {
} }
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) ).
Code Block
language json
{ "error": { "
Correlativo
code":

"0",

"
TipoTelefono
message":"This
0,
service needs an Authorization Header" } } { "
NumeroTelefono
CodigoCliente":

"
string
", "ConsultaResultados":[],

"Messages":[], "
ObservacionTelefono
Result":

"
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": [
" }
404 (Not Found).
Respuesta Vacía (Web Service, no encontrado)
500 (Internal Server Error)
(Error Interno del Servidor de las API’s REST).
Code Block
language json
{ "error": { "code": "string", "message": "string" } }
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
language json
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
language json
{ "Modo": "INS", "ConsultaFormaIdentificar": 0, "ConsultaValorIdentificador": "", "WSCliente": { "
Id
TipoIdentificacion":
"string"
1, "
Type
NumeroIdentificacion":
0
"9999999999", "
Description
PrimerNombre": "
string
XXXXXX",
}

],
"
Result
SegundoNombre": "
string
XXXXXXXX"
}
400 (Requisicion Errada).
401 (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 (Web Service, no encontrado).
500 (Error Interno del Servidor de las API’s REST).
Code Block
language json
{
, "
error
PrimeApellido":
{
"XXXXXXXX", "
code
SegundoApellido": "
string
XXXXXXX", "
message
ApellidoCasada": "
string
",
} }
Tip
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.
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.
"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", } }

Live Search

spaceKey	DOC
placeholder	Búsqueda en esta Pagina
type	page

Enlaces Relevantes

Constantes preestablecidas asociadas a variables

preestablecidas por
o parámetros de la Aplicación SIFCO WEB.
WSApTiposIdentificacionLista
WSClGruposLista
WSApUsuariosSistemaLista
WSApPaisLista
WSApDepartamentoLista
WSApMunicipioLista
WSActividadEconomicaLista
WSApBancosLista
WSApCaptacionProductosLista
WSApFrecuenciasLista
WSApCamposDefinidosUsuarioLista
Web Services de Consulta de Categorías Generales
Artículos Relacionados
Filter by label (Content by label)
showLabels false
max 5
showSpace false
cql label in ( "informacion" , "tecnica" , "api" , "rest" , "web" , "services" , "clientes" , "asociados" , "ingresar" ) and type = "page" and space = "DOC"
Artículos Actualizados Recientemente
Recent updates
types page
max 5
spaces DOC
hideHeading true
theme concise
hideHeadingtrue
Change History

Versions Compared

Old Version 24

New Version Current

Key

Web Services para Ingresar Clientes al Sistema.

DESCRIPCIÓN.

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

EJEMPLOS DE REQUEST Y RESPONSE, PARA LOS SERVICIOS RESTful BAJO PROTOCOLO HTTP.

METODO POST

Tipo de Mensaje HTTP

Ejemplo

Tipo de Mensaje HTTP

Ejemplo

EJEMPLOS DE REQUEST Y RESPONSE, PARA LOS SERVICIOS RESTful BAJO PROTOCOLO HTTP.

METODO POST

Tipo de Mensaje HTTP

Ejemplo

EJEMPLO #3

Tipo de Mensaje HTTP

Ejemplo

Enlaces Relevantes

Artículos Relacionados

Artículos Actualizados Recientemente

Page Comparison

Versions Compared

Old Version 24

New Version Current

Key

Web Services para Ingresar Clientes al Sistema.

DESCRIPCIÓN.

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

EJEMPLOS DE REQUEST Y RESPONSE, PARA LOS SERVICIOS RESTful BAJO PROTOCOLO HTTP.

METODO POST

Tipo de Mensaje HTTP

Ejemplo

Tipo de Mensaje HTTP

Ejemplo

EJEMPLOS DE REQUEST Y RESPONSE, PARA LOS SERVICIOS RESTful BAJO PROTOCOLO HTTP.

METODO POST

Tipo de Mensaje HTTP

Ejemplo

EJEMPLO #3

Tipo de Mensaje HTTP

Ejemplo

Enlaces Relevantes

Artículos Relacionados

Artículos Actualizados Recientemente