Page Comparison

swagger: '2.0'
info:
  title: "SIFCO_REST_API"
  version: "1.0"
  descriptiontermsOfService: "La presente documentación busca detallar los métodos que permite ejecutar este **Web Services**, como es Ajustar los Montos (incrementados o reducidos) en las Planillas de Transacciones Masivas de Descuentos Obtenidos en el WS TransaccionesMasivas_PlanillasPendientes, y Actualizarlos en la **Aplicación SIFCO WEB** ."
  termsOfService: "https://sifco.org/sobre-nosotros/"
  contact:
    email: "soporte@sifco.org"
  license"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:
    namedescription: "ApacheManual 2.0SIFCO"
      url: "httphttps://wwwsifco.apacheatlassian.orgnet/wiki/licenses/LICENSE-2.0.htmlx/SoDQ"
hostproduces:
"<SERVER>" schemes: - application/json
-paths:
https  /TransaccionesMasivas_PlanillasAplicar:
  - http basePathpost: /<APPDIR>/rest
      tags:
        - nameTransaccionesMasivas_PlanillasAplicar
      operationId: "TransaccionesMasivas_PlanillasAplicar"
  externalDocs:     descriptionsummary: "ManualWeb SIFCO"Service para Aplicar Planillas de url: "https://sifco.atlassian.net/wiki/x/SoDQ"
produces:
  - application/json
paths:
  /TransaccionesMasivas_PlanillasAplicar:Transacciones Masivas de Descuentos cargados y confirmados en la Aplicación SIFCO"
      postparameters:
       tags: - in: header
          name: Content-Type
TransaccionesMasivas_PlanillasAplicar       operationId: "TransaccionesMasivas_PlanillasAplicar"       summarytype: "string"Web
Service para para Aplicar Planillas de Transacciones Masivas de Descuentos cargadosrequired: ytrue
confirmados en la Aplicación SIFCO"       parameters:default: application/json
        - in: header
          name: Content-TypeAuthorization
          type: "string"
          required: true
          default: application/json OAuth <Access Token>
        - in: header
          name: AuthorizationGENEXUS-AGENT
          type: "string"
          required: true
          default: OAuthSmartDevice <Access Token>Application
        - in: header
          name: GENEXUS-AGENT"TransaccionesMasivas_PlanillasAplicarInput"
          typein: "stringbody"
          required: truefalse
          defaultschema:
 SmartDevice Application         - name$ref: "#/definitions/TransaccionesMasivas_PlanillasAplicarInput"

         inresponses:
"body"           required200:
false          description: "Successful operation"
          schema:
            $ref: "#/definitions/TransaccionesMasivas_PlanillasAplicarInputPlanillasAplicarOutput"

 

   responses:         200401:
          description: "SuccessfulNot operationAuthenticated"
          schema:
            $ref: "#/definitions/TransaccionesMasivas_PlanillasAplicarOutputGxJsonError"
         401404:
          description: "Not Authenticatedfound"
          schema:
            $ref: "#/definitions/GxJsonError"
        404400:
          description: "NotBad foundrequest"
          schema:
            $ref: "#/definitions/GxJsonError"
        400500:
          description: "BadInternal server requesterror"
          schema:
            $ref: "#/definitions/GxJsonError"
security:
  - OAuth2: []
    500ApiKeyAuth1: []
securityDefinitions:
  OAuth2:
     descriptiontype: "Internaloauth2
server error"   flow: password
    tokenUrl:  schema:https://test.sifco.org/DemoCoopGT/oauth/access_token
    scopes:
       $refExecute: "#/definitions/GxJsonError"
security:
  - OAuth2: []Permite el método tipo GET
      ApiKeyAuth1Insert: []
securityDefinitions:
  OAuth2: Permite el método tipo POST
      typeUpdate: oauth2Permite el método tipo PUT
flow: password     tokenUrlDelete: https://test.sifco.org/DemoCoopGT/oauth/access_token
    scopes:Permite el método tipo DELETE
      FullControl: Execute: Permite el métodomanejo tipode GETlos Cuatro Métodos GET, POST,   Insert: Permite PUT,DELETE, sobre el métodoWeb tipoService
POST  ApiKeyAuth1:
    Updatetype: PermiteapiKey
el método tipo PUT in: header
    Deletename: Permitegranttype
el
métododefinitions:
tipo
DELETE  TransaccionesMasivas_PlanillasAplicarInput:
    FullControlproperties:
Permite el manejo de los Cuatro MétodosPlanillas:
GET, POST, PUT,DELETE, sobre el Web Service   ApiKeyAuth1description: Transacciones Masivas_Planilla Entrada
 type: apiKey     in: header
    name: granttype

definitions: $ref: "#/definitions/TransaccionesMasivas_PlanillaEntrada"
  
  TransaccionesMasivas_PlanillasAplicarInputPlanillaEntrada:
    properties:
      Planillas:
        descriptiontype: Transaccionesarray
Masivas_Planilla Entrada        items:
          description: Planilla
          $ref: "#/definitions/TransaccionesMasivas_PlanillaEntrada.Planillas"


   TransaccionesMasivas_PlanillaEntrada.Planillas:
    properties:
      PlanillasID:
        typedescription: array ID de la Planilla
        itemstype: "string"

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

    x-gx-level: "TransaccionesMasivas_PlanillaEntrada"

  TransaccionesMasivas_PlanillaEntrada.Planillas.Detalles:
    properties:
      ID:
        description: ID dedel la PlanillaCargo
        type: "string"
        Detallesformat: uuid

      typeValor: array
        itemsdescription: Valor a Descontar o Descontado
     description: Detalle  type: "number"
        $refformat: "#/definitions/TransaccionesMasivas_PlanillaEntrada.Planillas.Detalles"double"


    x-gx-level: "TransaccionesMasivas_PlanillaEntrada.Planillas"

  TransaccionesMasivas_PlanillaEntrada.Planillas.DetallesPlanillasAplicarOutput:
    properties:
      IDerror:
        descriptiontype: ID"integer"
del Cargo         typeformat: "stringint32"
       Valormensajes:
        descriptiontype: Valor"string"
a
Descontar o DescontadoGxJsonError:
        typeproperties:
"number"      error:
  format: "double"       x-gx-level$ref: "TransaccionesMasivas_PlanillaEntrada.Planillas#/definitions/GxJsonError.error"

  TransaccionesMasivas_PlanillasAplicarOutputGxJsonError.error:
    properties:
      errorcode:
        typedescription: "integer" Código de Error
        formattype: "int32string"

     mensajes message:
        typedescription: "string"Mensaje de Error
 GxJsonError:     properties:       errortype: "string"


     $refx-gx-level: "#/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"

"

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.

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.

RESPETE LOS ENCABEZADOS OBLIGATORIOS para que pueda consumir el WEB SERVICE respectivo.

Content-Type: application/json
Authorization: OAuth f2a9ec34-cf83-46f5-8862-f78ac03670d1!171380a787a9152688ab61a94d66e0eb77...
GENEXUS-AGENT: SmartDevice Application

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.