Web Services para Consultar Planillas de Transacciones Masivas Pendientes.

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 Consultar Planillas de Transacciones Masivas de Descuentos, cargadas desde 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" url: "https://sifco.atlassian.net/wiki/x/hQPG" produces: - application/json paths: /TransaccionesMasivas_PlanillasPendientes: post: tags: - TransaccionesMasivas_PlanillasPendientes operationId: "TransaccionesMasivas_PlanillasPendientes" summary: "Web Service para para Consultar Planillas de Transacciones Masivas Pendientes (Para Obtener Descuentos generados desde un Sistema Externo, o Directamente desde el Sistema SIFCO)" parameters

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: "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"
    url: "https://sifco.atlassian.net/wiki/x/hQPG"
produces:
  - application/json
paths:
  /TransaccionesMasivas_PlanillasPendientes:
    post:
      tags:
        - in: headerTransaccionesMasivas_PlanillasPendientes
      operationId: "TransaccionesMasivas_PlanillasPendientes"
      namesummary: Content-Type
          type: "string"
          required: true "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."
      parameters:
     default: application/json
        - 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: SmartDeviceOAuth <Access ApplicationToken>
        - namein: "TransaccionesMasivas_PlanillasPendientesInput"header
          inname: "body"GENEXUS-AGENT
          requiredtype: false"string"
          schemarequired: true
           $ref: "#/definitions/TransaccionesMasivas_PlanillasPendientesInput"default: SmartDevice Application
        - responses:name: "TransaccionesMasivas_PlanillasPendientesInput"
        200:  in: "body"
          descriptionrequired: "Successfulfalse
operation"           schema:
            $ref: "#/definitions/TransaccionesMasivas_PlanillasPendientesOutput"
PlanillasPendientesInput"

      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 server errorrequest"
          schema:
            $ref: "#/definitions/GxJsonError"
   security:    - OAuth2500:
   []     ApiKeyAuth1: [] securityDefinitionsdescription: "Internal server OAuth2:error"
    type: oauth2     flowschema:
 password       tokenUrl: https://test.sifco.org/DemoCoopGT/oauth/access_token
    $ref: "#/definitions/GxJsonError"
security:
  - scopesOAuth2: []
     ExecuteApiKeyAuth1: Permite[]
elsecurityDefinitions:
método tipo GETOAuth2:
      Inserttype: Permiteoauth2
el método tipo POST flow: password
    UpdatetokenUrl: Permite el método tipo PUThttps://test.sifco.org/DemoCoopGT/oauth/access_token
    scopes:
      DeleteExecute: Permite el método tipo DELETEGET
      FullControlInsert: Permite el método tipo manejoPOST
de los Cuatro Métodos GET, POST, PUT,DELETE, sobre Update: Permite el Webmétodo Servicetipo PUT
 ApiKeyAuth1:     typeDelete: apiKeyPermite el método tipo DELETE
in: header     nameFullControl: granttypePermite el definitions:manejo de los Cuatro TransaccionesMasivas_PlanillasPendientesInput:
    properties:
 Métodos GET, POST, PUT,DELETE, sobre el Web Service
  ApiKeyAuth1:
 Desde:   type: apiKey
    typein: "string"header
    name: granttype

definitions:
format: 
  TransaccionesMasivas_PlanillasPendientesInput:
    properties:
      Desde:
        type: "string"
        format: "date"
      Hasta:
        type: "string"
        format: "date"
  
  TransaccionesMasivas_PlanillasPendientesOutput:
    properties:
      Planillas:
        description: Transacciones Masivas_Planilla Salida
        $ref: "#/definitions/TransaccionesMasivas_PlanillaSalida"
  
  TransaccionesMasivas_PlanillaSalida:
    properties:
      Planillas:
        type: array
        items:
          description: Planilla
          $ref: "#/definitions/TransaccionesMasivas_PlanillaSalida.Planillas"


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

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

      Fecha:
        description: Fecha de la planilla
        type: "string"
        format: "date"

      FrecuenciaCodigo:
        description: Código de la Frecuencia
        type: "integer"
        format: "int32"

      FrecuenciaNombre:
        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
        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".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
TransaccionesMasivas_PlanillaSalida >TransaccionesMasivas_PlanillaSalida.Planillas >TransaccionesMasivas_PlanillaSalida.Planillas.Detalles
ClienteCodigoSifco	TClClientes

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.

Campo Modulo: El valor numérico representa el modulo al que pertenece.

Name	Description	Value
Captacion	Captación	1
Colocacion	Colocación	2
Otros	Otros	3

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

language	html

https://test.sifco.org/democoopgt/rest/TransaccionesMasivas_PlanillasPendientes

HEADERS

Code Block

language	json

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

BODY:

Code Block

language	json

{
  "Desde":"2019-10-01",
  "Hasta":"2019-10-30"
}

200 (Successful operation)

Operación Exitosa

Code Block

language	json

{
  "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",
            "Modulo": 2,
            "TransaccionNumero": "010102101001796",
            "TransaccionReferencia": "APORTE ORDINARIO               APORTE ORDINARIO LABORAL",
            "Valor": 25.00
          },
          {
            "ID": "2cf89f64-94e7-4543-a671-222405878f47",
            "ClienteCodigoSifco": 2,
            "ClienteReferencia": "344222",
            "Modulo": 2,
            "TransaccionNumero": "010102101008036",
            "TransaccionReferencia": "APORTE ORDINARIO               APORTE ORDINARIO LABORAL",
            "Valor": 25.00
          },
          {
            "ID": "a36c830-cfa3-49a9-a849-202b916c6514",
            "ClienteCodigoSifco": 3,
            "ClienteReferencia": "352688",
            "Modulo": 2,
            "TransaccionNumero": "010102101009338",
            "TransaccionReferencia": "APORTE ORDINARIO               APORTE ORDINARIO LABORAL",
            "Valor": 25.00
          },
          {
            "ID": "2ab7de66-f3ae-47d1-a9f1-b6ab6e4322bd",
            "ClienteCodigoSifco": 4,
            "ClienteReferencia": "371213",
            "Modulo": 2,
            "TransaccionNumero": "010102101011344",
            "TransaccionReferencia": "APORTE ORDINARIO               APORTE ORDINARIO LABORAL",
            "Valor": 25.00
          },
        ]
      }
    ]
  }
}

1

400 (Bad Request).

Solicitud Errada

Code Block

language	json

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

language	json

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

language	json

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

language	json

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

spaceKey	DOC
placeholder	Búsqueda en esta Pagina
type	page

Enlaces Relevantes

Artículos Actualizados Recientemente

Recent updates

types	page
max	5
spaces	DOC
theme	concise
hideHeading	true

Change History

Versions Compared

Old Version 4

New Version Current

Key

Web Services para Consultar Planillas de Transacciones Masivas Pendientes.

DESCRIPCIÓN.

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

EJEMPLOS DE REQUEST Y RESPONSE, PARA LOS SERVICIOS RESTful BAJO PROTOCOLO HTTP.

METODO POST

Tipo de Mensaje HTTP

Ejemplo

Enlaces Relevantes

Artículos Relacionados

Artículos Actualizados Recientemente

Page Comparison

Versions Compared

Old Version 4

New Version Current

Key

Web Services para Consultar Planillas de Transacciones Masivas Pendientes.

DESCRIPCIÓN.

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

EJEMPLOS DE REQUEST Y RESPONSE, PARA LOS SERVICIOS RESTful BAJO PROTOCOLO HTTP.

METODO POST

Tipo de Mensaje HTTP

Ejemplo

Enlaces Relevantes

Artículos Relacionados

Artículos Actualizados Recientemente