Versions Compared

Old Version 17

changes.mady.by.user Alfredo Lopez

Saved on

compared with

New Version Current

changes.mady.by.user H. Samuel Casuy D.

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Web Services para Ingresar Clientes al Sistema.

Note

NO DEBE OLVIDAR

Antes de consumir este Web Service, debe consultar cada una de los WS descritos en Web Services de Consulta de Categorías Generales, dado a que en ellos se listan los valores ya cargados de un conjunto de parámetros necesarios para ingresar un cliente al sistema, y dichos parámetros deben coincidir con los ya existentes en el 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: description: "Not Authenticated" schema: $ref: "#/definitions/GxJsonError" 404: description: "Not found" schema: $ref: "#/definitions/GxJsonError" 400: description: "Bad request" schema: $ref: "#/definitions/GxJsonError" 500: description: "Internal server error" schema:

DESCRIPCIÓN.

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

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

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

Modo

Modo de Acceso al Cliente en el Sistema.

Valor

Significado

DSP

Permite Obtener toda la información del Cliente, cargada en el Sistema.

INS

Permite Incluir un Cliente en el Sistema.

UPD

Permite Actualizar solos los campos de Datos Generales, y Cuentas de Ahorro del Cliente en el Sistema.

Swagger open api macro
swagger: '2.0'
info:
  title: "SIFCO_REST_API"
  version: "1.0"
  termsOfService: "https://sifco.org/sobre-nosotros/"
  contact:
    email: "soporte@sifco.org"
  license:
    name: "Apache 2.0"  
    url: "http://www.apache.org/licenses/LICENSE-2.0.html"
host: "<SERVER>"
schemes:
  - https
  - http
basePath: /<APPDIR>/rest
tags:
- name: "WSIngresarClientes"
  externalDocs:
    description: "Manual SIFCO"
    url: "https://sifco.atlassian.net/wiki/x/9ISo"
produces:
  - application/json
paths:
  /WSIngresarClientes:
    post:
      tags:
        - WSIngresarClientes
      operationId: "WSIngresarClientes"
      summary: "WSIngresar Clientes"
      parameters:
        - name: "WSIngresarClientesInput"
           $refin: "#/definitions/GxJsonErrorbody"
security:   - OAuth2: []     ApiKeyAuth1required: []
securityDefinitions:false
     OAuth2:     typeschema:
oauth2      flow: password     tokenUrl$ref: https:"#//test.sifco.org/DemoCoopGT/oauth/access_tokendefinitions/WSIngresarClientesInput"


  scopes:       Execute: Permite el método tipo GETresponses:
         Insert200:
Permite el método tipo POST      description: Update: Permite el método tipo PUT"Successful operation"
          Deleteschema:
 Permite el método tipo DELETE       FullControl$ref: Permite el manejo de los Cuatro Métodos GET, POST, PUT,DELETE, sobre el Web Service
  ApiKeyAuth1:"#/definitions/WSIngresarClientesOutput"
        404:
          typedescription: apiKey"Not found"
security:
  - inOAuth2: header[]
    nameApiKeyAuth1: granttype[]

definitionssecurityDefinitions:
   WSIngresarClientesInputOAuth2:
    propertiestype: oauth2
     Modoflow: password
    tokenUrl:   type: "string"https://test.sifco.org/DemoCoopGT/oauth/access_token
       ConsultaFormaIdentificarscopes:
      Execute: Permite type: "integer"
 el método tipo GET
      formatInsert: "int32"Permite el método tipo POST
  ConsultaValorIdentificador:    Update: Permite el método  type: "string"tipo PUT
      WSClienteDelete: Permite el método tipo DELETE
   description: WSInformacion Cliente FullControl: Permite el manejo de los Cuatro Métodos $ref: "#/definitions/WSInformacionCliente"

  WSInformacionCliente:
    properties:GET, POST, PUT,DELETE, sobre el Web Service
  ApiKeyAuth1:
    type: apiKey
 CodigoCliente:   in: header
    descriptionname: Códigogranttype
del
Clientedefinitions:

  WSIngresarClientesInput:
    typeproperties: "integer"
        formatModo:
"int64"        TipoDePersonatype: "string"
       descriptionConsultaFormaIdentificar:
Tipo de Persona         type: "stringinteger"
       TipoIdentificacion format: "int32"
       description: Tipo de IdentificaciónConsultaValorIdentificador:
        type: "integerstring"
        formatWSCliente:
"int32"        DocumentoIdentificacionPaisdescription: WSInformacion Cliente
      description: País de Emisión Documento
        type $ref: "integer#/definitions/WSInformacionCliente"

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

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

       formatTipoIdentificacion:
"int64"        DocumentoIdentificacionZona:
        description: CódigoTipo Municipiode Emisión Identificación
        type: "integer"
        format: "int64int32"

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

      descriptionDocumentoIdentificacionDepartamento:
Primer Nombre         typedescription: "string"Código Región Emisión Identifi
    SegundoNombre:    type: "integer"
    description:   Segundo Nombreformat: "int64"

      typeDocumentoIdentificacionMunicipio:
"string"        PrimeApellidodescription: Departamento Emisión Identific
      description  type: Primer"integer"
Apellido         typeformat: "stringint64"

      SegundoApellidoDocumentoIdentificacionZona:
        description: Segundo ApellidoCódigo Municipio Emisión Ident
        type: "stringinteger"
        format: "int64"

      ApellidoCasadaNumeroIdentificacion:
        description: ApellidoNúmero de Identificación CasadaClien
        type: "string"

      SexoPrimerNombre:
        description: SexoPrimer ClienteNombre
        type: "string"

      FechaNacimientoSegundoNombre:
        description: FechaSegundo deNombre
Nacimiento         type: "string"

       formatPrimeApellido:
"date"        EstadoCivildescription: Primer Apellido
      description: Estado Civiltype: "string"

      typeSegundoApellido:
"integer"
        format: "int32"

      NombreJuridico:         description: Nombre de Empresa o SociedadSegundo Apellido
        type: "string"

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

      NumeroRegistroMercantilSexo:
        description: NúmeroSexo deCliente
Registro Mercantil         type: "string"

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

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

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

      PromotorRepresentanteLegal:
        description: Nombre del CódigoRepresentante PromotorLegal
        type: "string"

      AfectoAImpuestosNumeroRegistroMercantil:
        description: AfectoNúmero de aRegistro ImpuestosMercantil
        type: "string"

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

      CodigoReferenciaGrupo:
        description: Referencia Código del Grupo de Afinidad
        type: "stringinteger"
        ActividadEconomicaformat: "int64"

      descriptionNumeroIdentificacionTributaria:
Código de actividad económica     description: Número de Identificación type:Tributaria
"integer"         formattype: "int32string"

      DireccionEMailPrincipalPromotor:
        description: CorreoCódigo ElectrónicoPromotor
        type: "string"

      DireccionEMailSecundarioAfectoAImpuestos:
        description: CorreoAfecto Electrónicoa AlternativoImpuestos
        type: "string"

      ExcluirDeMensajesDeCorreoEstadoCliente:
        description: ExcluirEstado dedel CorreosCliente
Electrónicos         type: "integerstring"

       formatCodigoReferencia:
"int32"        ParametrosExtendidos_B1Integrationdescription: Referencia
       description type: Parámetros Extendidos_B1 Integration"string"

      ActividadEconomica:
   $ref: "#/definitions/ParametrosExtendidos_B1Integration"    description: Código de actividad Prestamos:económica
        type: array"integer"
        items:format: "int32"

      DireccionEMailPrincipal:
        description: PréstamoCorreo Electrónico
         $reftype: "#/definitions/WSInformacionCliente.Prestamosstring"

      CuentasAhorroDireccionEMailSecundario:
        typedescription: arrayCorreo Electrónico Alternativo
      items:  type: "string"

      descriptionExcluirDeMensajesDeCorreo:
CuentaAhorro        description: Excluir de Correos $ref: "#/definitions/WSInformacionCliente.CuentasAhorro"Electronicos
        CalificadoresAdicionalestype: "integer"
        typeformat: array"int32"

       itemsParametrosExtendidos_B1Integration:
          description: CalificadorAdicionalParametros Extendidos_B1 Integration
        $ref: "#/definitions/WSInformacionCliente.CalificadoresAdicionalesParametrosExtendidos_B1Integration"

      CuentasBancariasPrestamos:
        type: array
        items:
          description: CuentaBancariaPrestamo
          $ref: "#/definitions/WSInformacionCliente.CuentasBancariasPrestamos"

      TelefonosCuentasAhorro:
        type: array
        items:
          description: TeléfonoCuentaAhorro
          $ref: "#/definitions/WSInformacionCliente.TelefonosCuentasAhorro"

      DireccionesCalificadoresAdicionales:
        type: array
        items:
          description: DirecciónCalificadorAdicional
          $ref: "#/definitions/WSInformacionCliente.DireccionesCalificadoresAdicionales"
  

  ParametrosExtendidos_B1Integration:     propertiesCuentasBancarias:
      CentrosDeCosto:
        type: array
        items:
          description: CentroDeCostoCuentaBancaria
          $ref: "#/definitions/ParametrosExtendidos_B1IntegrationWSInformacionCliente.CentrosDeCostoCuentasBancarias"

      ProyectosTelefonos:
        type: array
        items:
          description: ProyectoTelefono
          $ref: "#/definitions/ParametrosExtendidos_B1IntegrationWSInformacionCliente.ProyectosTelefonos"

      TransaccionesDirecciones:
        type: array
        items:
          description: TransaccionesDireccion
          $ref: "#/definitions/ParametrosExtendidos_B1IntegrationWSInformacionCliente.TransaccionesDirecciones"

      SeriesRefPersonales:
        type: array
        items:
          description: SerieReferencia
          $ref: "#/definitions/ParametrosExtendidos_B1IntegrationWSInformacionCliente.SeriesRefPersonales"


  ParametrosExtendidos_B1IntegrationWSInformacionCliente.CentrosDeCostoPrestamos:
    properties:
      SecuenciaNumeroPrestamo:
        description: Número Secuenciadel Préstamo
        type: "integerstring"

      NombrePrestamo:
format: "int32"       description: CodigoCCSAP:Nombre del Préstamo
      description: Código CCSAPtype: "string"

      typeProducto:
"string"        NombreCCSAPdescription: Codigo Producto
      description  type: Nombre CCSAP"integer"
        typeformat: "stringint32"

      CodigoCCSifcoSubProducto:
        description: Código SubProducto CCSifcoColocacion
        type: "integer"
        format: "int32"

      NombreCCSifcoSaldo:
        description: Saldo Nombrede CCSifcoCapital
        type: "string"number"
        format: "double"


    x-gx-level: "ParametrosExtendidos_B1IntegrationWSInformacionCliente"


  ParametrosExtendidos_B1IntegrationWSInformacionCliente.ProyectosCuentasAhorro:
    properties:
      SecuenciaNumeroCuenta:
        description: SecuenciaNumero Cuenta
        type: "integerstring"

       formatProducto:
"int32"        CodigoProyectoSAPdescription: Codigo Producto
      description: Código Proyecto SAPtype: "integer"
        typeformat: "stringint32"

      NombreCCSAPSubProducto:
        description: Código Nombredel CCSAPSubProducto
        type: "stringinteger"
        CodigoCCSifcoformat: "int32"

      descriptionTieneCondicionesEspeciales:
Código CCSifco       description: Tiene type: "integer"Condiciones Especiales
        formattype: "int32string"

      NombreCCSifcoFrecuenciaCondicionesEspeciales:
        description: Nombre CCSifcoCódigo de la Frecuencia
        type: "stringinteger"
       x-gx-level format: "ParametrosExtendidos_B1Integrationint32"

   ParametrosExtendidos_B1Integration.Transacciones:   MontoDescuentoPlanilla:
 properties:       InterfazarCodigosDeTransacciondescription: Monto Descuento Planilla
     description: Interfazar Códigos De Transaccióntype: "number"
        typeformat: "booleandouble"

      NombreCampoSAPFrecuenciaDescuentoPlanilla:
        description: NombreCódigo de Campola SAPFrecuencia
        type: "stringinteger"
       x-gx-level format: "ParametrosExtendidos_B1Integration"


  ParametrosExtendidos_B1Integration.Series:
 int32"

 properties:       ObjetoDeNegocioReferencia:
        description: ObjetoCuenta Dede NegocioReferencia
        type: "integerstring"

       formatMonto:
"int32"        CodigoSerieSAP:
        description: CódigoMonto
Serie SAP         type: "stringnumber"


     NombreSerieSAP:         description: Nombre Serie SAP
        typeformat: "stringdouble"


    x-gx-level: "ParametrosExtendidos_B1IntegrationWSInformacionCliente"


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

      ValorCalificador:
        description: NombreValor del Préstamocalificador adicional
        type: "string"


     Productox-gx-level: "WSInformacionCliente"


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

      SubProductoCodigoBanco:
        description: CódigoCodigo SubProductoBanco
Colocación         type: "integer"
        format: "int32"

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

      x-gx-levelNumeroCuenta:
"WSInformacionCliente"        WSInformacionCliente.CuentasAhorrodescription: Número de la Cuenta
 properties:       NumeroCuentatype: "string"

      descriptionEstadoReferencia:
Numero Cuenta        description: Estatus de la Referencia Banca
        type: "string"


     Productox-gx-level: "WSInformacionCliente"


  WSInformacionCliente.Telefonos:
    properties:
      Correlativo:
        description: CódigoCorrelativo por Productocliente
        type: "integer"
        format: "int32"

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

      TieneCondicionesEspecialesNumeroTelefono:
        description: TieneNúmero Condicionestelefonico
Especiales         type: "string"

      FrecuenciaCondicionesEspecialesObservacionTelefono:
        description: Código de laObservaciones
Frecuencia         type: "integerstring"


      formatx-gx-level: "int32WSInformacionCliente"


  WSInformacionCliente.Direcciones:
  MontoDescuentoPlanilla:  properties:
      descriptionCorrelativo:
Monto Descuento Planilla        description: Correlativo de Dirección
        type: "numberinteger"
        format: "doubleint32"

      FrecuenciaDescuentoPlanillaTipoDireccion:
        description: CódigoTipo de laDirección
Frecuencia         type: "integer"
        format: "int32"

      ReferenciaDireccionPais:
        description: CuentaCódigo depais Referenciadirección
        type: "stringinteger"
       Monto format: "int64"

      descriptionDireccionDepartamento:
Monto         type: "number"description: Código Región Dirección
        formattype: "doubleinteger"
        x-gx-levelformat: "WSInformacionClienteint64"

   WSInformacionCliente.CalificadoresAdicionales:     properties:
      CodigoCalificadorDireccionMunicipio:
        description: Código Departamento Dirección
        type: "integer"
        format: "int32int64"

      ValorCalificadorDireccionZona:
        description: ValorCódigo delMunicipio calificador adicionalDirección
        type: "stringinteger"
      x-gx-level  format: "WSInformacionClienteint64"

   WSInformacionCliente.CuentasBancarias:   Direccion:
 properties:       Correlativodescription: Dirección
        descriptiontype: Referencia"string"
Bancaria
      CodigoPostal:
 type: "integer"      description: Código Postal
format: "int32"        CodigoBancotype: "string"

      descriptionGeolocalizacion:
Código Banco         typedescription: "integer"Geolocalización
        formattype: "int32string"

      TipoCuentaDireccionEmpresaDondeLabora:
        description: TipoNombre de Cuentala empresa donde labora
     type: "integer"         formattype: "int32string"

      NumeroCuentaPuesto:
        description: NúmeroPuesto deen la Cuentaempresa
        type: "string"


     EstadoReferenciax-gx-level: "WSInformacionCliente"


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


    x-gx-level: "WSInformacionCliente"


  WSInformacionCliente.Telefonos.RefPersonales:
    properties:
      Correlativo:
        description: Correlativo porde Referencia clientePersonal
        type: "integer"
        format: "int32"

      TipoTelefonoTipoPersona:
        description: Tipo de Persona teléfonoReferencia
        type: "integerstring"

       format: "int32"

      NumeroTelefonoNombre:
        description: NúmeroReferencia telefónicoNombre
        type: "string"

      ObservacionTelefonoDireccion:
        description: Dirección ObservacionesReferencia Personal
        type: "string"

      x-gx-levelCodigoPostal:
"WSInformacionCliente"      WSInformacionCliente.Direcciones:     propertiesdescription: Código Postal     Correlativo:
  Ref. Personal
     description: Correlativo de Dirección
        type: "integer"
        format: "int32int64"

      TipoDireccionTelefono:
        description: TipoTeléfono deReferencia DirecciónPersonal
        type: "integerstring"

       format: "int32"Fax:
        description: FAX Referencia Personal
        DireccionPaistype: "string"

      descriptionemail:
Código país dirección      description: Correo Electrónico type: "integer"Ref. Per.
        formattype: "int64string"

      DireccionDepartamentoTipoRelalcion:
        description: CódigoTipo Regiónde DirecciónRelación
        type: "integerstring"

      Detalle:
format: "int64"        description: Detalles de la Referencia
        DireccionMunicipiotype: "string"

      descriptionEstatus:
Código Departamento Dirección      description: Estatus de la type: "integer"Referencia Per.
        formattype: "int64string"

      DireccionZonaCelular:
        description: CódigoCelular Municipioreferencia Direcciónpersonal
        type: "integerstring"


      formatx-gx-level: "int64WSInformacionCliente"
  ParametrosExtendidos_B1Integration:
    Direccionproperties:
        descriptionCentrosDeCosto: Dirección
        type: array
"string"        CodigoPostalitems:
          description: CentroDeCosto
Código Postal         type$ref: "string#/definitions/ParametrosExtendidos_B1Integration.CentrosDeCosto"

      GeolocalizacionProyectos:
        descriptiontype: Geolocalizaciónarray
        typeitems:
  "string"        DireccionEmpresaDondeLaboradescription: Proyecto
          description$ref: Nombre de la empresa donde labora"#/definitions/ParametrosExtendidos_B1Integration.Proyectos"

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

      PuestoSeries:
        descriptiontype: Puestoarray
en la empresa      items:
  type: "string"       x-gx-leveldescription: "WSInformacionCliente"Serie
     WSIngresarClientesOutput:     properties:$ref: "#/definitions/ParametrosExtendidos_B1Integration.Series"

     CodigoCliente FormaDePago:
        type$ref: "integer#/definitions/ParametrosExtendidos_B1Integration.FormaDePago"

      PagosTransferencia:
format: "int64"       ConsultaResultadostype: array
        descriptionitems:
WSInformacion Cliente         typedescription: arrayPagoTransferencia
          items$ref: "#/definitions/ParametrosExtendidos_B1Integration.PagosTransferencia"


  ParametrosExtendidos_B1Integration.CentrosDeCosto:
    $refproperties:
"#/definitions/WSInformacionCliente"       MessagesSecuencia:
        description: MessagesSecuencia
        type: array"integer"
        itemsformat: "int32"

      CodigoCCSAP:
  $ref: "#/definitions/Messages_Message"     description: Codigo Result:CCSAP
        type: "string"

   Messages_Message:   NombreCCSAP:
 properties:       Iddescription: Nombre CCSAP
      description  type: Id"string"

      CodigoCCSifco:
   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"

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.

TP Message Type

Example

Request

Code Block

Response

Code Block
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.
     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
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,
    "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"
        }
      ]
    },
    "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,
      "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"
          }
        ]
      },
      "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,
    "ProfesionUOficio": "Ingeniero"
    "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.

Tome en cuenta estos como los campos mínimos:

Cuando es una persona individual:

Code Block
languagejson
 {
  "Modo": "INS",
  "ConsultaFormaIdentificar": 0,
  "ConsultaValorIdentificador": "",
  "WSCliente": {
      "TipoIdentificacion": 1,
      "NumeroIdentificacion": "9999999999",
      "PrimerNombre": "XXXXXX",
      "SegundoNombre": "XXXXXXXX",
      "PrimeApellido": "XXXXXXXX",
      "SegundoApellido": "XXXXXXX",
      "ApellidoCasada": "",
      "FechaNacimiento": "1995-09-18",
      "EstadoCivil": 2,
      "ActividadEconomica": 1,
      "DireccionEMailPrincipal": "XXX@sifco.org"
}


Cuando es una persona jurídica:

Code Block
{
  "Modo": "INS",
  "ConsultaFormaIdentificar": 1,
  "ConsultaValorIdentificador": "0",
  "WSCliente": {
      "CodigoCliente": "0",
      "TipoDePersona": "J",
      "TipoIdentificacion": 2,    
      "NombreJuridico": "XXXXXXXXX",
      "RepresentanteLegal": "PENDIENTE",    
      "NumeroIdentificacionTributaria": "99999",
  }
}

Live Search
spaceKeyDOC
placeholderBúsqueda en esta Pagina
typepage

Enlaces Relevantes

preestablecidas por

  • WSApTiposIdentificacionLista

  • WSClGruposLista

  • WSApUsuariosSistemaLista

  • WSApPaisLista

  • WSApDepartamentoLista

  • WSApMunicipioLista

  • WSActividadEconomicaLista

  • WSApBancosLista

  • WSApCaptacionProductosLista

  • WSApFrecuenciasLista

  • WSApCamposDefinidosUsuarioLista

    • 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
    hideHeadingtrue
    Change History