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 metodo tipo GETresponses:
         Insert200:
Permite el metodo tipo POST      description: Update: Permite el metodo tipo PUT"Successful operation"
          Deleteschema:
 Permite el metodo tipo DELETE       FullControl$ref: Permite el manejo de los Cuatro Metodos 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: Pais de Emisión Documento
        type $ref: "integer#/definitions/WSInformacionCliente"

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

      DocumentoIdentificacionMunicipioTipoDePersona:
        description: DepartamentoTipo Emisiónde IdentificPersona
        type: "integerstring"

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

      NumeroIdentificacionDocumentoIdentificacionPais:
        description: NúmeroPais de IdentificaciónEmisión ClienDocumento
        type: "stringinteger"
       PrimerNombre format: "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: Código SegundoMunicipio Emisión ApellidoIdent
        type: "string"integer"
        format: "int64"

      ApellidoCasadaNumeroIdentificacion:
        description: ApellidoNúmero de CasadaIdentificación Clien
        type: "string"

      SexoPrimerNombre:
        description: SexoPrimer ClienteNombre
        type: "string"

      FechaNacimientoSegundoNombre:
        description: FechaSegundo de NacimientoNombre
        type: "string"

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

      type: "integer"
        format: "int32"

SegundoApellido:
     NombreJuridico:         description: NombreSegundo de EmpresaApellido
o Sociedad         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 Códigodel Representante PromotorLegal
        type: "string"

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

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

      CodigoReferenciaGrupo:
        description: ReferenciaCó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 Correos ElectronicosCliente
        type: "integerstring"

       formatCodigoReferencia:
"int32"        ParametrosExtendidos_B1Integrationdescription: Referencia
       description type: Parametros Extendidos_B1 Integration"string"

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

        descriptionDireccionEMailPrincipal:
Prestamo        description: Correo Electrónico
$ref: "#/definitions/WSInformacionCliente.Prestamos"        CuentasAhorrotype: "string"

      typeDireccionEMailSecundario: array
        itemsdescription: Correo Electrónico Alternativo
        descriptiontype: CuentaAhorro"string"

      ExcluirDeMensajesDeCorreo:
   $ref: "#/definitions/WSInformacionCliente.CuentasAhorro"    description: Excluir de Correos CalificadoresAdicionales:Electronicos
        type: array"integer"
        itemsformat: "int32"

      ParametrosExtendidos_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: TelefonoCuentaAhorro
          $ref: "#/definitions/WSInformacionCliente.TelefonosCuentasAhorro"

      DireccionesCalificadoresAdicionales:
        type: array
        items:
          description: DireccionCalificadorAdicional
          $ref: "#/definitions/WSInformacionCliente.DireccionesCalificadoresAdicionales"

     ParametrosExtendidos_B1Integration:
    properties:
  CuentasBancarias:
    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: SecuenciaNúmero del Préstamo
        type: "integerstring"

       formatNombrePrestamo:
"int32"        CodigoCCSAPdescription: Nombre del Préstamo
      description: Codigo CCSAPtype: "string"

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

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

      NombreCCSifcoSaldo:
        description: NombreSaldo de 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: Codigo Proyecto SAPtype: "integer"
        typeformat: "stringint32"

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

      descriptionTieneCondicionesEspeciales:
Codigo CCSifco       description: Tiene type: "integer"Condiciones Especiales
        formattype: "int32string"

      NombreCCSifcoFrecuenciaCondicionesEspeciales:
        description: Código de Nombrela CCSifcoFrecuencia
        type: "stringinteger"
        x-gx-levelformat: "ParametrosExtendidos_B1Integrationint32"

   ParametrosExtendidos_B1Integration.Transacciones:   MontoDescuentoPlanilla:
 properties:       InterfazarCodigosDeTransacciondescription: Monto Descuento Planilla
     description: Interfazar Codigos De Transacciontype: "number"
        typeformat: "booleandouble"

      NombreCampoSAPFrecuenciaDescuentoPlanilla:
        description: NombreCódigo Campode SAPla Frecuencia
        type: "stringinteger"
        x-gx-levelformat: "ParametrosExtendidos_B1Integrationint32"

   ParametrosExtendidos_B1Integration.Series:     propertiesReferencia:
      ObjetoDeNegocio:
        description: ObjetoCuenta Dede NegocioReferencia
        type: "integerstring"

       formatMonto:
"int32"

      CodigoSerieSAP:         description: Codigo SerieMonto
SAP         type: "stringnumber"
       NombreSerieSAP:
        description: Nombre Serie SAP
        type format: "stringdouble"


    x-gx-level: "ParametrosExtendidos_B1IntegrationWSInformacionCliente"


  WSInformacionCliente.PrestamosCalificadoresAdicionales:
    properties:
      NumeroPrestamoCodigoCalificador:
        description: Número del PréstamoCódigo
        type: "integer"
        typeformat: "stringint32"

      NombrePrestamoValorCalificador:
        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
Colocacion         type: "integer"
        format: "int32"

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

      x-gx-levelNumeroCuenta:
"WSInformacionCliente"     WSInformacionCliente.CuentasAhorro:     propertiesdescription: Número de la Cuenta
  NumeroCuenta:      type: "string"

description: Numero Cuenta    EstadoReferencia:
    type: "string"   description: Estatus de la Referencia Producto:Banca
        descriptiontype: Codigo"string"
Producto

       typex-gx-level: "integerWSInformacionCliente"


  WSInformacionCliente.Telefonos:
   format properties:
"int32"        SubProductoCorrelativo:
        description: CódigoCorrelativo delpor SubProductocliente
        type: "integer"
        format: "int32"

      TieneCondicionesEspecialesTipoTelefono:
        description: TieneTipo Condicionesde Especialestelefono
        type: "stringinteger"
       FrecuenciaCondicionesEspeciales format: "int32"

      descriptionNumeroTelefono: Código
de la Frecuencia      description: Número telefonico
type: "integer"         formattype: "int32string"

      MontoDescuentoPlanillaObservacionTelefono:
        description: Monto Descuento PlanillaObservaciones
        type: "numberstring"


    x-gx-level: "WSInformacionCliente"


  format: "double"
WSInformacionCliente.Direcciones:
    properties:
      FrecuenciaDescuentoPlanillaCorrelativo:
        description: CódigoCorrelativo de laDirección
Frecuencia         type: "integer"
        format: "int32"

      ReferenciaTipoDireccion:
        description: CuentaTipo de ReferenciaDirección
        type: "stringinteger"
       Monto format: "int32"

      descriptionDireccionPais:
Monto        description: Código type: "number"pais dirección
        formattype: "doubleinteger"
      x-gx-level  format: "WSInformacionClienteint64"

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

      ValorCalificadorDireccionMunicipio:
        description: ValorCódigo delDepartamento calificadorDirección
adicional         type: "stringinteger"
       x-gx-level format: "WSInformacionClienteint64"



 WSInformacionCliente.CuentasBancarias:     propertiesDireccionZona:
  
   Correlativo:         description: Código ReferenciaMunicipio BancariaDirección
        type: "integer"
        format: "int32int64"

      CodigoBancoDireccion:
        description: CodigoDirección
Banco         type: "integerstring"

       formatCodigoPostal:
"int32"        TipoCuentadescription: Código Postal
      description: Tipo de Cuenta  type: "string"

      Geolocalizacion:
        typedescription: "integer"Geolocalización
        formattype: "int32string"

      NumeroCuentaDireccionEmpresaDondeLabora:
        description: NúmeroNombre de la empresa donde Cuentalabora
        type: "string"

      EstadoReferenciaPuesto:
        description: EstatusPuesto deen la Referenciaempresa
Banca         type: "string"


    x-gx-level: "WSInformacionCliente"


  WSInformacionCliente.TelefonosRefPersonales:
    properties:
      Correlativo:
        description: Correlativo porde clienteReferencia Personal
        type: "integer"
        format: "int32"

      TipoTelefonoTipoPersona:
        description: Tipo de telefonoPersona Referencia
        type: "integerstring"

       format: "int32"

      NumeroTelefonoNombre:
        description: NúmeroReferencia telefonicoNombre
        type: "string"

      ObservacionTelefonoDireccion:
        description: Dirección Referencia ObservacionesPersonal
        type: "string"

     x-gx-level: "WSInformacionCliente"


  WSInformacionCliente.Direcciones CodigoPostal:
    properties:       Correlativodescription: Código Postal       description: Correlativo de DirecciónRef. Personal
        type: "integer"
        format: "int32int64"

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

       formatFax:
"int32"        DireccionPaisdescription: FAX Referencia Personal
     description: Código pais direccióntype: "string"

      typeemail:
  "integer"      description: Correo Electrónico Ref. format: "int64"Per.
        DireccionDepartamentotype: "string"

      descriptionTipoRelalcion:
Código Región Dirección      description: Tipo de type:Relación
"integer"         formattype: "int64string"

      DireccionMunicipioDetalle:
        description: CódigoDetalles de Departamentola DirecciónReferencia
        type: "integerstring"

       formatEstatus:
"int64"        DireccionZonadescription: Estatus de la      description: Código Municipio DirecciónReferencia Per.
        type: "integerstring"

       formatCelular:
"int64"        Direcciondescription: Celular referencia personal
     description: Dirección  type: "string"


    typex-gx-level: "stringWSInformacionCliente"
  ParametrosExtendidos_B1Integration:
    CodigoPostalproperties:
        description: Código PostalCentrosDeCosto:
        type: "string"array
        Geolocalizacionitems:
          description: CentroDeCosto
 Geolocalización         type$ref: "string#/definitions/ParametrosExtendidos_B1Integration.CentrosDeCosto"

      DireccionEmpresaDondeLaboraProyectos:
        descriptiontype: Nombrearray
de la empresa donde labora    items:
    type: "string"     description: Proyecto
 Puesto:         description: Puesto en la empresa$ref: "#/definitions/ParametrosExtendidos_B1Integration.Proyectos"

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

     x-gx-level: "WSInformacionCliente" Series:
        WSIngresarClientesOutputtype: array
     properties:   items:
        CodigoCliente  description: Serie
         type $ref: "integer#/definitions/ParametrosExtendidos_B1Integration.Series"

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

     ConsultaResultados PagosTransferencia:
        descriptiontype: WSInformacionarray
Cliente        items:
type: array         itemsdescription: PagoTransferencia
          $ref: "#/definitions/WSInformacionCliente"
      Messages:
        description: Messages
        type: array
        items:
          $ref: "#/definitions/Messages_Message"
      Result:
        type: "string"


  Messages_Message:
    properties:
      Id:
        description: Id
        type: "string"

      Type:
        description: Type
        type: "integer"
        format: "int32"

      Description:
        description: Description
        type: "string"

 
  GxJsonError:
    properties:
      error:
        $ref: "#/definitions/GxJsonError.error"

  GxJsonError.error:
    properties:
      code:
        description: Codigo de Error
        type: "string"

      message:
        description: Mensaje de Error
        type: "string"


    x-gx-level: "GxJsonError"

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.

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.

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.

RESPETE LOS ENCABEZADOS OBLIGATORIOS para que pueda consumir el WEB SERVICE respectivo.

Content-Type: application/json
Authorization: OAuth f2a9ec34-cf83-46f5-8862-f78ac03670d1!171380a787a9152688ab61a94d66e0eb77...
GENEXUS-AGENT: SmartDevice Application

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.

 {
  "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"
} 


  

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