swagger: '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 Registrar o Modificar un Tipo de Actividad Economica 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: "TApActEconomica"
  externalDocs:
    description: "Manual SIFCO"
    url: "https://sifco.atlassian.net/wiki/x/MQDf"
produces:
  - application/json
paths:
  /TApActEconomica/{ApActCod}:
    get:
      tags:
        - TApActEconomica
      operationId: "GetTApActEconomica"
      summary: "Consultar los Tipos de Actividad Economica Registrados en el Sistema"
      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: "ApActCod"
          in: "path"
          description: "Código de actividad económica"
          required: true
          type: "integer"
          format: "int32"
      
      responses:
        200:
          description: "Successful operation"
          schema:
            $ref: "#/definitions/TApActEconomica"
        400:
          description: "Bad request"
          schema:
            $ref: "#/definitions/GxJsonError"
        401:
          description: "Not Authenticated"
          schema:
            $ref: "#/definitions/GxJsonError"
        404:
          description: "Data with the specified key could not be found"
          schema:
            $ref: "#/definitions/GxJsonError"
        500:
          description: "Internal server error"
          schema:
            $ref: "#/definitions/GxJsonError"

    post:
      tags:
        - TApActEconomica
      operationId: "InsertTApActEconomica"
      summary: "Insertar los Tipos de Actividad Economica Registrados en el Sistema"
      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: "ApActCod"
          in: "path"
          description: "Código de actividad económica"
          required: true
          type: "integer"
          format: "int32"
        - name: "TApActEconomica"
          in: "body"
          description: "SDT of TApActEconomica"
          required: false
          schema:
            $ref: "#/definitions/TApActEconomica"

      responses:
        200:
          description: "Successful operation"
          schema:
            $ref: "#/definitions/TApActEconomica"
        201:
          description: "Created"
          schema:
            $ref: "#/definitions/TApActEconomica"
        400:
          description: "Bad request"
          schema:
            $ref: "#/definitions/GxJsonError"
        401:
          description: "Not Authenticated"
          schema:
            $ref: "#/definitions/GxJsonError"
        404:
          description: "Data with the specified key could not be found"
          schema:
            $ref: "#/definitions/GxJsonError"
        500:
          description: "Internal server error"
          schema:
            $ref: "#/definitions/GxJsonError"

    put:
      tags:
        - TApActEconomica
      operationId: "UpdateTApActEconomica"
      summary: "Actualizar los Tipos de Actividad Economica Registrados en el Sistema"
      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: "ApActCod"
          in: "path"
          description: "Código de actividad económica"
          required: true
          type: "integer"
          format: "int32"
        - name: "TApActEconomica"
          in: "body"
          description: "SDT of TApActEconomica"
          required: true
          schema:
            $ref: "#/definitions/TApActEconomica"
      
      responses:
        200:
          description: "Successful operation"
          schema:
            $ref: "#/definitions/TApActEconomica"
        400:
          description: "Bad request"
          schema:
            $ref: "#/definitions/GxJsonError"
        401:
          description: "Not Authenticated"
          schema:
            $ref: "#/definitions/GxJsonError"
        404:
          description: "Not found"
          schema:
            $ref: "#/definitions/GxJsonError"
        409:
          description: "TApActEconomica was changed"
        500:
          description: "Internal server error"
          schema:
            $ref: "#/definitions/GxJsonError"

    delete:
      tags:
        - TApActEconomica
      operationId: "DeleteTApActEconomica"
      summary: "Eliminar los Tipos de Actividad Economica Registrados en el Sistema"
      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: "ApActCod"
          in: "path"
          description: "Código de actividad económica"
          required: true
          type: "integer"
          format: "int32"

      responses:
        200:
          description: "Successful operation"
          schema:
            $ref: "#/definitions/TApActEconomica"
        204:
          description: "Successful operation"
          schema:
            $ref: "#/definitions/TApActEconomica"
        400:
          description: "Bad request"
          schema:
            $ref: "#/definitions/GxJsonError"
        401:
          description: "Not Authenticated"
          schema:
            $ref: "#/definitions/GxJsonError"
        404:
          description: "Not found"
          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 metodo tipo GET
      Insert: Permite el metodo tipo POST
      Update: Permite el metodo tipo PUT
      Delete: Permite el metodo tipo DELETE
      FullControl: Permite el manejo de los Cuatro Metodos GET, POST, PUT,DELETE, sobre el Web Service
  ApiKeyAuth1:
    type: apiKey
    in: header
    name: granttype

definitions:

  TApActEconomica:
    properties:
      ApActCod:
        description: Código de actividad económica
        type: "integer"
        format: "int32"

      ApActDes:
        description: Descripción de actividad económica
        type: "string"

      ApActPadreCod:
        description: Código de actividad económica padre
        type: "integer"
        format: "int32"

      ApActPadreDes:
        description: Descripción de actividad económica padre
        type: "string"

      ApActRef:
        description: Referencia de actividad económica
        type: "string"

      gx_md5_hash:
        description: gx_md5_hash is an identifier for a specific version of a resource, it is used for optimistic concurrency check. It is required for update and delete operations and  ignored on insert.
        type: "string"


    required:
      - ApActCod

  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"

NO DEBE OLVIDAR

NO olvide que este Web Service, NO REQUIERE seguir algún Flujo de Trabajo especifico por ende se puede utilizar de forma independiente al Flujo de Trabajo descrito en el Web Services de Clientes.

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.