Versions Compared

Old Version 56

changes.mady.by.user Rodrigo Morales

Saved on

compared with

New Version 57

changes.mady.by.user Rodrigo Morales

Saved on

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          description: type: "string"Successful 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"

       500TipoDePersona:
 
        description: Tipo "Internalde serverPersona
error"        type: "string"

schema:      TipoIdentificacion:
      $ref: "#/definitions/GxJsonError"
security description: Tipo de -Identificación
OAuth2: []     ApiKeyAuth1: [] securityDefinitionstype: "integer"
 OAuth2:     type: oauth2 format:  "int32"

flow: password     tokenUrlDocumentoIdentificacionPais:
https://test.sifco.org/DemoCoopGT/oauth/access_token     scopes:   description: Pais de  Execute: Permite el método tipo GETEmisión Documento
        type: "integer"
        format: "int64"

      DocumentoIdentificacionDepartamento:
        description: Código Región Emisión Identifi
        type: "integer"
        format: "int64"

      DocumentoIdentificacionMunicipio:
        description: Departamento Emisión Identific
        type: "integer"
        format: "int64"

      DocumentoIdentificacionZona:
        description: Código Municipio Emisión Ident
        type: "integer"
        format: "int64"

      NumeroIdentificacion:
        description: Número de Identificación Clien
        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:
        Insertdescription: Número Permitede elRegistro métodoMercantil
tipo POST       Updatetype: Permite el método tipo PUT"string"

      FechaConstitucion:
        Deletedescription: PermiteFecha elde métodoConstitución
tipo DELETE       FullControltype: "string"
 Permite el manejo de los Cuatro Métodos GET, POST, PUT,DELETE, sobre el Web Serviceformat: "date"

      ApiKeyAuth1Grupo:
        typedescription: Código del apiKeyGrupo de Afinidad
  in: header     nametype: granttype"integer"
 definitions:    WSIngresarClientesInput:   format: "int64"
properties:
      ModoNumeroIdentificacionTributaria:
        description: ModoNúmero de Acceso al Cliente en el SistemaIdentificación Tributaria
        type: "string"

      ConsultaFormaIdentificarPromotor:
        description: Código Promotor
Manera como se identifica el Cliente en el Sistema.
type: "string"

      typeAfectoAImpuestos: "integer"
        formatdescription: "int32"Afecto a Impuestos
    ConsultaValorIdentificador:    type: "string"

  description: Valor como se identifica elEstadoCliente:
Cliente en el Sistema.     description: Estado del Cliente
type: "string"       WSClientetype: "string"

      descriptionCodigoReferencia: WSInformacion Cliente
        $refdescription: "#/definitions/WSInformacionCliente"Referencia
   WSInformacionCliente:     propertiestype: "string"

      CodigoClienteActividadEconomica:
        description: Código de delactividad Clienteeconómica
        type: "integer"
        format: "int64int32"

      TipoDePersonaDireccionEMailPrincipal:
        description: TipoCorreo de PersonaElectrónico
        type: "string"

      TipoIdentificacionDireccionEMailSecundario:
        description: TipoCorreo deElectrónico IdentificaciónAlternativo
        type: "integerstring"

       format: "int32"ExcluirDeMensajesDeCorreo:
       DocumentoIdentificacionPais:         description: PaísExcluir de EmisiónCorreos DocumentoElectronicos
        type: "integer"
        format: "int64int32"

      DocumentoIdentificacionDepartamentoParametrosExtendidos_B1Integration:
        description: CódigoParametros Región Emisión IdentificaciónExtendidos_B1 Integration
        type$ref: "integer"
        format: "int64"

      DocumentoIdentificacionMunicipio:
   #/definitions/ParametrosExtendidos_B1Integration"

   description: Departamento Emisión IdentificaciónPrestamos:
        type: "integer"array
        formatitems:
  "int64"        DocumentoIdentificacionZonadescription: Prestamo
       description: Código Municipio Emisión Identificación$ref: "#/definitions/WSInformacionCliente.Prestamos"

       typeCuentasAhorro:
"integer"        type: format:array
"int64"        NumeroIdentificacionitems:
          description: NúmeroCuentaAhorro
de Identificación Clientes         type$ref: "string#/definitions/WSInformacionCliente.CuentasAhorro"

      PrimerNombreCalificadoresAdicionales:
        descriptiontype: array
Primer Nombre       items:
 type: "string"        SegundoNombredescription: CalificadorAdicional
        description: Segundo Nombre
$ref: "#/definitions/WSInformacionCliente.CalificadoresAdicionales"

      typeCuentasBancarias:
"string"        PrimeApellidotype: array
        descriptionitems:
Primer Apellido         typedescription: "string" CuentaBancaria
          SegundoApellido$ref: "#/definitions/WSInformacionCliente.CuentasBancarias"

      descriptionTelefonos: Segundo Apellido
        type: array
"string"        ApellidoCasadaitems:
          description: ApellidoTelefono
de Casada         type$ref: "string#/definitions/WSInformacionCliente.Telefonos"

      SexoDirecciones:
        descriptiontype: Sexoarray
 Cliente       items:
 type: "string"        FechaNacimientodescription: Direccion
       description: Fecha de Nacimiento
$ref: "#/definitions/WSInformacionCliente.Direcciones"

      typeRefPersonales:
"string"        type: format:array
"date"        EstadoCivilitems:
          description: Referencia
Estado Civil         type$ref: "integer#/definitions/WSInformacionCliente.RefPersonales"


  WSInformacionCliente.Prestamos:
    formatproperties:
"int32"        NombreJuridicoNumeroPrestamo:
        description: Nombre de EmpresaNúmero odel SociedadPréstamo
        type: "string"

      RepresentanteLegalNombrePrestamo:
        description: Nombre del Representante LegalPréstamo
        type: "string"

      NumeroRegistroMercantilProducto:
        description: Número de Registro Mercantil Codigo Producto
        type: "integer"
        typeformat: "stringint32"

      FechaConstitucionSubProducto:
        description: FechaCódigo deSubProducto ConstituciónColocacion
        type: "stringinteger"
        format: "dateint32"

      GrupoSaldo:
        description: Código delSaldo Grupo de AfinidadCapital
        type: "integernumber"
        format: "int64double"


     NumeroIdentificacionTributariax-gx-level: "WSInformacionCliente"


     descriptionWSInformacionCliente.CuentasAhorro:
Número de Identificación Tributaria properties:
       typeNumeroCuenta:
"string"        Promotordescription: Numero Cuenta
      description: Código Promotortype: "string"

      typeProducto:
"string"        AfectoAImpuestosdescription: Codigo Producto
      description: Afecto a Impuestostype: "integer"
        typeformat: "stringint32"

      EstadoClienteSubProducto:
        description: EstadoCódigo del ClienteSubProducto
        type: "integer"
        format: "stringint32"

      CodigoReferenciaTieneCondicionesEspeciales:
        description: Tiene ReferenciaCondiciones Especiales
        type: "string"

      ActividadEconomicaFrecuenciaCondicionesEspeciales:
        description: Código de actividadla económicaFrecuencia
        type: "integer"
        format: "int32"

      DireccionEMailPrincipalMontoDescuentoPlanilla:
        description: Monto CorreoDescuento ElectrónicoPlanilla
        type: "stringnumber"


     DireccionEMailSecundario:         description: Correo Electrónico Alternativo
        type: "stringformat: "double"

      ExcluirDeMensajesDeCorreoFrecuenciaDescuentoPlanilla:
        description: ExcluirCódigo de Correosla ElectrónicosFrecuencia
        type: "integer"
        format: "int32"

      ParametrosExtendidos_B1IntegrationReferencia:
        description: ParámetrosCuenta Extendidos_B1de IntegrationReferencia
        $reftype: "#/definitions/ParametrosExtendidos_B1Integration"string"

      Monto:
   Prestamos:     description: Monto
        type: array"number"
        items:format: "double"


    x-gx-level: "WSInformacionCliente"


  descriptionWSInformacionCliente.CalificadoresAdicionales:
Préstamo    properties:
      $refCodigoCalificador:
"#/definitions/WSInformacionCliente.Prestamos"        CuentasAhorrodescription: Código
        type: array"integer"
        itemsformat: "int32"

      ValorCalificador:
 description: CuentaAhorro      description: Valor del calificador  $ref: "#/definitions/WSInformacionCliente.CuentasAhorro"adicional
        CalificadoresAdicionalestype: "string"


     type: arrayx-gx-level: "WSInformacionCliente"


  WSInformacionCliente.CuentasBancarias:
    itemsproperties:
          descriptionCorrelativo:
CalificadorAdicional        description: Referencia Bancaria
$ref: "#/definitions/WSInformacionCliente.CalificadoresAdicionales"        CuentasBancarias:type: "integer"
        typeformat: array"int32"

       itemsCodigoBanco:
 
        description: CuentaBancariaCodigo Banco
         $reftype: "#/definitions/WSInformacionCliente.CuentasBancarias"integer"
        Telefonosformat: "int32"

      typeTipoCuenta:
array        description: items:Tipo de Cuenta
        descriptiontype: Teléfono"integer"
          $refformat: "#/definitions/WSInformacionCliente.Telefonosint32"

      DireccionesNumeroCuenta:
        typedescription: arrayNúmero de la Cuenta
     items:   type: "string"

     description EstadoReferencia:
Dirección        description: Estatus de $ref: "#/definitions/WSInformacionCliente.Direcciones"
la Referencia Banca
     ParametrosExtendidos_B1Integration:   type: "string"
properties:

     CentrosDeCostox-gx-level:    "WSInformacionCliente"


  typeWSInformacionCliente.Telefonos:
array    properties:
    items:  Correlativo:
        description: CentroDeCostoCorrelativo por cliente
        $reftype: "#/definitions/ParametrosExtendidos_B1Integration.CentrosDeCosto"integer"
        Proyectosformat: "int32"

      typeTipoTelefono:
array        description: items:Tipo de telefono
        descriptiontype: Proyecto"integer"
          $refformat: "#/definitions/ParametrosExtendidos_B1Integration.Proyectosint32"

      TransaccionesNumeroTelefono:
        typedescription: Número arraytelefonico
        itemstype: "string"

      ObservacionTelefono:
        description: TransaccionesObservaciones
          $reftype: "#/definitions/ParametrosExtendidos_B1Integration.Transaccionesstring"


     Seriesx-gx-level: "WSInformacionCliente"


  WSInformacionCliente.Direcciones:
  type: array properties:
       itemsCorrelativo:
 
        description: SerieCorrelativo de Dirección
        $reftype: "#/definitions/ParametrosExtendidos_B1Integration.Series"integer"
     ParametrosExtendidos_B1Integration.CentrosDeCosto:   format: "int32"
properties:
      SecuenciaTipoDireccion:
        description: SecuenciaTipo de Dirección
        type: "integer"
        format: "int32"

      CodigoCCSAPDireccionPais:
        description: Código pais CCSAPdirección
        type: "string"integer"
        format: "int64"

      NombreCCSAPDireccionDepartamento:
        description: NombreCódigo Región CCSAPDirección
        type: "string"integer"
        format: "int64"

      CodigoCCSifcoDireccionMunicipio:
        description: Código Departamento CCSifcoDirección
        type: "integer"
        format: "int32int64"

      NombreCCSifcoDireccionZona:
        description: Código NombreMunicipio CCSifcoDirección
        type: "stringinteger"
        x-gx-levelformat: "ParametrosExtendidos_B1Integrationint64"

    ParametrosExtendidos_B1Integration.Proyectos:  Direccion:
        propertiesdescription: Dirección
        Secuenciatype: "string"

      descriptionCodigoPostal:
Secuencia        description: type: "integer"Código Postal
        formattype: "int32string"

      CodigoProyectoSAPGeolocalizacion:
        description: Código Proyecto SAPGeolocalización
        type: "string"

      NombreCCSAPDireccionEmpresaDondeLabora:
        description: Nombre CCSAP de la empresa donde labora
        type: "string"

      CodigoCCSifcoPuesto:
        description: Puesto Códigoen la CCSifcoempresa
        type: "integerstring"


      formatx-gx-level: "int32WSInformacionCliente"


  WSInformacionCliente.RefPersonales:
    NombreCCSifcoproperties:
      Correlativo:
  description: Nombre CCSifco    description: Correlativo de Referencia Personal
type: "string"       x-gx-leveltype: "ParametrosExtendidos_B1Integrationinteger"
    ParametrosExtendidos_B1Integration.Transacciones:    format: "int32"
properties:
      InterfazarCodigosDeTransaccionTipoPersona:
        description: InterfazarTipo Códigosde DePersona TransacciónReferencia
        type: "booleanstring"

      NombreCampoSAPNombre:
        description: Referencia Nombre Campo SAP
        type: "string"

      x-gx-level: "ParametrosExtendidos_B1Integration"Direccion:
        ParametrosExtendidos_B1Integration.Series:description: Dirección Referencia Personal
      properties:  type: "string"

     ObjetoDeNegocio CodigoPostal:
        description: Código ObjetoPostal DeRef. NegocioPersonal
        type: "integer"
        format: "int32int64"

      CodigoSerieSAPTelefono:
        description: CódigoTeléfono SerieReferencia SAPPersonal
        type: "string"

      NombreSerieSAPFax:
        description: NombreFAX SerieReferencia SAPPersonal
        type: "string"

      x-gx-level: "ParametrosExtendidos_B1Integration"


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

       NumeroPrestamoTipoRelalcion:
        description: NúmeroTipo delde PréstamoRelación
        type: "string"

      NombrePrestamoDetalle:
        description: Detalles Nombrede della PréstamoReferencia
        type: "string"

      ProductoEstatus:
        description: CodigoEstatus Productode la Referencia Per.
     type: "integer"         formattype: "int32string"

      SubProductoCelular:
        description: CódigoCelular SubProductoreferencia Colocaciónpersonal
        type: "integerstring"


      formatx-gx-level: "int32WSInformacionCliente"
  ParametrosExtendidos_B1Integration:
    Saldoproperties:
        descriptionCentrosDeCosto:
Saldo de Capital
        type: "number"array
        format: "double"

items:
    x-gx-level: "WSInformacionCliente"     WSInformacionCliente.CuentasAhorrodescription: CentroDeCosto
   properties:       NumeroCuenta:$ref: "#/definitions/ParametrosExtendidos_B1Integration.CentrosDeCosto"

       description: Numero CuentaProyectos:
        type: array
"string"        Productoitems:
          description: Proyecto
Código Producto         type$ref: "integer#/definitions/ParametrosExtendidos_B1Integration.Proyectos"

       formatTransacciones:
"int32"        SubProducto$ref: "#/definitions/ParametrosExtendidos_B1Integration.Transacciones"

      descriptionSeries:
Código del SubProducto
        type: "integer"array
        format: "int32"

    items:
 TieneCondicionesEspeciales:         description: TieneSerie
Condiciones Especiales         type$ref: "string#/definitions/ParametrosExtendidos_B1Integration.Series"

      FrecuenciaCondicionesEspecialesFormaDePago:
        description$ref: Código de la Frecuencia"#/definitions/ParametrosExtendidos_B1Integration.FormaDePago"

      PagosTransferencia:
   type: "integer"    type:   array
 format: "int32"      items:
 MontoDescuentoPlanilla:         description: MontoPagoTransferencia
Descuento Planilla         type$ref: "number"#/definitions/ParametrosExtendidos_B1Integration.PagosTransferencia"


  ParametrosExtendidos_B1Integration.CentrosDeCosto:
    formatproperties: "double"
       FrecuenciaDescuentoPlanillaSecuencia:
        description: Código de laSecuencia
Frecuencia         type: "integer"
        format: "int32"

      ReferenciaCodigoCCSAP:
        description: CuentaCodigo deCCSAP
Referencia         type: "string"

      MontoNombreCCSAP:
        description: MontoNombre CCSAP
        type: "numberstring"

       formatCodigoCCSifco:
"double"       x-gx-level: "WSInformacionCliente"


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

      ValorCalificadorNombreCCSifco:

       description: Valor del calificador adicional description: Nombre CCSifco
        type: "string"


    x-gx-level: "WSInformacionClienteParametrosExtendidos_B1Integration"


  WSInformacionClienteParametrosExtendidos_B1Integration.CuentasBancariasProyectos:
    properties:
      CorrelativoSecuencia:
        description: Referencia BancariaSecuencia
        type: "integer"
        format: "int32"

      CodigoBancoCodigoProyectoSAP:
        description: Codigo CódigoProyecto BancoSAP
        type: "integer"string"

      NombreCCSAP:
        description:  formatNombre CCSAP
        type: "int32string"

      TipoCuentaCodigoCCSifco:
        description: TipoCodigo de CuentaCCSifco
        type: "integer"
        format: "int32"

      NumeroCuentaNombreCCSifco:
        description: NúmeroNombre de laCCSifco
Cuenta         type: "string"


    x-gx-level: "ParametrosExtendidos_B1Integration"


  EstadoReferencia:ParametrosExtendidos_B1Integration.Transacciones:
    properties:
      descriptionInterfazarCodigosDeTransaccion:
Estatus de la Referencia Bancaria    description: Interfazar Codigos De Transaccion
type: "string"       x-gx-leveltype: "WSInformacionClienteboolean"

   WSInformacionCliente.Telefonos:   NombreCampoSAP:
 properties:       Correlativodescription: Nombre Campo SAP
     description: Correlativo por clientetype: "string"


     typex-gx-level: "integerParametrosExtendidos_B1Integration"


  ParametrosExtendidos_B1Integration.Series:
   format: "int32" properties:
       TipoTelefonoObjetoDeNegocio:
        description: TipoObjeto deDe teléfonoNegocio
        type: "integer"
        format: "int32"

      NumeroTelefonoCodigoSerieSAP:
        description: Codigo NúmeroSerie telefónicoSAP
        type: "string"

      ObservacionTelefonoNombreSerieSAP:
        description: Nombre Serie ObservacionesSAP
        type: "string"


    x-gx-level: "WSInformacionClienteParametrosExtendidos_B1Integration"


  WSInformacionClienteParametrosExtendidos_B1Integration.DireccionesFormaDePago:
    properties:
      CorrelativoInterfazFormaDePago:
        description: Interfaz CorrelativoForma deDe DirecciónPago
        type: "integer"boolean"

      TarjetasDeCredito:
      format  type: array
"int32"        TipoDireccionitems:
          description: TipoTarjetaDeCredito
de Dirección         type$ref: "integer#/definitions/ParametrosExtendidos_B1Integration.FormaDePago.TarjetasDeCredito"

       formatx-gx-level: "int32ParametrosExtendidos_B1Integration"

  ParametrosExtendidos_B1Integration.FormaDePago.TarjetasDeCredito:
    DireccionPaisproperties:
        descriptionCodigoTarjetaCredito:
Código país dirección      description: Codigo Tarjeta type:Credito
"integer"         formattype: "int64string"

      DireccionDepartamentoFormatoTarjetaCredito:
        description: CódigoFormato Regiónde DirecciónIdentificación
        type: "integerstring"

       formatExpresionTarjetaCredito:
"int64"        DireccionMunicipiodescription: Expresión Regular
      description: Código Departamento Direccióntype: "string"


      typex-gx-level: "integerParametrosExtendidos_B1Integration.FormaDePago"


  ParametrosExtendidos_B1Integration.PagosTransferencia:
    formatproperties:
"int64"        DireccionZonaCodigoPagoTransferencia:
        description: CódigoCodigo MunicipioPago DirecciónTransferencia
        type: "integer"
        format: "int64int32"

      DireccionDescripcionPagoTransferencia:
        description: Descripcion Pago DirecciónTransferencia
        type: "string"

      CodigoPostalCtaContablePagoTransferencia:
        description: Cta Contable CódigoPago PostalTransferencia
        type: "string"

      GeolocalizacionEmpCodPagoTransferencia:
        description: Código GeolocalizaciónEmpresa
        type: "string"integer"
        format: "int32"

      DireccionEmpresaDondeLaboraTrxCodPagoTransferencia:
        description: NombreCódigo de la empresa donde labora Transacción
        type: "integer"
        typeformat: "stringint32"

      PuestoUsoPagoTransferencia:
        description: PuestoUso enPago laTransferencia
empresa
        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:
        description: Código de Error
        type: "string"

      message:
        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

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
languagehtml
https://test.sifco.org/democoopgt/rest/wsingresarclientes

HEADERS:

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

BODY:

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

200 (Successful operation)

Operación Exitosa

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

400 (Bad Request).

Solicitud Errada

Code Block
languagejson
{
  "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
languagejson
{
  "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
languagejson
{
  "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
languagejson
content-type: application/json
authorization: OAuth f2a9ec34-cf83-46f5-8862-f78........
genexus-agent: SmartDevice Application

BODY:

Code Block
languagejson
{
  "Modo": "string",
  "ConsultaFormaIdentificar": 0,
  "ConsultaValorIdentificador": "string",
  "WSCliente": {
    "CodigoCliente": 0,
    "TipoDePersona": "string",
    "TipoIdentificacion": 0,
    "DocumentoIdentificacionPais": 0,
    "DocumentoIdentificacionDepartamento": 0,
    "DocumentoIdentificacionMunicipio": 0,
    "DocumentoIdentificacionZona": 0,
    "NumeroIdentificacion": "string",
    "PrimerNombre": "string",
    "SegundoNombre": "string",
    "PrimeApellido": "string",
    "SegundoApellido": "string",
    "ApellidoCasada": "string",
    "Sexo": "string",
    "FechaNacimiento": "2019-09-18",
    "EstadoCivil": 0,
    "NombreJuridico": "string",    
    "RepresentanteLegal": "string",
    "NumeroRegistroMercantil": "string",
    "FechaConstitucion": "2019-09-18",
    "Grupo": 0,
    "NumeroIdentificacionTributaria": "string",
    "Promotor": "string",
    "AfectoAImpuestos": "string",
    "EstadoCliente": "string",
    "CodigoReferencia": "string",
    "ActividadEconomica": 0,
    "DireccionEMailPrincipal": "string",
    "DireccionEMailSecundario": "string",
    "ExcluirDeMensajesDeCorreo": 0,
    "ParametrosExtendidos_B1Integration": {
      "CentrosDeCosto": [
        {
          "Secuencia": 0,
          "CodigoCCSAP": "string",
          "NombreCCSAP": "string",
          "CodigoCCSifco": 0,
          "NombreCCSifco": "string"
        }
      ],
      "Proyectos": [
        {
          "Secuencia": 0,
          "CodigoProyectoSAP": "string",
          "NombreCCSAP": "string",
          "CodigoCCSifco": 0,
          "NombreCCSifco": "string"
        }
      ],
      "Transacciones": [
        {
          "InterfazarCodigosDeTransaccion": true,
          "NombreCampoSAP": "string"
        }
      ],
      "Series": [
        {
          "ObjetoDeNegocio": 0,
          "CodigoSerieSAP": "string",
          "NombreSerieSAP": "string"
        }
      ]
    },
    "Prestamos": [
      {
        "NumeroPrestamo": "string",
        "NombrePrestamo": "string",
        "Producto": 0,
        "SubProducto": 0,
        "Saldo": 0
      }
    ],
    "CuentasAhorro": [
      {
        "NumeroCuenta": "string",
        "Producto": 0,
        "SubProducto": 0,
        "TieneCondicionesEspeciales": "string",
        "FrecuenciaCondicionesEspeciales": 0,
        "MontoDescuentoPlanilla": 0,
        "FrecuenciaDescuentoPlanilla": 0,
        "Referencia": "string",
        "Monto": 0
      }
    ],
    "CalificadoresAdicionales": [
      {
        "CodigoCalificador": 0,
        "ValorCalificador": "string"
      }
    ],
    "CuentasBancarias": [
      {
        "Correlativo": 0,
        "CodigoBanco": 0,
        "TipoCuenta": 0,
        "NumeroCuenta": "string",
        "EstadoReferencia": "string"
      }
    ],
    "Telefonos": [
      {
        "Correlativo": 0,
        "TipoTelefono": 0,
        "NumeroTelefono": "string",
        "ObservacionTelefono": "string"
      }
    ],
    "Direcciones": [
      {
        "Correlativo": 0,
        "TipoDireccion": 0,
        "DireccionPais": 0,
        "DireccionDepartamento": 0,
        "DireccionMunicipio": 0,
        "DireccionZona": 0,
        "Direccion": "string",
        "CodigoPostal": "string",
        "Geolocalizacion": "string",
        "DireccionEmpresaDondeLabora": "string",
        "Puesto": "string"
      }
    ],
    "RefPersonales":[
		{
			"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
languagejson
{
  "CodigoCliente": 0,
  "ConsultaResultados": [
    {
      "CodigoCliente": 0,
      "TipoDePersona": "string",
      "TipoIdentificacion": 0,
      "DocumentoIdentificacionPais": 0,
      "DocumentoIdentificacionDepartamento": 0,
      "DocumentoIdentificacionMunicipio": 0,
      "DocumentoIdentificacionZona": 0,
      "NumeroIdentificacion": "string",
      "PrimerNombre": "string",
      "SegundoNombre": "string",
      "PrimeApellido": "string",
      "SegundoApellido": "string",
      "ApellidoCasada": "string",
      "Sexo": "string",
      "FechaNacimiento": "2019-09-18",
      "EstadoCivil": 0,
      "NombreJuridico": "string",
      "RepresentanteLegal": "string",
      "NumeroRegistroMercantil": "string",
      "FechaConstitucion": "2019-09-18",
      "Grupo": 0,
      "NumeroIdentificacionTributaria": "string",
      "Promotor": "string",
      "AfectoAImpuestos": "string",
      "EstadoCliente": "string",
      "CodigoReferencia": "string",
      "ActividadEconomica": 0,
      "DireccionEMailPrincipal": "string",
      "DireccionEMailSecundario": "string",
      "ExcluirDeMensajesDeCorreo": 0,
      "ParametrosExtendidos_B1Integration": {
        "CentrosDeCosto": [
          {
            "Secuencia": 0,
            "CodigoCCSAP": "string",
            "NombreCCSAP": "string",
            "CodigoCCSifco": 0,
            "NombreCCSifco": "string"
          }
        ],
        "Proyectos": [
          {
            "Secuencia": 0,
            "CodigoProyectoSAP": "string",
            "NombreCCSAP": "string",
            "CodigoCCSifco": 0,
            "NombreCCSifco": "string"
          }
        ],
        "Transacciones": [
          {
            "InterfazarCodigosDeTransaccion": true,
            "NombreCampoSAP": "string"
          }
        ],
        "Series": [
          {
            "ObjetoDeNegocio": 0,
            "CodigoSerieSAP": "string",
            "NombreSerieSAP": "string"
          }
        ]
      },
      "Prestamos": [
        {
          "NumeroPrestamo": "string",
          "NombrePrestamo": "string",
          "Producto": 0,
          "SubProducto": 0,
          "Saldo": 0
        }
      ],
      "CuentasAhorro": [
        {
          "NumeroCuenta": "string",
          "Producto": 0,
          "SubProducto": 0,
          "TieneCondicionesEspeciales": "string",
          "FrecuenciaCondicionesEspeciales": 0,
          "MontoDescuentoPlanilla": 0,
          "FrecuenciaDescuentoPlanilla": 0,
          "Referencia": "string",
          "Monto": 0
        }
      ],
      "CalificadoresAdicionales": [
        {
          "CodigoCalificador": 0,
          "ValorCalificador": "string"
        }
      ],
      "CuentasBancarias": [
        {
          "Correlativo": 0,
          "CodigoBanco": 0,
          "TipoCuenta": 0,
          "NumeroCuenta": "string",
          "EstadoReferencia": "string"
        }
      ],
      "Telefonos": [
        {
          "Correlativo": 0,
          "TipoTelefono": 0,
          "NumeroTelefono": "string",
          "ObservacionTelefono": "string"
        }
      ],
      "Direcciones": [
        {
          "Correlativo": 0,
          "TipoDireccion": 0,
          "DireccionPais": 0,
          "DireccionDepartamento": 0,
          "DireccionMunicipio": 0,
          "DireccionZona": 0,
          "Direccion": "string",
          "CodigoPostal": "string",
          "Geolocalizacion": "string",
          "DireccionEmpresaDondeLabora": "string",
          "Puesto": "string"
        }
      ]
    }
  ],
  "RefPersonales":[
		{
			"Correlativo":0,
			"TipoPersona":string,
			"Nombre":string,
			"Direccion":string,
			"CodigoPostal":0,
			"Telefono":string,
			"Fax":string,
			"email":string,
			"TipoRelalcion":string,
			"Detalle":string,
			"Estatus":string,
			"Celular":string
		}
	],
  "Messages": [
    {
      "Id": "string",
      "Type": 0,
      "Description": "string"
    }
  ],
  "Result": "string"
}

400 (Bad Request).

Solicitud Errada

Code Block
languagejson
{
  "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
languagejson
{
  "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
languagejson
{
  "error": {
    "code": "string",
    "message": "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
languagehtml
https://test.sifco.org/democoopgt/rest/wsingresarclientes

HEADERS:

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

BODY:

Code Block
languagejson
{
  "Modo": "UPD",
  "ConsultaFormaIdentificar": 1,
  "ConsultaValorIdentificador": "1",
  "WSCliente": {
    "CodigoCliente": "193",
    "TipoDePersona": "N",
    "TipoIdentificacion": 1,
    "DocumentoIdentificacionPais": 320,
    "DocumentoIdentificacionDepartamento": 13,
    "DocumentoIdentificacionMunicipio": 6,
    "DocumentoIdentificacionZona": 0,
    "NumeroIdentificacion": "7885 88363 9839",
    "PrimerNombre": "SIFCO",
    "SegundoNombre": "PRUEBA",
    "PrimeApellido": "OFICINA",
    "SegundoApellido": "GENERAL",
    "ApellidoCasada": "",
    "Sexo": "M",
    "FechaNacimiento": "1982-05-11",
    "EstadoCivil": 1,
    "NombreJuridico": "",
    "RepresentanteLegal": "",
    "NumeroRegistroMercantil": "",
    "FechaConstitucion": "0000-00-00",
    "Grupo": 2,
    "NumeroIdentificacionTributaria": "3454534",
    "Promotor": "admin",
    "AfectoAImpuestos": "S",
    "EstadoCliente": "A",
    "CodigoReferencia": "4040",
    "ActividadEconomica": 6,
    "DireccionEMailPrincipal": "rmatheu@sifco.org",
    "DireccionEMailSecundario": "",
    "ExcluirDeMensajesDeCorreo": 0,
    "Prestamos": [],
    "CuentasAhorro": [
      {
        "NumeroCuenta": "78997786",
        "Producto": 1,
        "SubProducto": 1,
        "TieneCondicionesEspeciales": "N",
        "FrecuenciaCondicionesEspeciales": 8,
        "MontoDescuentoPlanilla": "50.00",
        "FrecuenciaDescuentoPlanilla": 11,
        "Referencia": "Nueva cuenta 3",
        "Monto": "1000"
      },
      {
        "NumeroCuenta": "6878786786",
        "Producto": 1,
        "SubProducto": 1,
        "TieneCondicionesEspeciales": "N",
        "FrecuenciaCondicionesEspeciales": 8,
        "MontoDescuentoPlanilla": "50.00",
        "FrecuenciaDescuentoPlanilla": 11,
        "Referencia": "Nueva cuenta 4",
        "Monto": "1000"
      }
    ],
    "CalificadoresAdicionales": [],
    "CuentasBancarias": [],
    "Telefonos": [],
    "Direcciones": [],
    "RefPersonales":[]
  }
}

200 (Successful operation)

Operación Exitosa

Code Block
languagejson
{
"CodigoCliente": "1",
"ConsultaResultados": [],
"Messages": [],
"Result": "OK"
}

400 (Bad Request).

Solicitud Errada

Code Block
languagejson
{
  "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
languagejson
{
  "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
languagejson
{
  "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
languagejson
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.

Live Search
spaceKeyDOC
placeholderBúsqueda en esta Pagina
typepage

Enlaces Relevantes

Artículos Relacionados

Filter by label (Content by label)
showLabelsfalse
max5
showSpacefalse
cqllabel in ( "informacion" , "tecnica" , "api" , "rest" , "web" , "services" , "clientes" , "asociados" , "ingresar" ) and type = "page" and space = "DOC"

Artículos Actualizados Recientemente

Recent updates
typespage
max5
spacesDOC
hideHeadingtrue
themeconcise
Change History