Versions Compared

Old Version 1

changes.mady.by.user Alfredo Lopez

Saved on

compared with

New Version Current

changes.mady.by.user Alfredo Lopez

Saved on

Key

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

Web Services para Registrar un Movimiento en Caja.

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**, permite registrar un movimiento en CAJA 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: "WSTransaccionesCaja" externalDocs: description: "Manual SIFCO

DESCRIPCIÓN.

Este Web Service, permite registrar una Transacción de Caja en la Aplicación SIFCO WEB, Es importante destacar que esta transacción sera registrada con los campos obtenidos al consumir el Web Service WSInformacionTransaccion dado a que dicho Web Service maneja un conjunto de validaciones que verificara si los datos suministrados son correctos.

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: "httpshttp://sifcowww.atlassianapache.netorg/wiki/x/ngCplicenses/LICENSE-2.0.html"
produceshost: "<SERVER>"
schemes:
- application/json paths:-  https
/WSTransaccionesCaja:  - http
 postbasePath:       /<APPDIR>/rest
tags:
- name: "WSTransaccionesCaja"
  externalDocs:
  - WSTransaccionesCaja
      operationId description: "WSTransaccionesCajaManual SIFCO"
      summaryurl: "Registrar Movimiento en CAJA, con validaciones!"
      parameters:
 https://sifco.atlassian.net/wiki/x/D4Cq"
produces:
  - application/json
paths:
  /WSTransaccionesCaja:
    post:
      -tags:
in: header       - WSTransaccionesCaja
  name: Content-Type   operationId: "WSTransaccionesCaja"
      typesummary: "string"Registrar Movimiento en CAJA, con validaciones!"
      requiredparameters:
true        -   default: application/json
        - in: in: header
          name: AuthorizationContent-Type
          type: "string"
          required: true
          default: OAuthapplication/json
<Access Token>         - in: header
          name: GENEXUS-AGENTAuthorization
          type: "string"
          required: true
          default: OAuth <Access Token>
SmartDevice Application       - responsesin: header
       200   name: GENEXUS-AGENT
         description type: "Successful operationstring"
          schemarequired: true
          default: $ref: "#/definitions/SmartDevice Application
        - name: "WSTransaccionesCajaInput"
         401 in: "body"
         description required: "Notfalse
Authenticated"           schema:
            $ref: "#/definitions/GxJsonError"
WSTransaccionesCajaInput"

      responses:
       404 200:
          description: "NotSuccessful foundoperation"
          schema:
            $ref: "#/definitions/GxJsonErrorWSTransaccionesCajaOutput"

        400401:
          description: "BadNot requestAuthenticated"
          schema:
            $ref: "#/definitions/GxJsonError"
        500404:
          description: "InternalNot server errorfound"
          schema:
            $ref: "#/definitions/GxJsonError"
security:    - OAuth2: []  400:
  ApiKeyAuth1: [] securityDefinitions:   OAuth2:   description: "Bad type:request"
oauth2     flow: password     tokenUrlschema:
https://test.sifco.org/DemoCoopGT/oauth/access_token     scopes:       Execute$ref: Permite el metodo tipo GET"#/definitions/GxJsonError"
          Insert500: Permite
el metodo tipo POST       Updatedescription: Permite el metodo tipo PUT"Internal server error"
          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/GxJsonError"
security:
  - OAuth2: []
    ApiKeyAuth1: []
securityDefinitions:
  OAuth2:
    type: apiKeyoauth2
    inflow: headerpassword
    nametokenUrl: granttype

definitions:https://test.sifco.org/DemoCoopGT/oauth/access_token
   WSTransaccionesCajaInput:
    properties scopes:
      TransaccionExecute: Permite el método tipo GET
   description: Informacion Transaccion_Caja_SDT  Insert: Permite el método tipo POST
 $ref: "#/definitions/InformacionTransaccion_Caja_SDT"    InformacionTransaccion_Caja_SDTUpdate: Permite el método tipo properties:PUT
      ApEmpCodigoDelete: Permite el método tipo DELETE
   description: Código Empresa FullControl: Permite el manejo de los Cuatro  type: "integer"
   Métodos GET, POST, PUT,DELETE, sobre el Web Service
  ApiKeyAuth1:
 format: "int32"  type: apiKey
    ApEmpNombrein: header
    name: granttype

descriptiondefinitions:
Nombre
Empresa  WSTransaccionesCajaInput:
      type: "string"properties:
       ApTrxCodTransaccion:
        description: Código de TransacciónInformacion Transaccion_Caja_SDT
         type$ref: "integer#/definitions/InformacionTransaccion_Caja_SDT"


  InformacionTransaccion_Caja_SDT:
    properties:
   format   ApEmpCodigo:
"int32"        ApTrxDesdescription: Código Empresa
        descriptiontype: Descripcion"integer"
        typeformat: "stringint32"

      ApModCodApEmpNombre:
        description: CodigoNombre ModuloEmpresa
        type: "string"

      ApModNomApTrxCod:
        description: Código Nombrede ModuloTransacción
        type: "stringinteger"
       ApTrxUso format: "int32"

      descriptionApTrxDes: Grupo
de Uso         typedescription: "integer"Descripción
        formattype: "int32string"

      ApTrxNaturalezaApModCod:
        description: NaturalezaCódigo Modulo
        type: "integerstring"

       format: "int32"

      ApTrxSiglaApModNom:
        description: SiglasNombre paraModulo
Estado de Cuenta         type: "string"

      ApTrxEstadisticasApTrxUso:
        description: AcumulaGrupo ende EstadísticasUso
        type: "stringinteger"
        ApTrxTipCerformat: "int32"

      descriptionApTrxNaturaleza:
Tipo de      Certificación endescription: CajaNaturaleza
        type: "integer"
        format: "int32"

      ApTrxTC1RutApTrxSigla:
        description: RutinaSiglas Certificaciónpara EstandarEstado de Cuenta
      type: "integer"
        format type: "int32string"

      ApTrxTC1DesApTrxEstadisticas:
        description: Acumula Descripcionen RutinaEstadísticas
        type: "string"

      ApTrxTC2RutApTrxTipCer:
        description: Rutina Impresión DocumentoTipo de Certificación en Caja
        type: "integer"
        format: "int32"

      ApTrxTC2DesApTrxTC1Rut:
        description: DescripcionRutina deCertificación rutinaEstándar
        type: "stringinteger"
       ApTrxAutoSup format:  "int32"

     description ApTrxTC1Des: Requiere Autorización del Supervisor
        description: Descripción Rutina
        type: "string"

      ApTrxUltParApTrxTC2Rut:
        description: UltimoRutina CorrelativoImpresión de PartidasDocumento
        type: "integer"
        format: "int64int32"

      ApTrxContaApTrxTC2Des:
        description: SeDescripción contabilizade la transaccionrutina
        type: "string"

      ApTrxActivaApTrxAutoSup:
        description: Transacción Activa/DesactivaRequiere Autorización del Supervisor
        type: "string"

      ApTrxEsAjusteApTrxUltPar:
        description: TransaccionUltimo Correlativo Tipode AjustePartidas
        type: "stringinteger"
       ApTrxRptCertifica format: "int64"

      descriptionApTrxConta:
Rpt Imprime Certificacion        description: Se contabiliza la transacción
        type: "string"

      ApTrxEnlaceApTrxActiva:
        description: Enlace con otros ModulosTransacción Activa/Desactiva
         type: "integerstring"

      ApTrxEsAjuste:
format: "int32"       description: Transaccion: Tipo Ajuste
        $reftype: "#/definitions/InformacionTransaccion_Caja_SDT.Transaccionstring"

      CamposApTrxRptCertifica:
        typedescription: arrayRpt Imprime Certificación
      items:  type: "string"

      descriptionApTrxEnlace: Campo
          $refdescription: "#/definitions/InformacionTransaccion_Caja_SDT.Campos"

  Enlace con otros Módulos
   Rutinas:         type: array"integer"
        itemsformat: "int32"

        descriptionTransaccion:
Rutina           $ref: "#/definitions/InformacionTransaccion_Caja_SDT.RutinasTransaccion"

   InformacionTransaccion_Caja_SDT.Transaccion:   Campos:
 properties:       FechaValortype: array
       description items:
Fecha Valor         typedescription: "string"Campo
          format$ref: "date#/definitions/InformacionTransaccion_Caja_SDT.Campos"

      TotalRutinas:
        descriptiontype: Totalarray
        typeitems:
"number"          formatdescription: "double"Rutina
       Cuenta:   $ref: "#/definitions/InformacionTransaccion_Caja_SDT.Rutinas"


  description: Campos para Número de CuentaInformacionTransaccion_Caja_SDT.Transaccion:
    properties:
      FechaValor:
  type: "string"        LibNumero:
        description: NúmeroFecha deValor
Libreta         type: "integerstring"
        format: "int64date"

      ApEmpCodigoTotal:
        description: CódigoTotal
Empresa
        type: "integernumber"
        format: "int32double"

      ApSucCodigoCuenta:
        description: Campos Códigopara Número de SucursalCuenta
        type: "integerstring"

       formatLibNumero:
"int32"        ApUsuCoddescription: Número de Libreta
     description: Codigo del Usuariotype: "integer"
       type: format: "stringint64"

      ApMonCodApEmpCodigo:
        description: CodigoCódigo MonedaEmpresa
        type: "integer"
        format: "int32"

      NumeroDocumentoApSucCodigo:
        description: NumeroCódigo de DocumentoSucursal
        type: "integer"
        format: "int64int32"

      ApCajRecCodigoApUsuCod:
        description: CodigoCódigo Cajadel ReceptoraUsuario
        type: "integerstring"

       format: "int32"

      ClCliCodApMonCod:
        description: CódigoCódigo delMoneda
Cliente
        type: "integer"
        format: "int64int32"

      CuotasNumeroDocumento:
        description: CuotasNumero Documento
        type: "integer"
        format: "int32int64"

      CrUltimaTrxApCajRecCodigo:
        description: NúmeroCódigo delCaja Movimiento CréditosReceptora
        type: "integer"
        format: "int64int32"

      ClCliCod:
        description: Código del Cliente
        type: "integer"
      x-gx-level  format: "InformacionTransaccion_Caja_SDT"


  InformacionTransaccion_Caja_SDT.Campos:
    properties:
      ApCamCod:
        description: Código del Campo
        type: "integer"
        format: "int32"

      ApCtxOrden:
        description: Orden de Campos en Transacción
        type: "integer"
        format: "int32"

      ApCamClase:
        description: Tipo de Campo
        type: "integer"
        format: "int32"

      ApCamEti:
        description: Etiqueta Campo
        type: "string"

      ApCamTipo:
        description: Tipo de Campo
        type: "string"

      ApPResCod:
        description: Código del Periodo
        type: "integer"
        format: "int32"

      ApPResDes:
        description: Descripción
        type: "string"

      ApCamModifica:
        description: ApCamModifica
        type: "string"

      ValorTXT:
        description: Valor TXT
        type: "string"

      ValorNumerico:
        description: Valor Numerico
        type: "number"
        format: "double"

      ValorCuenta:
        description: Campos para Número de Cuenta
        type: "string"

      ValorFecha:
        description: Valor fecha
        type: "string"
        format: "date"

      ValorDocumento:
        description: Campos para Nos. de Documentos
        type: "integer"
        format: "int64"


    x-gx-level: "InformacionTransaccion_Caja_SDT"


  InformacionTransaccion_Caja_SDT.Rutinas:
    properties:
      ApRutxTrx:
        description: Codigo Rutina
        type: "integer"
        format: "int32"

      ApRutxDes:
        description: Descripcion rutina
        type: "string"

      ApRutSec:
        description: Secuencia Rutina
        type: "integer"
        format: "int32"

      ApRutxTip:
        description: Tipo de Rutina
        type: "string"


    x-gx-level: "InformacionTransaccion_Caja_SDT"


  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"int64"

      Cuotas:
        description: Cuotas
        type: "integer"
        format: "int32"

      CrUltimaTrx:
        description: Número del Movimiento Créditos
        type: "integer"
        format: "int64"


    x-gx-level: "InformacionTransaccion_Caja_SDT"


  InformacionTransaccion_Caja_SDT.Campos:
    properties:
      ApCamCod:
        description: Código del Campo
        type: "integer"
        format: "int32"

      ApCtxOrden:
        description: Orden de Campos en Transacción
        type: "integer"
        format: "int32"

      ApCamClase:
        description: Tipo de Campo
        type: "integer"
        format: "int32"

      ApCamEti:
        description: Etiqueta Campo
        type: "string"

      ApCamTipo:
        description: Tipo de Campo
        type: "string"

      ApPResCod:
        description: Código del Periodo
        type: "integer"
        format: "int32"

      ApPResDes:
        description: Descripción
        type: "string"

      ApCamModifica:
        description: ApCamModifica
        type: "string"

      ValorTXT:
        description: Valor TXT
        type: "string"

      ValorNumerico:
        description: Valor Numerico
        type: "number"
        format: "double"

      ValorCuenta:
        description: Campos para Número de Cuenta
        type: "string"

      ValorFecha:
        description: Valor fecha
        type: "string"
        format: "date"

      ValorDocumento:
        description: Campos para Nos. de Documentos
        type: "integer"
        format: "int64"


    x-gx-level: "InformacionTransaccion_Caja_SDT"


  InformacionTransaccion_Caja_SDT.Rutinas:
    properties:
      ApRutxTrx:
        description: Código Rutina
        type: "integer"
        format: "int32"

      ApRutxDes:
        description: Descripción rutina
        type: "string"

      ApRutSec:
        description: Secuencia Rutina
        type: "integer"
        format: "int32"

      ApRutxTip:
        description: Tipo de Rutina
        type: "string"


    x-gx-level: "InformacionTransaccion_Caja_SDT"


  WSTransaccionesCajaOutput:
    properties:
      Mensaje:
        type: "string"
      Resultado:
        type: "boolean"

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

  GxJsonError.error:
    properties:
      code:
        description: Código de Error
        type: "string"

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


    x-gx-level: "GxJsonError"

RELACIONES ENTRE EL MODELO DE DATOS DE ESTE WEB SERVICE, Y EL RESTO DEL API’s RESTful DE LA APLICACIÓN SIFCO WEB.

Modelo de Datos de este Web Service

Web Service a Constantes del Sistema Relacionados

InformacionTransaccion_Caja_SDT

>Transaccion

ApUsuCod

WSApUsuariosSistemaLista

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 registrar una Transacción de Caja en la Aplicación SIFCO WEB.

El siguiente ejemplo permite registrar una Transacción de Caja en la Aplicación SIFCO WEB.

Tipo de Mensaje HTTP

Ejemplo

REQUEST

URL:

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

HEADERS

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

BODY:

Code Block
languagejson
{
  "Transaccion": {
    "ApEmpCodigo": 1,
    "ApEmpNombre": "COOP DE AHORRO Y CREDITO EL EJEMPLO",
    "ApTrxCod": 3004,
    "ApTrxDes": "RECEPCION DE EFECTIVO DE BOVEDA",
    "ApModCod": "CJ",
    "ApModNom": "CAJA",
    "ApTrxUso": 1,
    "ApTrxNaturaleza": 2,
    "ApTrxSigla": "RECEPEFECT",
    "ApTrxEstadisticas": "S",
    "ApTrxTipCer": 1,
    "ApTrxTC1Rut": 52,
    "ApTrxTC1Des": "ACTUALIZA COMO HECHA CANCELACI",
    "ApTrxTC2Rut": 52,
    "ApTrxTC2Des": "ACTUALIZA COMO HECHA CANCELACI",
    "ApTrxAutoSup": "1",
    "ApTrxUltPar": 0,
    "ApTrxConta": "S",
    "ApTrxActiva": "A",
    "ApTrxEsAjuste": "N",
    "ApTrxRptCertifica": "",
    "ApTrxEnlace": 0,
    "Transaccion": {
      "FechaValor": "2019-10-02",
      "Total": 0,
      "Cuenta": "9009009",
      "LibNumero": 0,
      "ApEmpCodigo": 1,
      "ApSucCodigo": 1,
      "ApUsuCod": "admin",
      "ApMonCod": 1,
      "NumeroDocumento": 0,
      "ApCajRecCodigo": 1,
      "ClCliCod": 50,
      "Cuotas": 28,
      "CrUltimaTrx": 0
    },
    "Campos": [
      {
        "ApCamCod": 9,
        "ApCtxOrden": 2,
        "ApCamClase": 3,
        "ApCamEti": "VALOR EFECTIVO",
        "ApCamTipo": "D",
        "ApPResCod": 0,
        "ApPResDes": "",
        "ApCamModifica": "",
        "ValorTXT": "",
        "ValorNumerico": "0.00",
        "ValorCuenta": "",
        "ValorFecha": "0000-00-00",
        "ValorDocumento": "0"
      }
    ],
    "Rutinas": [
      {
        "ApRutxTrx": 13,
        "ApRutxDes": "ACTUALIZAR TOTALES DE CAJERO",
        "ApRutSec": 1,
        "ApRutxTip": "A"
      }
    ]
  }
}

200 (Successful operation)

Operación Exitosa

Code Block
languagejson
{
  "Mensaje": "TRANSACCION 470 EXITOSA.",
  "Resultado": true
}

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"
  }
}
{
  "Mensaje":"",
  "Resultado":false
}

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

NO olvide tomar en cuenta para el uso de este Web Service, el Flujo de Trabajo descrito en Web Services de Caja, 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.

Live Search
spaceKeyDOC
placeholderBúsqueda en esta Pagina
typepage

Enlaces Relevantes

Artículos Relacionados

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

Artículos Actualizados Recientemente

Recent updates
typespage
max5
spacesDOC
themeconcise
hideHeadingtrue
Change History