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 Aplicar Planillas de Transacciones Masivas.

Swagger open api macro

DESCRIPCIÓN.

Este Web Service, permite Ajustar y confirmar los Montos (incrementarlos o reducirlos) en las Planillas de Transacciones Masivas de Descuentos, para luego sean actualizados y aplicados en la Aplicación SIFCO WEB.

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: "TransaccionesMasivas_PlanillasAplicar"
  externalDocs:
    description: "Manual SIFCO"
    url: "https://sifco.atlassian.net/wiki/x/SoDQ"
produces:
  - application/json
paths:
  /TransaccionesMasivas_PlanillasAplicar:
    post:
      tags:
        - TransaccionesMasivas_PlanillasAplicar
      operationId: "TransaccionesMasivas_PlanillasAplicar"
      summary: "Web Service para Aplicar Planillas de Transacciones Masivas de Descuentos cargados y confirmados en la Aplicación SIFCO"
      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: "TransaccionesMasivas_PlanillasAplicarInput"
          in: "body"
          required: false
          schema:
            $ref: "#/definitions/TransaccionesMasivas_PlanillasAplicarInput"

      responses:
        200:
          description: "Successful operation"
          schema:
            $ref: "#/definitions/TransaccionesMasivas_PlanillasAplicarOutput"

        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:
            $ref: "#/definitions/GxJsonError"
security:
  - OAuth2: []
    ApiKeyAuth1: []
securityDefinitions:
  OAuth2:
    type: oauth2
    flow: password
    tokenUrl: https://test.sifco.org/DemoCoopGT/oauth/access_token
    scopes:
      Execute: Permite el método tipo GET
      Insert: Permite el método tipo POST
      Update: Permite el método tipo PUT
      Delete: Permite el método tipo DELETE
      FullControl: Permite el manejo de los Cuatro Métodos GET, POST, PUT,DELETE, sobre el Web Service
  ApiKeyAuth1:
    type: apiKey
    in: header
    name: granttype

definitions:

  TransaccionesMasivas_PlanillasAplicarInput:
    properties:
      Planillas:
        description: Transacciones Masivas_Planilla Entrada
        $ref: "#/definitions/TransaccionesMasivas_PlanillaEntrada"
  
  TransaccionesMasivas_PlanillaEntrada:
    properties:
      Planillas:
        type: array
        items:
          description: Planilla
          $ref: "#/definitions/TransaccionesMasivas_PlanillaEntrada.Planillas"


  TransaccionesMasivas_PlanillaEntrada.Planillas:
    properties:
      ID:
        description: ID de la Planilla
        type: "string"

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

    x-gx-level: "TransaccionesMasivas_PlanillaEntrada"

  TransaccionesMasivas_PlanillaEntrada.Planillas.Detalles:
    properties:
      ID:
        description: ID del Cargo
        type: "string"
        format: uuid

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


    x-gx-level: "TransaccionesMasivas_PlanillaEntrada.Planillas"

  TransaccionesMasivas_PlanillasAplicarOutput:
    properties:
      error:
        type: "integer"
        format: "int32"
      mensajes:
        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 para este Web Service en especifico permite un vez ajustar y confirmar los Montos (incrementarlos o reducirlos) en las Planillas de Transacciones Masivas de Descuentos, para que luego sean actualizados y aplicados en la Aplicación SIFCO WEB.

El siguiente ejemplo permite Ajustar los Montos (incrementarlos o reducirlos) en las Planillas de Transacciones Masivas de Descuentos, para que luego sean actualizados y aplicados en la Aplicación SIFCO WEB.

Tipo de Mensaje HTTP

Ejemplo

REQUEST

URL:

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

HEADERS

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

BODY:

Code Block
languagejson
{
  "Planillas": {
    "Planillas": [
      {
        "ID": "SIFCO-1090",
        "Descripcion": "Prueba 01-10-2019",
        "Fecha": "2019-10-01",
        "FrecuenciaCodigo": 1,
        "FrecuenciaNombre": "N-D013",
        "Detalles": [[
            {
                "ID": "7ee44e82-a386-46b2-ae4e-e4e5662bf6fa",
                "ClienteCodigoSifco": "1",
                "ClienteReferencia": "0232028        ",
                "TransaccionNumero": "010102101001796",
                "TransaccionReferencia": "APORTE ORDINARIO               APORTE ORDINARIO LABORAL",
                "Valor": "25.00"
            },
            {
                "ID": "2cf89f64-94e7-4543-a671-222405878f47",
                "ClienteCodigoSifco": "2",
                "ClienteReferencia": "344222         ",
                "TransaccionNumero": "010102101008036",
                "TransaccionReferencia": "APORTE ORDINARIO               APORTE ORDINARIO LABORAL",
                "Valor": "25.00"
            },
            {
                "ID": "fa36c830-cfa3-49a9-a849-202b916c6514",
                "ClienteCodigoSifco": "3",
                "ClienteReferencia": "352688         ",
                "TransaccionNumero": "010102101009338",
                "TransaccionReferencia": "APORTE ORDINARIO               APORTE ORDINARIO LABORAL",
                "Valor": "25.00"
            },
            {
                "ID": "2ab7de66-f3ae-47d1-a9f1-b6ab6e4322bd",
                "ClienteCodigoSifco": "4",
                "ClienteReferencia": "371213         ",
                "TransaccionNumero": "010102101011344",
                "TransaccionReferencia": "APORTE ORDINARIO               APORTE ORDINARIO LABORAL",
                "Valor": "25.00"
            }
        ]
      }
    ]
  }
}

200 (Successful operation)

Operación Exitosa

Code Block
languagejson
{
  "error": 0,
  "mensajes": ""
}

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"
  }
}
{
  "Planillas": {
    "Planillas": [
      "Detalles":[]
      ]
    }
}

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 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.

Enlaces Relevantes

Live Search
spaceKeyDOC
placeholderBúsqueda en esta Pagina
typepage

Artículos Relacionados

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

Artículos Actualizados Recientemente

Recent updates
typespage
max5
spacesDOC
themeconcise
hideHeadingtrue
Change History