Versions Compared

Key

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

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 préstamos, incluyendo todos sus datos claves. Además de quedar registrado en la Aplicación SIFCO WEB, como un préstamo en estado pendiente. Adicionalmente se debe indicar que las opciones de Consulta, Ingreso o Actualización depende del parámetro Modo.

...

Modo

Modo de Acceso al Cliente en el Sistema.

...

Valor

...

Significado

...

DSP

...

Permite Obtener toda la información del préstamo cargada en el Sistema.

...

INS

...

Permite Incluir un préstamo en el Sistema.

...

UPD

...

Permite Actualizar solos los campos de Datos Generales del préstamo en el Sistema.

Swagger open api macroswagger: '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: /WSIngresarPrestamo: post: tags: - WSIngresarPrestamo operationId: "WSIngresarPrestamoEste 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 préstamos, incluyendo todos sus datos claves. Además de quedar registrado en la Aplicación SIFCO WEB, como un préstamo en estado pendiente. Adicionalmente se debe indicar que las opciones de Consulta, Ingreso o Actualización depende del parámetro Modo.

Modo

Modo de Acceso al Cliente en el Sistema.

Valor

Significado

DSP

Permite Obtener toda la información del préstamo cargada en el Sistema.

INS

Permite Incluir un préstamo en el Sistema.

UPD

Permite Actualizar solos los campos de Datos Generales del préstamo 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"  
    summaryurl: "WSIngresar Prestamo"
      parametershttp://www.apache.org/licenses/LICENSE-2.0.html"
host: "<SERVER>"
schemes:
  - https
  - http
- namebasePath: "WSIngresarPrestamoInput"/<APPDIR>/rest
tags:
- name: "WSIngresarClientes"
  externalDocs:
    description: "Manual SIFCO"
    inurl: "body"
  https://sifco.atlassian.net/wiki/x/9ISo"
produces:
  - application/json
paths:
  /WSIngresarPrestamo:
    requiredpost:
false      tags:
    schema:    - WSIngresarPrestamo
       $refoperationId: "#/definitions/WSIngresarPrestamoInputWSIngresarPrestamo"
        responsessummary: "WSIngresar Prestamo"
      200parameters:
        -  descriptionname: "Successful operationWSIngresarPrestamoInput"
          schemain: "body"
          required: false
$ref: "#/definitions/WSIngresarPrestamoOutput"         404schema:
            description$ref: "Not found#/definitions/WSIngresarPrestamoInput"
security:

 - OAuth2: []     ApiKeyAuth1responses:
[]
securityDefinitions:   OAuth2:     type200: oauth2
    flow: password     tokenUrldescription: https://test.sifco.org/DemoCoopGT/oauth/access_token
"Successful operation"
   scopes:       Executeschema:
Permite  el método tipo GET       Insert$ref: Permite el método tipo POST"#/definitions/WSIngresarPrestamoOutput"
        404:
 Update: Permite el método tipo PUT    description: "Not found"
Deletesecurity:
Permite el método- tipoOAuth2: DELETE[]
    ApiKeyAuth1: []
FullControlsecurityDefinitions:
Permite el manejoOAuth2:
de los Cuatro Métodos GET, POST, PUT,DELETE, sobre el Web Service
  ApiKeyAuth1:type: oauth2
    flow: password
    tokenUrl: type: apiKeyhttps://test.sifco.org/DemoCoopGT/oauth/access_token
    scopes:
in: header     nameExecute: granttypePermite el definitions:método tipo GET
 WSIngresarPrestamoInput:     propertiesInsert: Permite el método tipo POST
 Modo     Update: Permite el método tipo PUT
      typeDelete: "string"Permite el método tipo DELETE
  ConsultaNumero:    FullControl: Permite el manejo de type: "string"
      Prestamo:
   los Cuatro Métodos GET, POST, PUT,DELETE, sobre el Web Service
  ApiKeyAuth1:
    descriptiontype: apiKey
WSCr Prestamo_SDT   in: header
    $refname: granttype
"#/definitions/WSCrPrestamo_SDT"
definitions:

  WSCrPrestamo_SDTWSIngresarPrestamoInput:
    properties:
       PreEmpCodigoModo:
        descriptiontype: Código de Empresa del Préstamo"string"
           typeConsultaNumero:
"integer"         formattype: "int32string"
       PreSucCodigoPrestamo:
        description: CódigoWSCr dePrestamo_SDT
Sucursal del Préstam         type$ref: "integer#/definitions/WSCrPrestamo_SDT"

  WSCrPrestamo_SDT:
    formatproperties:
"int32"
       PreSoCrNumeroPreEmpCodigo:
        description: Número Solicitud Código de Empresa del Préstamo
        type: "integer"
        format: "int64int32"

      PrePrdCodPreSucCodigo:
        description: Código delde ProductoSucursal endel Préstam
        type: "integer"
        format: "int32"

      ApColCodPreSoCrNumero:
        description: CódigoNúmero SubProducto ColocacionSolicitud
        type: "integer"
        format: "int32int64"

      PreMonedaCodPrePrdCod:
        description: Código del MonedaProducto en quePréstam
se concedio el credito         type: "integer"
        format: "int32"

      PreCorrelativoApColCod:
        description: CorrelativoCódigo delSubProducto préstamoColocacion
        type: "integer"
        format: "int64int32"

      PreNombrePreMonedaCod:
        description: NombreMoneda delen Préstamoque se concedio       type: "string"

      PreCliCod:
 el credito
      description: Código Cliente para Correspond
        type: "integer"
        format: "int64int32"

      PreDirCorPreCorrelativo:
        description: Correlativo dedel Dirección Clienpréstamo
        type: "integer"
        format: "int32int64"

      PrePrmCodPreNombre:
        description: Código deNombre Promotor del PréstamPréstamo
        type: "string"

      PreAprCodPreCliCod:
        description: Código Cliente Aprobaciónpara PréstamoCorrespond
        type: "integer"
        format: "int32int64"

      PreGarCodPreDirCor:
        description: Correlativo Códigode GarantíaDirección PréstamoClien
        type: "integer"
        format: "int32"

      ApOrgCodPrePrmCod:
        description: Código de OrigenPromotor dedel FondosPréstam
        type: "integerstring"

       format: "int32"

      PreFecAprobacionPreAprCod:
        description: FechaCódigo Aprobación del CréditoPréstamo
        type: "stringinteger"
        format: "dateint32"

      PreFecConcesionPreGarCod:
        description: FechaCódigo deGarantía ConcesiónPréstamo
del Préstam         type: "stringinteger"
        format: "dateint32"

      PreFecEscrituraApOrgCod:
        description: Código de FechaOrigen de EscrituraciónFondos
        type: "stringinteger"
        format: "dateint32"

      PreGrDCodPreFecAprobacion:
        description: GranFecha DivisiónAprobación Destinodel PréstamoCrédito
        type: "integerstring"
        format: "int32date"

      PrePaiCodPreFecConcesion:
        description: PaisFecha Inversiónde PréstamoConcesión del Préstam
        type: "integerstring"
        format: "int64date"

      PreRegCodPreFecEscritura:
        description: RegiónFecha Inversiónde PréstamoEscrituración
        type: "integerstring"
        format: "int64date"

      PreDepCodPreGrDCod:
        description: Gran DepartamentoDivisión InversiónDestino PréstamPréstamo
        type: "integer"
        format: "int64int32"

      PreMunCodPrePaiCod:
        description: MunicipioPais Inversión Préstamo
        type: "integer"
        format: "int64"

      PreMonOriginalPreRegCod:
        description: MontoRegión OriginalInversión del CréditoPréstamo
        type: "numberinteger"
        format: "doubleint64"

      PreMonTotalPreDepCod:
        description: MontoDepartamento TotalInversión OtorgadoPréstam
Crédito         type: "numberinteger"
        format: "doubleint64"

      CupNumeroPreMunCod:
        description: CódigoMunicipio delInversión CupoPréstamo
        type: "integer"
        format: "int64"

      PreTasaFoVPreMonOriginal:
        description: TipoMonto de TasaOriginal del PréstamoCrédito
        type: "stringnumber"
       PreTasaBase format: "double"

      descriptionPreMonTotal:
Tasa Base Asiganda al Préstamo    description: Monto Total Otorgado Crédito
        type: "number"
        format: "double"

      PreBaseMoraCupNumero:
        description: Tasa Base MoraCódigo del PréstamoCupo
        type: "numberinteger"
        format: "doubleint64"

      PreSpreCorrPreTasaFoV:
        description: TasaTipo Spread de InterésTasa del Préstamo
      type: "number"
        format type: "doublestring"

      PreSpreMoraPreTasaBase:
        description: Tasa SpreadBase deAsiganda Interesal xPréstamo
Mora         type: "number"
        format: "double"

      PreFacPlazoPreBaseMora:
        description: Tasa Base FactorMora del PlazoPréstamo
        type: "integernumber"
        format: "int32double"

      PrePlazoPreSpreCorr:
        description: PlazoTasa Spread delde PréstamoInterés
        type: "integernumber"
        format: "int32double"

      PreFecVencimientoPreSpreMora:
        description: Tasa FechaSpread de VencimientoInteres Créditox Mora
        type: "stringnumber"
        format: "datedouble"

      PreTipComPreFacPlazo:
        description: TipoFactor dedel CompromisoPlazo
        type: "integer"
        format: "int32"

      PreFreCCodPrePlazo:
        description: FrecuenciaPlazo Pagodel CapitalPréstamo
        type: "integer"
        format: "int32"

      PreFreICodPreFecVencimiento:
        description: FrecuenciaFecha Pagode InteresesVencimiento PrésCrédito
        type: "integerstring"
        format: "int32date"

      PreFec1CapPreTipCom:
        description: Fecha Primer PagoTipo de CapitalCompromiso
        type: "stringinteger"
        format: "dateint32"

      PreFec1IntPreFreCCod:
        description: FechaFrecuencia Primer Pago de InteresesCapital
        type: "stringinteger"
        format: "dateint32"

      PreDiaPagoPreFreICod:
        description: Frecuencia DíaPago deIntereses PagoPrés
        type: "integer"
        format: "int32"

      PreFreCPlanillaPreFec1Cap:
        description: Fecha FrecuenciaPrimer Pago Planillade Capital
        type: "integerstring"
        format: "int32date"

      PreNumCuotasPreFec1Int:
        description: Fecha Primer NúmeroPago de CuotasIntereses
Préstamo         type: "integerstring"
        format: "int32date"

      PreValCuotaPreDiaPago:
        description: ValorDía de laPago
Cuota         type: "numberinteger"
        format: "doubleint32"

      PreCuotaDefinidaUsuarioPreFreCPlanilla:
        description: CuotaFrecuencia Definida por el UsuarioPago Planilla
        type: "numberinteger"
        format: "doubleint32"

      PreForDesPreNumCuotas:
        description: FormaNúmero de DesembolsoCuotas CréditoPréstamo
        type: "integer"
        format: "int32"

      PrePrimerDesembolsoPreValCuota:
        description: FechaValor de Primerla DesembolsoCuota
        type: "stringnumber"
        format: "datedouble"

      PreForPagoPreCuotaDefinidaUsuario:
        description: Forma de PagoCuota Definida por el Usuario
        type: "integernumber"
        format: "int32double"

      PreAsigBoletaPreForDes:
        description: AsignaForma Boletade siDesembolso oCrédito
no         type: "stringinteger"
       PreCtaNumero format: "int32"

      descriptionPrePrimerDesembolso:
Número Cuenta Captaciones      description: Fecha  typede Primer Desembolso
        type: "string"
       ApCaCCod format: "date"

      description: Código de CategoríaPreForPago:
        description: Forma de CréditoPago
        type: "integer"
        format: "int32"

      ApEstCodPreAsigBoleta:
        description: Código de EstadoAsigna Boleta si o no
        type: "string"

      PreFecModuloPreCtaNumero:
        description: FechaNúmero CreaciónCuenta segúnCaptaciones
modulo         type: "string"

       formatApCaCCod:
"date"        PreFecAdiciondescription: Código de       description: Fecha Ingreso Categoría de Crédito
        type: "stringinteger"
        format: "dateint32"

      PreUsuCodApEstCod:
        description: UsuarioCódigo quede Ingresa PréstamoEstado
        type: "string"

      PreFecModificacionPreFecModulo:
        description: Fecha deCreación Modificaciónsegún Préstamomodulo
        type: "string"
        format: "date"

      PreUsuModPreFecAdicion:
        description: UsuarioFecha queIngreso Modificó PréstamoCrédito
        type: "string"
       PreFecPCap format: "date"

      descriptionPreUsuCod: Fecha Próximo
Pago de Capital      description: Usuario que type: "string"Ingresa Préstamo
        formattype: "datestring"

      PreFecPIntPreFecModificacion:
        description: Fecha Próximode PagoModificación de InteresePréstamo
        type: "string"
        format: "date"

      PreFecUCapPreUsuMod:
        description: FechaUsuario Ultimoque PagoModificó dePréstamo
Capital         type: "string"

       format: "date"

      PreFecUIntPreFecPCap:
        description: Fecha UltimoPróximo Pago de InteresesCapital
        type: "string"
        format: "date"

      PreMarDesembolsarPreFecPInt:
        description: Margen por DesembolsarFecha Próximo Pago de Interese
        type: "numberstring"
        format: "doubledate"

      PreSusIntsPreFecUCap:
        description: TieneFecha Ultimo SuspensiónPago de InteresesCapital
        type: "string"
        format: "date"

      PreFecSuspensionPreFecUInt:
        description: Fecha deUltimo SuspensiónPago de InteresIntereses
        type: "string"
        format: "date"

      PreSalCapitalPreMarDesembolsar:
        description: SaldoMargen depor CapitalDesembolsar
        type: "number"
        format: "double"

      PreCapAtrasadoPreSusInts:
        description: Tiene Suspensión Capitalde AtrasadoIntereses
        type: "numberstring"

       formatPreFecSuspension:
"double"        PreIntMesdescription: Fecha de Suspensión      description: Intereses del Mesde Interes
        type: "numberstring"
        format: "doubledate"

      PreIntAcumuladoPreSalCapital:
        description: Saldo Interésde AcumuladoCapital
        type: "number"
        format: "double"

      PreIntVencidoPreCapAtrasado:
        description: InterésCapital VencidoAtrasado
        type: "number"
        format: "double"

      PreIntAnticipadoPreIntMes:
        description: InterésIntereses del AnticipadoMes
        type: "number"
        format: "double"

      PreIntMoraPreIntAcumulado:
        description: InteresesInterés MoratoriosAcumulado
        type: "number"
        format: "double"

      PreUltGarPreIntVencido:
        description: UltimoInterés Correlativo GarantíasVencido
        type: "integernumber"
        format: "int32double"

      PreUltPriPreIntAnticipado:
        description: UltimoInterés CorrelativoAnticipado
Prima Segur         type: "integernumber"
        format: "int32double"

      PreUltCamPreIntMora:
        description: Ultimo Correlativo Cambio CompIntereses Moratorios
        type: "integernumber"
        format: "int64double"

      PreUltAboPreUltGar:
        description: Ultimo AbonoCorrelativo ExtraordinarioGarantías
        type: "integer"
        format: "int64int32"

      PreNumContPreUltPri:
        description: NúmeroUltimo deCorrelativo ContratoPrima del PréstamSegur
        type: "stringinteger"
       PreReferencia format: "int32"

      descriptionPreUltCam:
No. Referencia del Ptmo     description: Ultimo Correlativo Cambio type:Comp
"string"        PreAnuladotype: "integer"
       description: Prestamo Fue Anulado
        type format: "stringint64"

      CrCicloPreUltAbo:
        description: CicloUltimo delAbono prestamoExtraordinario
grupal         type: "integer"
        format: "int64"

      CrDiasGraciaPreNumCont:
        description: DiasNúmero de graciaContrato del otorgadosPréstam
        type: "integerstring"

       format: "int32"

      CrDiasPGraciaPreReferencia:
        description: DiasNo. deReferencia graciadel pendientesPtmo
        type: "integerstring"

       formatPreAnulado:
"int32"        PreComentariodescription: Prestamo Fue Anulado
     description: Comentario Opcional         type: "string"

      PreEstadoCrCiclo:
        description: EstadoCiclo dedel prestamo Créditogrupal
        type: "booleaninteger"
        format: "int64"

      PreMensajeCrDiasGracia:
        description: CodigoDias de gracia mensajeotorgados
        type: "integer"
        format: "int64int32"

      PreTipoCreditoCrDiasPGracia:
        description: EsDias créditode normal, novado o refinanciadogracia pendientes
        type: "integer"
        format: "int32"

      PreNumeroRefinanciamientoPreComentario:
        description: NúmeroComentario deOpcional
préstamo de refinanciamiento         type: "string"

      PreMontoCapitalRefinanciamientoPreEstado:
        description: MontoEstado capitalde refinanciamientoCrédito
        type: "numberboolean"

       format: "double"

      PreMontoInteresRefinanciamientoPreMensaje:
        description: MontoCodigo interesde refinanciamientomensaje
        type: "numberinteger"
        format: "doubleint64"

      PreMontoOtrosRefinanciamientoPreTipoCredito:
        description: Monto otros refinanciamientoEs crédito normal, novado o refinanciado
        type: "numberinteger"
        format: "doubleint32"

      PreIntDevengadoPreNumeroRefinanciamiento:
        description: MontoNúmero interesde devengadopréstamo mesde anteriorrefinanciamiento
        type: "numberstring"

       format: "double"
		PreMontoCapitalRefinanciamiento:
        WSIngresarPrestamoOutputdescription: Monto capital refinanciamiento
 properties:       PrestamoNumerotype: "number"
        typeformat: "stringdouble"

     PrestamoInfo PreMontoInteresRefinanciamiento:
        description: WSCr Prestamo_SDTMonto interes refinanciamiento
        $reftype: "#/definitions/WSCrPrestamo_SDTnumber"
      Messages  format: "double"

      descriptionPreMontoOtrosRefinanciamiento:
Messages         typedescription: arrayMonto otros refinanciamiento
      items:  type: "number"
       $ref format: "#/definitions/Messages_Message"double"

      PreIntDevengado:
        Resultdescription: Monto interes devengado mes anterior
        type: "stringnumber"
   Messages_Message:     propertiesformat: "double"
		
  WSIngresarPrestamoOutput:
  Id:  properties:
      descriptionPrestamoNumero: Id
        type: "string"
       TypePrestamoInfo:
        description: WSCr TypePrestamo_SDT
        type$ref: "integer#/definitions/WSCrPrestamo_SDT"
        formatMessages:
"int32"        Descriptiondescription: Messages
        descriptiontype: Descriptionarray
        typeitems:
"string"     GxJsonError:     properties$ref: "#/definitions/Messages_Message"
      errorResult:
        $reftype: "#/definitions/GxJsonError.errorstring"

   GxJsonError.error:Messages_Message:
    properties:
      propertiesId:
       code description: Id
        type: "string"

      messageType:
        description: Type
        type: "stringinteger"
        x-gx-levelformat: "GxJsonError"

...

Modelo de Datos de este Web Service

...

Web Service a Constantes del Sistema Relacionados

...

WSIngresarPrestamoInput

...

Modo

...

Constantes asociadas a variables preestablecidas por la Aplicación SIFCO WEB.

...

ConsultaNumero

...

Número de préstamo a visualizar o actualizar. Al ingresar no llenar esta información.

...

WSIngresarPrestamoInput

>WSCrPrestamo_SDT

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"

Modelo de Datos de este Web Service

Web Service a Constantes del Sistema Relacionados

WSIngresarPrestamoInput

Modo

Constantes asociadas a variables preestablecidas por la Aplicación SIFCO WEB.

ConsultaNumero

Número de préstamo a visualizar o actualizar. Al ingresar no llenar esta información.

WSIngresarPrestamoInput

>WSCrPrestamo_SDT

PreEmpCodigo

Código de Empresa del Préstamo

PreSucCodigo

Código de Sucursal del Préstamo

PrePrdCod

Código del Producto en Préstamo

ApColCod

Código SubProducto Colocación

PreMonedaCod

Moneda en que se concedió el crédito

PreCliCod

Código Cliente

PreDirCor

Correlativo de Dirección Cliente

PreAprCod

Código Aprobación Préstamo

PreGarCod

Código Garantía Préstamo

ApOrgCod

Código de Origen de Fondos

PreGrDCod

Gran División Destino Préstamo

PrePaiCod

Pais Inversión Préstamo

PreRegCod

Región Inversión Préstamo

PreDepCod

Departamento Inversión Préstamo

PreMunCod

Municipio Inversión Préstamo

CupNumero

Código del Cupo

PreFacPlazo

Factor del Plazo

PreFreCCod

Frecuencia Pago Capital

PreFreCPlanilla

Frecuencia Pago Planilla

PreCtaNumero

Número Cuenta Captaciones

ApCaCCod

Código de Categoría de Crédito

ApEstCod

Código de Estado

PreUsuCod

Usuario que Ingresa Préstamo

PreUsuMod

Usuario que Modificó Préstamo

PreNumeroRefinanciamiento

Número de préstamo de refinanciamiento

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 Prestamos 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“

{ "Modo": "DSP", "ConsultaNumero":"01011102038142", "Prestamo":{

de Estado

Tipo de Mensaje HTTP

Ejemplo

REQUEST

URL:

Code Block
languagehtml
https://test.sifco.org/democoopgt/rest/WSIngresarPrestamo

HEADERS:

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

BODY:

Code Block
languagejson

PreUsuCod

Usuario que Ingresa Préstamo

PreUsuMod

Usuario que Modificó Préstamo

PreNumeroRefinanciamiento

Número de préstamo de refinanciamiento

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 Prestamos 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/WSIngresarPrestamo

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",
  "ConsultaNumero":"01011102038142",
  "Prestamo":{}
}

200 (Successful operation)

Operación Exitosa

Code Block
languagejson
{
    "PrestamoNumero": "01011102038142",
    "PrestamoInfo": {},
    "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)

EJEMPLO #2

El siguiente ejemplo inserta un préstamo en la Aplicación SIFCO WEB, con el Parámetro Modo : “INS”

Tipo de Mensaje HTTP

Ejemplo

REQUEST

URL:

Code Block
languagehtml
https://test.sifco.org/democoopgt/rest/WSIngresarPrestamo

HEADERS:

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

BODY:

Code Block
languagejson
{
  "Modo": "INS",
  "ConsultaNumero":"",
  "Prestamo":{
				        "PreEmpCodigo": 1,
				        "PreSucCodigo": 1,
				        "PreSoCrNumero": "0",
				        "PrePrdCod": 11,
				        "ApColCod": 2,
				        "PreMonedaCod": 1,
				        "PreNombre": "RODRIGO JOSE MORALES CASTELLANOS",
				        "PreCliCod": "3448",
				        "PreDirCor": 1,
				        "PrePrmCod": "admin",
				        "PreAprCod": 2,
				        "PreGarCod": 2,
				        "ApOrgCod": 1,
				        "PreFecAprobacion": "2020-07-31",
				        "PreFecConcesion": "2020-07-31",
				        "PreFecEscritura": "2020-07-31",
				        "PreGrDCod": 13,
				        "PrePaiCod": 320,
				        "PreRegCod": 0,
				        "PreDepCod": 0,
				        "PreMunCod": 0,
				        "PreMonOriginal": "1000.00",
				        "PreMonTotal": "500.00",
				        "CupNumero": "0",
				        "PreTasaFoV": "F",
				        "PreTasaBase": "18.0000",
				        "PreBaseMora": "6.0000",
				        "PreSpreCorr": "0.0000",
				        "PreSpreMora": "0.0000",
				        "PreFacPlazo": 10,
				        "PrePlazo": 12,
				        "PreFecVencimiento": "2021-07-31",
				        "PreTipCom": 1,
				        "PreFreCCod": 10,
				        "PreFreICod": 10,
				        "PreFec1Cap": "2020-08-31",
				        "PreFec1Int": "2020-08-31",
				        "PreDiaPago": 0,
				        "PreFreCPlanilla": 10,
				        "PreNumCuotas": 0,
				        "PreValCuota": "0.00",
				        "PreCuotaDefinidaUsuario": "0.00",
				        "PreForDes": 1,
				        "PrePrimerDesembolso": "2020-07-31",
				        "PreForPago": 1,
				        "PreAsigBoleta": "N",
				        "PreCtaNumero": "",
				        "ApCaCCod": 1,
				        "ApEstCod": "1",
				        "PreFecModulo": "2020-07-31",
				        "PreFecAdicion": "2020-10-07",
				        "PreUsuCod": "admin",
				        "PreFecModificacion": "0000-00-00",
				        "PreUsuMod": "admin",
				        "PreFecPCap": "2020-08-31",
				        "PreFecPInt": "2020-08-31",
				        "PreFecUCap": "0000-00-00",
				        "PreFecUInt": "0000-00-00",
				        "PreMarDesembolsar": "3000.00",
				        "PreSusInts": "N",
				        "PreFecSuspension": "0000-00-00",
				        "PreSalCapital": "0.00",
				        "PreCapAtrasado": "0.00",
				        "PreIntMes": "0.00",
				        "PreIntAcumulado": "0.00",
				        "PreIntVencido": "0.00",
				        "PreIntAnticipado": "0.00",
				        "PreIntMora": "0.00",
				        "PreUltGar": 0,
				        "PreUltPri": 0,
				        "PreUltCam": "0",
				        "PreUltAbo": "0",
				        "PreNumCont": "",
				        "PreReferencia": "Prueba 3",
				        "PreAnulado": "",
				        "CrCiclo": 0,
				        "CrDiasGracia": 0,
				        "CrDiasPGracia": 0,
				        "PreComentario": "generado por  el web service 3",
				        "PreEstado": false,
				        "PreMensaje": 399,
				        "PreTipoCredito": 0,
				        "PreNumeroRefinanciamiento": "",
				        "PreMontoCapitalRefinanciamiento": "0.00",
				        "PreMontoInteresRefinanciamiento": "0.00",
				        "PreMontoOtrosRefinanciamiento": "0.00",
				        "PreIntDevengado": "0.00"  
  }
}

200 (Successful operation)

Operación Exitosa

Code Block
languagejson
{
    "PrestamoNumero": "01011102038153",
    "PrestamoInfo": {},
    "Messages": [],
    "Result": "Prestamo Creado Exitosamente"
}

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)

EJEMPLO #3

El siguiente ejemplo consulta los datos de un préstamo 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/WSIngresarPrestamo

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",
  "ConsultaNumero":"01011102038153",
  "Prestamo":{
				        "PreEmpCodigo": 1,
				        "PreSucCodigo": 1,
				        "PreSoCrNumero": "0",
				        "PrePrdCod": 11,
				        "ApColCod": 2,
				        "PreMonedaCod": 1,
				        "PreNombre": "RODRIGO JOSE MORALES CASTELLANOS",
				        "PreCliCod": "3448",
				        "PreDirCor": 1,
				        "PrePrmCod": "admin",
				        "PreAprCod": 2,
				        "PreGarCod": 2,
				        "ApOrgCod": 1,
				        "PreFecAprobacion": "2020-07-31",
				        "PreFecConcesion": "2020-07-31",
				        "PreFecEscritura": "2020-07-31",
				        "PreGrDCod": 13,
				        "PrePaiCod": 320,
				        "PreRegCod": 0,
				        "PreDepCod": 0,
				        "PreMunCod": 0,
				        "PreMonOriginal": "1000.00",
				        "PreMonTotal": "500.00",
				        "CupNumero": "0",
				        "PreTasaFoV": "F",
				        "PreTasaBase": "18.0000",
				        "PreBaseMora": "6.0000",
				        "PreSpreCorr": "0.0000",
				        "PreSpreMora": "0.0000",
				        "PreFacPlazo": 10,
				        "PrePlazo": 12,
				        "PreFecVencimiento": "2021-07-31",
				        "PreTipCom": 1,
				        "PreFreCCod": 10,
				        "PreFreICod": 10,
				        "PreFec1Cap": "2020-08-31",
				        "PreFec1Int": "2020-08-31",
				        "PreDiaPago": 0,
				        "PreFreCPlanilla": 10,
				        "PreNumCuotas": 0,
				        "PreValCuota": "0.00",
				        "PreCuotaDefinidaUsuario": "0.00",
				        "PreForDes": 1,
				        "PrePrimerDesembolso": "2020-07-31",
				        "PreForPago": 1,
				        "PreAsigBoleta": "N",
				        "PreCtaNumero": "",
				        "ApCaCCod": 1,
				        "ApEstCod": "1",
				        "PreFecModulo": "2020-07-31",
				        "PreFecAdicion": "2020-10-07",
				        "PreUsuCod": "admin",
				        "PreFecModificacion": "0000-00-00",
				        "PreUsuMod": "admin",
				        "PreFecPCap": "2020-08-31",
				        "PreFecPInt": "2020-08-31",
				        "PreFecUCap": "0000-00-00",
				        "PreFecUInt": "0000-00-00",
				        "PreMarDesembolsar": "3000.00",
				        "PreSusInts": "N",
				        "PreFecSuspension": "0000-00-00",
				        "PreSalCapital": "0.00",
				        "PreCapAtrasado": "0.00",
				        "PreIntMes": "0.00",
				        "PreIntAcumulado": "0.00",
				        "PreIntVencido": "0.00",
				        "PreIntAnticipado": "0.00",
				        "PreIntMora": "0.00",
				        "PreUltGar": 0,
				        "PreUltPri": 0,
				        "PreUltCam": "0",
				        "PreUltAbo": "0",
				        "PreNumCont": "",
				        "PreReferencia": "Prueba 3",
				        "PreAnulado": "",
				        "CrCiclo": 0,
				        "CrDiasGracia": 0,
				        "CrDiasPGracia": 0,
				        "PreComentario": "generado por  el web service 3",
				        "PreEstado": false,
				        "PreMensaje": 399,
				        "PreTipoCredito": 0,
				        "PreNumeroRefinanciamiento": "",
				        "PreMontoCapitalRefinanciamiento": "0.00",
				        "PreMontoInteresRefinanciamiento": "0.00",
				        "PreMontoOtrosRefinanciamiento": "0.00",
				        "PreIntDevengado": "0.00"  
  }
}

200 (Successful operation)

Operación Exitosa

Code Block
languagejson
{
    "CodigoClientePrestamoNumero": "001011102038153",
    "ConsultaResultadosPrestamoInfo":[] {},
    "Messages": [],
    "Result": "Actualización Exitosa"
}

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":[],
  "messageResult":"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)

}

404 (Not Found).

Respuesta Vacía (Web Service, no encontrado)

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

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.