Versions Compared

Key

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

Web Services para Obtener los Descuentos de las Planillas de Transacciones Masivas Pendientes generados por un Sistema Externo o directamente desde la Aplicación SIFCO.

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 Obtener los Descuentos de las Planillas de Transacciones Masivas Pendientes generados por un Sistema Externo o directamente desde 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: "TransaccionesMasivas_PlanillasPendientes" externalDocs: description: "Manual SIFCO"

DESCRIPCIÓN.

Este Web Service, permite Obtener los Descuentos de las Planillas de Transacciones Pendientes generados por un Sistema Externo o directamente desde la Aplicación SIFCO WEB, en el rango de fechas indicados.

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/hQPG"
produceslicenses/LICENSE-2.0.html"
host: "<SERVER>"
schemes:
  - application/jsonhttps
paths:  - /TransaccionesMasivas_PlanillasPendientes:
    post:
      http
basePath: /<APPDIR>/rest
tags:
-        - name: "TransaccionesMasivas_PlanillasPendientes"
  externalDocs:
    operationIddescription: "TransaccionesMasivas_PlanillasPendientesManual SIFCO"
      summaryurl: "Web Service para Obtener y Modificar (Incrementar o Reducir) los Descuentos de Planillas de Transacciones Masivas cargadas desde un Sistema Externo, o Directamente desde el Sistema SIFCO"
      parameters:https://sifco.atlassian.net/wiki/x/hQPG"
produces:
  - application/json
paths:
  /TransaccionesMasivas_PlanillasPendientes:
    post:
      tags:
        - TransaccionesMasivas_PlanillasPendientes
      operationId: "TransaccionesMasivas_PlanillasPendientes"
  - in: header  summary: "Web Service para Obtener y Modificar (Incrementar o name: Content-Type
          type: "string"
      Reducir) los Descuentos de Planillas de Transacciones Masivas cargadas desde un Sistema Externo, o Directamente desde el Sistema SIFCO"
   required: true           default: application/jsonparameters:
        - in: header
          name: AuthorizationContent-Type
          type: "string"
          required: true
          default: OAuth <Access Token>application/json
        - in: header
          name: GENEXUS-AGENTAuthorization
          type: "string"
          required: true
          default: OAuth SmartDevice<Access ApplicationToken>
        - name: "TransaccionesMasivas_PlanillasPendientesInput"in: header
          name: GENEXUS-AGENT
          intype: "bodystring"
          required: falsetrue
          schemadefault: SmartDevice Application
        -  $refname: "#/definitions/TransaccionesMasivas_PlanillasPendientesInput"
          responses:in: "body"
          200required: false
         description: "Successful operation"
          schema:
            $ref: "#/definitions/TransaccionesMasivas_PlanillasPendientesOutputPlanillasPendientesInput"

      responses:
        401200:
          description: "NotSuccessful Authenticatedoperation"
          schema:
            $ref: "#/definitions/GxJsonErrorTransaccionesMasivas_PlanillasPendientesOutput"

       404 401:
          description: "Not foundAuthenticated"
          schema:
            $ref: "#/definitions/GxJsonError"
        400404:
          description: "BadNot requestfound"
          schema:
            $ref: "#/definitions/GxJsonError"
        500400:
          description: "InternalBad serverrequest"
error"
          schema:
            $ref: "#/definitions/GxJsonError"
security:   - OAuth2: []    500:
ApiKeyAuth1: [] securityDefinitions:   OAuth2:     typedescription: oauth2
"Internal server error"
   flow: password     tokenUrl: https://test.sifco.org/DemoCoopGT/oauth/access_tokenschema:
    scopes:       Execute: Permite el método tipo GET
  $ref: "#/definitions/GxJsonError"
security:
  - OAuth2: []
    InsertApiKeyAuth1: Permite[]
elsecurityDefinitions:
método tipo POSTOAuth2:
      Updatetype: Permiteoauth2
el método tipo PUT flow: password
    Delete: Permite el método tipo DELETEtokenUrl: https://test.sifco.org/DemoCoopGT/oauth/access_token
    scopes:
      FullControlExecute: Permite el método manejotipo GET
de los Cuatro Métodos GET, POST, PUT,DELETE, sobre Insert: Permite el Webmétodo Servicetipo POST
 ApiKeyAuth1:     typeUpdate: apiKeyPermite el método tipo PUT
in: header     nameDelete: granttypePermite el definitions:método tipo DELETE
 TransaccionesMasivas_PlanillasPendientesInput:     propertiesFullControl: Permite el manejo de los Cuatro Métodos Desde:GET, POST, PUT,DELETE, sobre el Web Service
  typeApiKeyAuth1:
"string"    type: apiKey
    formatin: "date"header
    name: granttype

Hastadefinitions:

  TransaccionesMasivas_PlanillasPendientesInput:
    type: "string"properties:
      Desde:
        formattype: "datestring"
     TransaccionesMasivas_PlanillasPendientesOutput:     properties:format: "date"
      PlanillasHasta:
        descriptiontype: Transacciones Masivas_Planilla Salida"string"
          $refformat: "#/definitions/TransaccionesMasivas_PlanillaSalidadate"
  
  TransaccionesMasivas_PlanillaSalidaPlanillasPendientesOutput:
    properties:
      Planillas:
        typedescription: array
        items:
          description: Planilla
 Transacciones Masivas_Planilla Salida
        $ref: "#/definitions/TransaccionesMasivas_PlanillaSalida.Planillas"
  
  TransaccionesMasivas_PlanillaSalida.Planillas:
    properties:
      IDPlanillas:
        descriptiontype: IDarray
de   la Planilla    items:
    type: "string"     description: Planilla
 Descripcion:         description: Descripción$ref: "#/definitions/TransaccionesMasivas_PlanillaSalida.Planillas"


  TransaccionesMasivas_PlanillaSalida.Planillas:
    typeproperties: "string"
       FechaID:
        description: FechaID de la planillaPlanilla
        type: "string"

      Descripcion:
format: "date        description: Descripción
        type: "string"

      FrecuenciaCodigoFecha:
        description: CódigoFecha de la Frecuenciaplanilla
        type: "integerstring"
        format: "int32date"

      FrecuenciaNombreFrecuenciaCodigo:
        description: DescripciónCódigo de la Frecuencia
        type: "stringinteger"
        Detallesformat: "int32"

      typeFrecuenciaNombre:
array         items:
 description: Descripción de Frecuencia
        type: "string"

      Detalles:
        type: array
        items:
          description: Detalle
          $ref: "#/definitions/TransaccionesMasivas_PlanillaSalida.Planillas.Detalles"

    x-gx-level: "TransaccionesMasivas_PlanillaSalida"

  TransaccionesMasivas_PlanillaSalida.Planillas.Detalles:
    properties:
      ID:
        description: ID del Cargo
        type: "string"

      ClienteCodigoSifco:
        description: Código del Cliente
        type: "integer"
        format: "int64"

      ClienteReferencia:
        description: Referencia del Cliente
        type: "string"

      TransaccionNumero:
        description: Transacción Numero
#/definitions/TransaccionesMasivas_PlanillaSalida.Planillas.Detalles"

    x-gx-level: "TransaccionesMasivas_PlanillaSalida"

  TransaccionesMasivas_PlanillaSalida.Planillas.Detalles:
    properties:
      ID:
        description: ID del Cargo
        type: "string"

      ClienteCodigoSifco:
        description: Código del Cliente
        type: "integer"
        format: "int64"

      ClienteReferencia:
        description: Referencia del Cliente
        type: "string"

      TransaccionNumero:
        description: Transacción Numero
        type: "string"

      TransaccionReferencia:
        description: Transacción Referencia
        type: "string"

      Valor:
        description: Valor a Descontar o Descontado
        type: "number"
        format: "double"


    x-gx-level: "TransaccionesMasivas_PlanillaSalida.Planillas"

  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

TransaccionesMasivas_PlanillaSalida

>TransaccionesMasivas_PlanillaSalida.Planillas

Frecuencia

WSApFrecuenciasLista

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 Obtener los Descuentos de las Planillas de Transacciones Pendientes generados por un Sistema Externo o directamente desde la Aplicación SIFCO WEB.

El siguiente ejemplo permite Obtener los Descuentos de las Planillas de Transacciones Pendientes en la Aplicación SIFCO WEB, en un rango de fechas especifico.

Tipo de Mensaje HTTP

Ejemplo

REQUEST

URL:

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

HEADERS

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

BODY:

Code Block
languagejson
{
  "Desde": "2019-09-02",
  "Hasta": "2019-10-02"
}

200 (Successful operation)

Operación Exitosa

Code Block
{
  "Salida": {
    "Descripcion": "string",
    "Error": 0,
    "Frecuencia": 1,
    "Lista": [
      {
       
type:
 "
string
FormaIdentificar": 1,
        
TransaccionReferencia
"Identificacion": "admin",
       
description
 "TipoProducto": 
Transacción Referencia
1,
       
type:
 "
string
Monto": 1000
      
Valor:
}
    ]
  
description: Valor a Descontar o Descontado
}
}

400 (Bad Request).

Solicitud Errada

Code Block
languagejson
{
  "error": {
    
type
"code": "
number
string",
    "message": "string"
  
format: "double" x-gx-level: "TransaccionesMasivas_PlanillaSalida.Planillas" 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"
}
}

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

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
{
  "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 Planillas de Transacciones Masivas, 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.

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" , "api" , "rest" , "web" , "services" , "transacciones" , "masivas" , "pendientes" , "planillas" ) and type = "page" and space = "DOC"

Artículos Actualizados Recientemente

Recent updates
typespage
max5
spacesDOC
themeconcise
hideHeadingtrue
Change History