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: "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 Económica 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"
      summary:
"Consultar los Tipos de Actividad Económica Registrados enresponses:
el Sistema"       parameters200:
         - indescription: header"Successful operation"
          nameschema:
 Content-Type           type$ref: "string#/definitions/TApActEconomica"
        400:
 required: true         description: "Bad request"
          defaultschema:
application/json         - in: header $ref: "#/definitions/GxJsonError"
        name401:
Authorization           typedescription: "stringNot Authenticated"
          requiredschema:
 true           default$ref: OAuth <Access Token>"#/definitions/GxJsonError"
          - in404:
header           namedescription: GENEXUS-AGENT"Data with the specified key could not     type: "string"be found"
          requiredschema:
true            default$ref: SmartDevice Application"#/definitions/GxJsonError"
        - name: "ApActCod"500:
          indescription: "pathInternal server error"
          descriptionschema:
"Código de actividad económica"            $ref: "#/definitions/GxJsonError"

    requiredpost:
true      tags:
    type: "integer"   - TApActEconomica
      formatoperationId: "int32InsertTApActEconomica"
      summary: "Insertar los Tipos de Actividad Económica Registrados responses:en el Sistema"
      200parameters:
        -  descriptionin: "Successful operation"header
          schemaname: Content-Type
           $reftype: "#/definitions/TApActEconomicastring"
        400  required: true
         description default: "Bad request"application/json
        - in: header
schema:          name: Authorization
 $ref: "#/definitions/GxJsonError"         401:type: "string"
          descriptionrequired: "Nottrue
 Authenticated"         default: OAuth schema:<Access Token>
        - in: header
$ref: "#/definitions/GxJsonError"         404name: GENEXUS-AGENT
         description type: "Data with the specified key could not be found"string"
          required: true
          schemadefault: SmartDevice Application
        -  $refname: "#/definitions/GxJsonError"ApActCod"
          500in: "path"
          description: "InternalCódigo de serveractividad erroreconómica"
          schemarequired:
 true
          $reftype: "#/definitions/GxJsonErrorinteger"
     post:     format: "int32"
tags:        - -name: "TApActEconomica"
          operationIdin: "InsertTApActEconomicabody"
      summary    description: "InsertarSDT losof TiposTApActEconomica"
de Actividad Económica Registrados en el Sistema"    required: false
 parameters:         -schema:
in: header           name$ref: Content-Type"#/definitions/TApActEconomica"

         typeresponses:
"string"        200:
  required: true       description: "Successful operation"
 default: application/json        schema:
- in: header           name$ref: Authorization"#/definitions/TApActEconomica"
          type201:
"string"           requireddescription: true"Created"
          defaultschema:
OAuth <Access Token>         - in$ref: header"#/definitions/TApActEconomica"
          name400:
GENEXUS-AGENT           typedescription: "stringBad request"
          requiredschema:
 true           default$ref: SmartDevice Application"#/definitions/GxJsonError"
         - name401:
"ApActCod"           indescription: "pathNot Authenticated"
          descriptionschema:
"Código   de actividad económica"       $ref: "#/definitions/GxJsonError"
  required: true     404:
     type: "integer"    description: "Data with the specified key could format:not be found"int32"
         - nameschema:
"TApActEconomica"            in$ref: "body#/definitions/GxJsonError"
          description500:
"SDT of TApActEconomica"        description: "Internal  required: falseserver error"
          schema:
            $ref: "#/definitions/TApActEconomicaGxJsonError"

    put:
 responses:     tags:
     200:   - TApActEconomica
      descriptionoperationId: "Successful operation"UpdateTApActEconomica"
      summary: "Actualizar los Tipos schema:de Actividad Económica Registrados en el Sistema"
      $refparameters:
"#/definitions/TApActEconomica"        - 201in: header
         description name: "Created"Content-Type
          schematype: "string"
          required: true
$ref: "#/definitions/TApActEconomica"         400default: application/json
        - descriptionin: "Bad request"header
          schemaname: Authorization
           $reftype: "#/definitions/GxJsonErrorstring"
        401  required: true
          descriptiondefault: "NotOAuth Authenticated"<Access Token>
        - schemain: header
           $refname: "#/definitions/GxJsonError"
 GENEXUS-AGENT
      404:       type: "string"
   description: "Data with the specified key could not berequired: found"true
          schemadefault: SmartDevice Application
        -  $refname: "#/definitions/GxJsonErrorApActCod"
        500  in: "path"
          description: "InternalCódigo de serveractividad erroreconómica"
          schemarequired: true
           $reftype: "#/definitions/GxJsonErrorinteger"
     put:     format: "int32"
tags:        - -name: "TApActEconomica"
      operationId: "UpdateTApActEconomica"       summaryin: "Actualizar losbody"
Tipos de Actividad Económica Registrados en el Sistema"   description: "SDT of TApActEconomica"
parameters:         - inrequired: headertrue
          nameschema:
Content-Type            type$ref: "string#/definitions/TApActEconomica"
      
   required: true  responses:
        default200:
application/json         - indescription: header"Successful operation"
          nameschema:
Authorization            type$ref: "string#/definitions/TApActEconomica"
          required400: true
          defaultdescription: OAuth"Bad <Accessrequest"
Token>         - inschema:
header            name$ref: GENEXUS-AGENT"#/definitions/GxJsonError"
          type401:
"string"          description: required: true"Not Authenticated"
          defaultschema:
 SmartDevice Application         - name$ref: "ApActCod#/definitions/GxJsonError"
          in: "path"404:
          description: "Código de actividad económicaNot found"
          requiredschema:
true            type$ref: "integer#/definitions/GxJsonError"
          format409:
"int32"         - namedescription: "TApActEconomica" was changed"
        in500: "body"
          description: "SDTInternal ofserver TApActEconomicaerror"
          requiredschema:
true            schema:$ref: "#/definitions/GxJsonError"

    delete:
      $reftags: "#/definitions/TApActEconomica"
        - TApActEconomica
      operationId: "DeleteTApActEconomica"
responses:      summary: "Eliminar los 200:Tipos de Actividad Economica Registrados en el Sistema"
   description: "Successful operation" parameters:
        - schemain: header
           $ref: "#/definitions/TApActEconomica"name: Content-Type
          400type: "string"
         description required: "Badtrue
request"           schemadefault: application/json
        -   $refin: "#/definitions/GxJsonError"header
          401name: Authorization
         description type: "Not Authenticatedstring"
          schemarequired: true
           $ref: "#/definitions/GxJsonError"default: OAuth <Access Token>
        - 404in: header
         description name: "Not found"GENEXUS-AGENT
           schema:type: "string"
          required: true
$ref: "#/definitions/GxJsonError"         409default: SmartDevice Application
        - descriptionname: "ApActCod"TApActEconomica
was changed"         500in: "path"
          description: "InternalCódigo de serveractividad erroreconómica"
          schemarequired: true
           $reftype: "#/definitions/GxJsonErrorinteger"
      delete:    format: "int32"

      tagsresponses:
        -200:
   TApActEconomica       operationIddescription: "DeleteTApActEconomicaSuccessful operation"
      summary: "Eliminar los Tipos deschema:
Actividad Economica Registrados en el Sistema"       parameters$ref: "#/definitions/TApActEconomica"
       - in204:
header          description: name: Content-Type"Successful operation"
          typeschema:
"string"            required$ref: true"#/definitions/TApActEconomica"
          default400:
application/json         - indescription: header"Bad request"
          nameschema:
 Authorization           type$ref: "string#/definitions/GxJsonError"
          required401: true
          defaultdescription: OAuth"Not <AccessAuthenticated"
Token>         - inschema:
header            name$ref: GENEXUS-AGENT"#/definitions/GxJsonError"
          type404:
"string"          description: required: true"Not found"
          defaultschema:
SmartDevice  Application         - name$ref: "ApActCod#/definitions/GxJsonError"
          in500:
"path"           description: "Código deInternal actividadserver económicaerror"
          requiredschema:
true            type$ref: "integer#/definitions/GxJsonError"


security:
  -     formatOAuth2: "int32"[]
    ApiKeyAuth1: []
 responsessecurityDefinitions:
  OAuth2:
    type: 200:oauth2
    flow: password
    descriptiontokenUrl: "Successful operation"https://test.sifco.org/DemoCoopGT/oauth/access_token
    scopes:
      schemaExecute: Permite el método tipo GET
       $ref: "#/definitions/TApActEconomica"
 Insert: Permite el método tipo POST
      204Update: Permite el método tipo PUT
      descriptionDelete: "SuccessfulPermite operation"el método tipo DELETE
       schemaFullControl: Permite el manejo de los Cuatro Métodos GET,     $ref: "#/definitions/TApActEconomica"
        400POST, PUT,DELETE, sobre el Web Service
  ApiKeyAuth1:
    type: apiKey
    descriptionin: "Badheader
request"    name: granttype

definitions:

  schemaTApActEconomica:
    properties:
      ApActCod:
$ref: "#/definitions/GxJsonError"       description: Código 401:de actividad económica
        descriptiontype: "Not Authenticatedinteger"
          schemaformat: "int32"

          $ref: "#/definitions/GxJsonError"ApActDes:
        404description: Descripción de actividad económica
       description type: "Not foundstring"

         schemaApActPadreCod:
        description: Código de actividad $ref: "#/definitions/GxJsonError"económica padre
        500type: "integer"
         descriptionformat: "Internal server errorint32"

      ApActPadreDes:
  schema:      description: Descripción de actividad económica  padre
$ref: "#/definitions/GxJsonError"   security:   - OAuth2type: "string"
[]
    ApiKeyAuth1: [] securityDefinitionsApActRef:
  OAuth2:      typedescription: oauth2Referencia de actividad económica
  flow: password     tokenUrl: https://test.sifco.org/DemoCoopGT/oauth/access_tokentype: "string"

   scopes:   gx_md5_hash:
   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
  ApiKeyAuth1description: 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:
    typeproperties:
apiKey      inerror:
header      name: granttype $ref: definitions:"#/definitions/GxJsonError.error"

  TApActEconomicaGxJsonError.error:
    properties:
      ApActCodcode:
        description: Código de actividadError
económica
        type: "integer"string"

      message:
        description: Mensaje de Error
        formattype: "int32string"


     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: Código de Error
        type: "string"

      message:
        description: Mensaje de Error
        type: "string"


    x-gx-level: "GxJsonError"x-gx-level: "GxJsonError"

INFORMACIÓN

Para identificar el MENSAJE DE ERROR remitirse a la pagina de (Listado de Errores) External Call Out, donde se describe el listado de errores que arroja las API’s REST de la Aplicación SIFCO WEB, con su respectiva Descripción.