Web Services para Ingresar Clientes al Sistema.

Note

NO DEBE OLVIDAR

Antes de consumir este Web Service, debe consultar cada una de los WS descritos en Web Services de Consulta de Categorías Generales, dado a que en ellos se listan los valores ya cargados de un conjunto de parámetros necesarios para ingresar un cliente al sistema, y dichos parámetros deben coincidir con los ya existentes en el 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. .

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:

DESCRIPCIÓN.

Este Web Service, es uno de los fundamentales de este grupo de API’s RESTfuldebido a que el mismo permite la consulta, el ingreso o la actualización de clientes (asociados / socios), incluyendo todos sus datos claves como por ejemplo, Datos Generales, Cuentas de Ahorro Iniciales, Campos Definidos por el Usuario (Calificadores Adicionales), Cuentas Bancarias, Teléfonos, Direcciones. Ademas de quedar registrado en la Aplicación SIFCO WEB, como un cliente (en el caso de ingreso).

Es importante acotar que para la correcta carga de todos los parámetros de un cliente se deben consumir todos los Web Services de Consulta de Categorías Generales, y las Constantes preestablecidas asociadas a variables o parámetros de la Aplicación SIFCO WEBdado a que ellos les permitan conocer todas las diferentes opciones de parámetros de clientes a consultar, ingresar o actualizar en la Aplicación SIFCO WEB.

Adicionalmente se debe indicar que las opciones de Consulta, Ingreso o Actualización depende del parámetro Modo tal como se explica en el Flujo de Trabajo de Clientes, y se refresca en la tabla a continuación por su importancia para este WS en particular.

Modo Modo de Acceso al Cliente en el Sistema.
Valor	Significado
DSP	Permite Obtener toda la información del Cliente, cargada en el Sistema.
INS	Permite Incluir un Cliente en el Sistema.
UPD	Permite Actualizar solos los campos de Datos Generales, y Cuentas de Ahorro del Cliente en el Sistema.

Swagger open api macro

swagger: '2.0'
info:
  title: "SIFCO_REST_API"
  version: "1.0"
  termsOfService: "https://sifco.org/sobre-nosotros/"
  contact:
    email: "soporte@sifco.org"
  license:
    name: "Apache 2.0"  
    url: "http://www.apache.org/licenses/LICENSE-2.0.html"
host: "<SERVER>"
schemes:
  - https
  - http
basePath: /<APPDIR>/rest
tags:
- name: "WSIngresarClientes"
  externalDocs:
    description: "NotManual AuthenticatedSIFCO"
    url: "https://sifco.atlassian.net/wiki/x/9ISo"
produces:
  - application/json
schemapaths:
  /WSIngresarClientes:
    post:
    $ref: "#/definitions/GxJsonError"
 tags:
       404: - WSIngresarClientes
        descriptionoperationId: "WSIngresarClientes"Not
 found"     summary: "WSIngresar Clientes"
   schema:   parameters:
        - $refname: "#/definitions/GxJsonError"WSIngresarClientesInput"
          400in: "body"
          descriptionrequired: "Bad request"false
          schema:
            $ref: "#/definitions/GxJsonErrorWSIngresarClientesInput"


      500responses:
        200:
          description: "InternalSuccessful server erroroperation"
          schema:
            $ref: "#/definitions/GxJsonErrorWSIngresarClientesOutput"
security:        404:
          description: "Not found"
security:
  - OAuth2: []
    ApiKeyAuth1: []
securityDefinitions:
  OAuth2:
    type: oauth2
    flow: password
    tokenUrl: https://test.sifco.org/DemoCoopGT/oauth/access_token
    scopes:
      Execute: Permite el método tipo GET
      Insert: Permite el método tipo POST
      Update: Permite el método tipo PUT
      Delete: Permite el método tipo DELETE
      FullControl: Permite el manejo de los Cuatro Métodos GET, POST, PUT,DELETE, sobre el Web Service
  ApiKeyAuth1:
    type: apiKey
    in: header
    name: granttype

definitions:

  WSIngresarClientesInput:
    properties:
      Modo:
        type: "string"
      ConsultaFormaIdentificar:
        type: "integer"
        format: "int32"
      ConsultaValorIdentificador:
        type: "string"
      WSCliente:
        description: WSInformacion Cliente
        $ref: "#/definitions/WSInformacionCliente"

  WSInformacionCliente:
    properties:
      CodigoCliente:
        description: Código del Cliente
        type: "integer"
        format: "int64"

      TipoDePersona:
        description: Tipo de Persona
        type: "string"

      TipoIdentificacion:
        description: Tipo de Identificación
        type: "integer"
        format: "int32"

      DocumentoIdentificacionPais:
        description: PaísPais de Emisión Documento
        type: "integer"
        format: "int64"

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

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

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

      NumeroIdentificacion:
        description: Número de Identificación ClientesClien
        type: "string"

      PrimerNombre:
        description: Primer Nombre
        type: "string"

      SegundoNombre:
        description: Segundo Nombre
        type: "string"

      PrimeApellido:
        description: Primer Apellido
        type: "string"

      SegundoApellido:
        description: Segundo Apellido
        type: "string"

      ApellidoCasada:
        description: Apellido de Casada
        type: "string"

      Sexo:
        description: Sexo Cliente
        type: "string"

      FechaNacimiento:
        description: Fecha de Nacimiento
        type: "string"
        format: "date"

      EstadoCivil:
        description: Estado Civil
        type: "integer"
        format: "int32"

      NombreJuridico:
        description: Nombre de Empresa o Sociedad
        type: "string"

      RepresentanteLegal:
        description: Nombre del Representante Legal
        type: "string"

      NumeroRegistroMercantil:
        description: Número de Registro Mercantil
        type: "string"

      FechaConstitucion:
        description: Fecha de Constitución
        type: "string"
        format: "date"

      Grupo:
        description: Código del Grupo de Afinidad
        type: "integer"
        format: "int64"

      NumeroIdentificacionTributaria:
        description: Número de Identificación Tributaria
        type: "string"

      Promotor:
        description: Código Promotor
        type: "string"

      AfectoAImpuestos:
        description: Afecto a Impuestos
        type: "string"

      EstadoCliente:
        description: Estado del Cliente
        type: "string"

      CodigoReferencia:
        description: Referencia
        type: "string"

      ActividadEconomica:
        description: Código de actividad económica
        type: "integer"
        format: "int32"

      DireccionEMailPrincipal:
        description: Correo Electrónico
        type: "string"

      DireccionEMailSecundario:
        description: Correo Electrónico Alternativo
        type: "string"

      ExcluirDeMensajesDeCorreo:
        description: Excluir de Correos ElectrónicosElectronicos
        type: "integer"
        format: "int32"

      ParametrosExtendidos_B1Integration:
        description: ParámetrosParametros Extendidos_B1 Integration
        $ref: "#/definitions/ParametrosExtendidos_B1Integration"

      Prestamos:
        type: array
        items:
          description: PréstamoPrestamo
          $ref: "#/definitions/WSInformacionCliente.Prestamos"

      CuentasAhorro:
        type: array
        items:
          description: CuentaAhorro
          $ref: "#/definitions/WSInformacionCliente.CuentasAhorro"

      CalificadoresAdicionales:
        type: array
        items:
          description: CalificadorAdicional
          $ref: "#/definitions/WSInformacionCliente.CalificadoresAdicionales"

      CuentasBancarias:
        type: array
        items:
          description: CuentaBancaria
          $ref: "#/definitions/WSInformacionCliente.CuentasBancarias"

      Telefonos:
        type: array
        items:
          description: TeléfonoTelefono
          $ref: "#/definitions/WSInformacionCliente.Telefonos"

      Direcciones:
        type: array
        items:
          description: DirecciónDireccion
          $ref: "#/definitions/WSInformacionCliente.Direcciones"

     ParametrosExtendidos_B1Integration:
    properties:
   RefPersonales:
   CentrosDeCosto:         type: array
        items:
          description: CentroDeCostoReferencia
          $ref: "#/definitions/ParametrosExtendidos_B1IntegrationWSInformacionCliente.CentrosDeCostoRefPersonales"


     ProyectosWSInformacionCliente.Prestamos:
        type: arrayproperties:
        itemsNumeroPrestamo:
 
        description: ProyectoNúmero del Préstamo
        $reftype: "#/definitions/ParametrosExtendidos_B1Integration.Proyectosstring"

      TransaccionesNombrePrestamo:
        typedescription: arrayNombre del Préstamo
      items:  type: "string"

      descriptionProducto:
Transacciones        description: Codigo Producto
$ref: "#/definitions/ParametrosExtendidos_B1Integration.Transacciones"        Series:type: "integer"
        typeformat: array"int32"

       itemsSubProducto:
          description: SerieCódigo SubProducto Colocacion
        $reftype: "#/definitions/ParametrosExtendidos_B1Integration.Seriesinteger"
    ParametrosExtendidos_B1Integration.CentrosDeCosto:    format: "int32"
properties:
      SecuenciaSaldo:
        description: Saldo Secuenciade Capital
        type: "integernumber"
        format: "int32double"


     CodigoCCSAP:x-gx-level: "WSInformacionCliente"


  WSInformacionCliente.CuentasAhorro:
    descriptionproperties:
Código CCSAP     NumeroCuenta:
   type: "string"

      NombreCCSAP:
          description: NombreNumero CCSAPCuenta
        type: "string"

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

      NombreCCSifcoSubProducto:
        description: Código Nombredel CCSifcoSubProducto
        type: "stringinteger"
        x-gx-levelformat: "ParametrosExtendidos_B1Integration"int32"

      TieneCondicionesEspeciales:
        ParametrosExtendidos_B1Integration.Proyectos:description: Tiene Condiciones Especiales
        propertiestype: "string"

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

      CodigoProyectoSAPMontoDescuentoPlanilla:
        description: CódigoMonto ProyectoDescuento SAPPlanilla
        type: "stringnumber"
       NombreCCSAP format: "double"

      descriptionFrecuenciaDescuentoPlanilla:
Nombre CCSAP       description: Código de la Frecuencia
        type: "string"integer"
        format: "int32"

      CodigoCCSifcoReferencia:
        description: Cuenta Códigode CCSifcoReferencia
        type: "integerstring"

       formatMonto:
"int32"        NombreCCSifcodescription: Monto
        descriptiontype: Nombre CCSifco"number"
        typeformat: "stringdouble"


    x-gx-level: "ParametrosExtendidos_B1IntegrationWSInformacionCliente"


  ParametrosExtendidos_B1IntegrationWSInformacionCliente.TransaccionesCalificadoresAdicionales:
    properties:
      InterfazarCodigosDeTransaccionCodigoCalificador:
        description: Interfazar Códigos De Transacción Código
        type: "integer"
        typeformat: "booleanint32"

      NombreCampoSAPValorCalificador:
        description: NombreValor del Campocalificador SAPadicional
        type: "string"


    x-gx-level: "ParametrosExtendidos_B1IntegrationWSInformacionCliente"


  ParametrosExtendidos_B1IntegrationWSInformacionCliente.SeriesCuentasBancarias:
    properties:
      ObjetoDeNegocioCorrelativo:
        description: ObjetoReferencia DeBancaria
Negocio         type: "integer"
        format: "int32"

      CodigoSerieSAPCodigoBanco:
        description: CódigoCodigo Serie SAPBanco
        type: "stringinteger"
        NombreSerieSAPformat: "int32"

      descriptionTipoCuenta:
Nombre  Serie SAP     description: Tipo de Cuenta
type: "string"       x-gx-leveltype: "ParametrosExtendidos_B1Integrationinteger"
     WSInformacionCliente.Prestamos:   format: "int32"
properties:
      NumeroPrestamoNumeroCuenta:
        description: Número de della PréstamoCuenta
        type: "string"

      NombrePrestamoEstadoReferencia:
        description: Estatus de Nombrela delReferencia PréstamoBanca
        type: "string"


     Producto:x-gx-level: "WSInformacionCliente"


  WSInformacionCliente.Telefonos:
    descriptionproperties:
Codigo Producto     Correlativo:
    type: "integer"   description: Correlativo por cliente
  format:       type: "integer"
        format: "int32"

      SubProductoTipoTelefono:
        description: CódigoTipo SubProductode Colocacióntelefono
        type: "integer"
        format: "int32"

      SaldoNumeroTelefono:
        description: SaldoNúmero detelefonico
Capital         type: "number"string"

      ObservacionTelefono:
        description: Observaciones
        formattype: "doublestring"


    x-gx-level: "WSInformacionCliente"


  WSInformacionCliente.CuentasAhorroDirecciones:
    properties:
      NumeroCuentaCorrelativo:
        description: Correlativo Numerode CuentaDirección
        type: "string"integer"
        format: "int32"

      ProductoTipoDireccion:
        description: CódigoTipo de ProductoDirección
        type: "integer"
        format: "int32"

      SubProductoDireccionPais:
        description: Código delpais SubProductodirección
        type: "integer"
        format: "int32int64"

      TieneCondicionesEspecialesDireccionDepartamento:
        description: TieneCódigo Condiciones EspecialesRegión Dirección
        type: "integer"
        format: "int64"

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

      DireccionZona:
    FrecuenciaCondicionesEspeciales:    description: Código Municipio Dirección
        type: "integer"
        format:  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: "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 país 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"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"
        }
      ],
      "Proyectos": [
        {
          "Secuencia": 0,
          "CodigoProyectoSAP": "string",
          "NombreCCSAP": "string",
          "CodigoCCSifco": 0,
          "NombreCCSifco": "string"
        }
      ],
      "Transacciones": [
        {
          "InterfazarCodigosDeTransaccion": true,
          "NombreCampoSAP": "string"
        }
      ],
      "Series": [
        {
          "ObjetoDeNegocio": 0,
          "CodigoSerieSAP": "string",
          "NombreSerieSAP": "string"

Geolocalizacion:
} ]
description:

Geolocalización

},
type:
"
string
Prestamos": [
DireccionEmpresaDondeLabora:
{
description
"NumeroPrestamo":
Nombre de la empresa donde labora
"string", "NombrePrestamo": "string",
type:
"
string
Producto": 0,
Puesto:
"SubProducto": 0,
description: Puesto en la empresa
"Saldo": 0 } ],
type:
"
string
CuentasAhorro": [
x-gx-level: "WSInformacionCliente"
{
WSIngresarClientesOutput:
"NumeroCuenta": "string",
properties:

CodigoCliente
"Producto": 0,
type:
"
integer
SubProducto": 0,
format
"TieneCondicionesEspeciales": "
int64
string",
ConsultaResultados:
"FrecuenciaCondicionesEspeciales": 0,
description
"MontoDescuentoPlanilla":
WSInformacion
0,
Cliente

type
"FrecuenciaDescuentoPlanilla":
array
0,
items
"Referencia":

"string",
$ref: "#/definitions/WSInformacionCliente"
"Monto": 0
Messages:
} ],
description:

Messages
"CalificadoresAdicionales": [
type:

array
{
items
"CodigoCalificador": 0,
$ref
"ValorCalificador": "
#/definitions/Messages_Message
string"
Result:
} ],
type:
"
string"
CuentasBancarias": [ {
Messages_Message:

properties:
"Correlativo": 0,
Id:
"CodigoBanco": 0,
description
"TipoCuenta":
Id
0,
type
"NumeroCuenta": "string",
Type
"EstadoReferencia": "string" }
description:

Type
],
type:
"
integer
Telefonos": [ {
format:

"int32"

Description:
"Correlativo": 0,
description
"TipoTelefono":
Description
0,
type
"NumeroTelefono": "string",
GxJsonError:
"ObservacionTelefono": "string"
properties:
}
error:
],
$ref
"Direcciones":
"#/definitions/GxJsonError.error"
[
GxJsonError.error:
{
properties:

code:
"Correlativo": 0,
description
"TipoDireccion":
Código
0,
de

Error
"DireccionPais": 0,
type:

"string"

message:
"DireccionDepartamento": 0,
description
"DireccionMunicipio":
Mensaje
0,
de

Error
"DireccionZona": 0,
type:

"string"

x-gx-level
"Direccion": "
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 permite la consulta o creación de datos en la Aplicación WEB, 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:
Code Block
https://test.sifco.org/democoopgt/rest/wsingresarclientes
HEADERS
Code Block
language html
content-type: application/x-www-form-urlencoded 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", "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
language json
{ "CodigoCliente": 0, "ConsultaResultados": [ { "CodigoCliente": 0, "TipoDePersona": "string", "
SegundoApellido
TipoIdentificacion":
"string"
0, "
ApellidoCasada
DocumentoIdentificacionPais":
"string"
0,
"Sexo":

"string",

"
FechaNacimiento
DocumentoIdentificacionDepartamento":
"2019-09-18",
0, "
EstadoCivil
DocumentoIdentificacionMunicipio": 0, "
NombreJuridico
DocumentoIdentificacionZona":
"string"
0,

"
RepresentanteLegal
NumeroIdentificacion": "string", "
NumeroRegistroMercantil
PrimerNombre": "string", "
FechaConstitucion
SegundoNombre": "
2019-09-18
string",
"Grupo": 0,

"
NumeroIdentificacionTributaria
PrimeApellido": "string", "
Promotor
SegundoApellido": "string", "
AfectoAImpuestos
ApellidoCasada": "string", "
EstadoCliente
Sexo": "string", "
CodigoReferencia
FechaNacimiento": "
string
2019-09-18", "
ActividadEconomica
EstadoCivil": 0, "
DireccionEMailPrincipal
NombreJuridico": "string", "
DireccionEMailSecundario
RepresentanteLegal": "string", "
ExcluirDeMensajesDeCorreo
NumeroRegistroMercantil":
0
"string", "
ParametrosExtendidos_B1Integration
FechaConstitucion":
{
"2019-09-18", "
CentrosDeCosto
Grupo":
[ {
0, "
Secuencia
NumeroIdentificacionTributaria":
0
"string",

"
CodigoCCSAP
Promotor": "string",

"
NombreCCSAP
AfectoAImpuestos": "string",

"
CodigoCCSifco
EstadoCliente":
0
"string",

"
NombreCCSifco
CodigoReferencia": "string", "ActividadEconomica": 0,
}

]
"DireccionEMailPrincipal": "string", "
Proyectos
DireccionEMailSecundario": "string",
[
"ExcluirDeMensajesDeCorreo": 0,
{
"ProfesionUOficio": "string", "
Secuencia
ParametrosExtendidos_B1Integration":
0,
{

"
CodigoProyectoSAP
CentrosDeCosto":
"string",
[ {
"NombreCCSAP":

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

},
"
Prestamos
NombreCCSifco":
[
"string"
{
}
"NumeroPrestamo": "string"
], "
NombrePrestamo
Transacciones":
"string",
[ {
"Producto":

0,
"
SubProducto
InterfazarCodigosDeTransaccion":
0
true, "
Saldo
NombreCampoSAP":
0
"string" }
}
], "
CuentasAhorro
Series": [
{
{
"NumeroCuenta":

"string",
"
Producto
ObjetoDeNegocio": 0, "
SubProducto
CodigoSerieSAP":
0,
"string", "
TieneCondicionesEspeciales
NombreSerieSAP": "string"
,
}
"FrecuenciaCondicionesEspeciales":

0,
]
"MontoDescuentoPlanilla":

0,
}, "
FrecuenciaDescuentoPlanilla
Prestamos": [
0,
{
"Referencia":

"string",
"
Monto
NumeroPrestamo":
0
"string",
}

]
"NombrePrestamo": "string",
"CalificadoresAdicionales":

[
"Producto": 0,
{
"
CodigoCalificador
SubProducto": 0, "
ValorCalificador
Saldo": 0
"string"
} ], "
CuentasBancarias
CuentasAhorro": [ { "
Correlativo
NumeroCuenta":
0
"string", "
CodigoBanco
Producto": 0, "
TipoCuenta
SubProducto": 0, "
NumeroCuenta
TieneCondicionesEspeciales": "string", "
EstadoReferencia
FrecuenciaCondicionesEspeciales":
"string"
0,
}
"MontoDescuentoPlanilla":
]
0,
"Telefonos":

[
"FrecuenciaDescuentoPlanilla": 0,
{
"
Correlativo
Referencia":
0
"string", "
TipoTelefono
Monto": 0
,
}
"NumeroTelefono":

"string",
], "
ObservacionTelefono
CalificadoresAdicionales":
"string"
[ {
}

],
"
Direcciones
CodigoCalificador":
[
0, "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":

[

{

"
CodigoCliente
TipoTelefono": 0, "
TipoDePersona
NumeroTelefono": "string",

"TipoIdentificacion":

0,
"
DocumentoIdentificacionPais
ObservacionTelefono":
0,
"string"
"DocumentoIdentificacionDepartamento":

0,
}
"DocumentoIdentificacionMunicipio":

0
], "
DocumentoIdentificacionZona
Direcciones":
0,
[ {
"NumeroIdentificacion":

"string",
"
PrimerNombre
Correlativo":
"string",
0, "
SegundoNombre
TipoDireccion":
"string",
0, "
PrimeApellido
DireccionPais":
"string"
0, "
SegundoApellido
DireccionDepartamento":
"string",
0, "
ApellidoCasada
DireccionMunicipio":
"string"
0, "
Sexo
DireccionZona":
"string"
0, "
FechaNacimiento
Direccion": "
2019-09-18
string",

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

0,
]
"NumeroIdentificacionTributaria":

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

],

"
CodigoCCSAP
Result": "string"
,
}
400 (Bad Request).
Solicitud Errada
Code Block
language json
{ "error": { "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":[],

"Messages":[], "
Proyectos
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"
"Secuencia": 0, "CodigoProyectoSAP": "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,

"
Transacciones
DocumentoIdentificacionDepartamento":
[
13,
{
"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" }
}
], "CalificadoresAdicionales": [],

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

"Direcciones": [], "
Correlativo
RefPersonales":
0,
[] } }
200 (Successful operation)
Operación Exitosa
Code Block
language json
{ "CodigoCliente": "1", "ConsultaResultados": [], "Messages": [], "
CodigoBanco
Result":
0,
"OK" }
400 (Bad Request).
Solicitud Errada
Code Block
language json
{ "
TipoCuenta
error":
0,
{
"NumeroCuenta
"code": "string",

"
EstadoReferencia
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": { "
Telefonos
code":"0",
[
"message":"This service needs an Authorization
{
Header" } } { "CodigoCliente":"", "
Correlativo
ConsultaResultados":
0
[], "Messages":[],

"
TipoTelefono
Result":
0,
"" }
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": {

"
NumeroTelefono
code":
"string",
"string", "
ObservacionTelefono
message": "string
" } ], "Direcciones": [ { "Correlativo": 0, "TipoDireccion": 0, "DireccionPais": 0, "DireccionDepartamento": 0, "DireccionMunicipio": 0, "DireccionZona": 0, "Direccion": "string", "CodigoPostal": "string", "Geolocalizacion": "string", "DireccionEmpresaDondeLabora": "string", "Puesto": "string" } ] } ], "Messages": [ { "Id": "string
" } }
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": { "TipoIdentificacion": 1, "NumeroIdentificacion": "9999999999", "
Type
PrimerNombre":
0
"XXXXXX", "
Description
SegundoNombre": "
string
XXXXXXXX",
}

], "Result
"PrimeApellido": "
string" }
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
{
XXXXXXXX", "
error
SegundoApellido": "XXXXXXX",
{
"
code
ApellidoCasada": "
string
", "
message
FechaNacimiento": "
string"
1995-09-18",
} }
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
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.
"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 20

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 20

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