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 las Regiones de un País 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: "TApRegion"
  externalDocs:
    description: "Manual SIFCO"
    url: "https://sifco.atlassian.net/wiki/x/cgDe"
produces:
  - application/json
paths:
  /TApRegion/{ApPaiCod},{ApRegCod}:
    get:
      tags:
        - TApRegion
      operationId: "GetTApRegion"
      summary: "Consultar las Regiones de un País 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: "ApPaiCod"
          in: "path"
          description: "Código"
          required: true
          type: "integer"
          format: "int64"
        - name: "ApRegCod"
          in: "path"
          description: "Código División Geográfica"
          required: true
          type: "integer"
          format: "int64"
      
      responses:
        200:
          description: "Successful operation"
          schema:
            $ref: "#/definitions/TApRegion"
        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:
        - TApRegion
      operationId: "InsertTApRegion"
      summary: "Insertar las Regiones de un País 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: "ApPaiCod"
          in: "path"
          description: "Código"
          required: true
          type: "integer"
          format: "int64"
        - name: "ApRegCod"
          in: "path"
          description: "Código División Geográfica"
          required: true
          type: "integer"
          format: "int64"
        - name: "TApRegion"
          in: "body"
          description: "SDT of TApRegion"
          required: false
          schema:
            $ref: "#/definitions/TApRegion"

      responses:
        200:
          description: "Successful operation"
          schema:
            $ref: "#/definitions/TApRegion"
        201:
          description: "Created"
          schema:
            $ref: "#/definitions/TApRegion"
        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:
        - TApRegion
      operationId: "UpdateTApRegion"
      summary: "Actualizar las Regiones de un País 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: "ApPaiCod"
          in: "path"
          description: "Código"
          required: true
          type: "integer"
          format: "int64"
        - name: "ApRegCod"
          in: "path"
          description: "Código División Geográfica"
          required: true
          type: "integer"
          format: "int64"
        - name: "TApRegion"
          in: "body"
          description: "SDT of TApRegion"
          required: true
          schema:
            $ref: "#/definitions/TApRegion"
      
      responses:
        200:
          description: "Successful operation"
          schema:
            $ref: "#/definitions/TApRegion"
        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: "TApRegion was changed"
        500:
          description: "Internal server error"
          schema:
            $ref: "#/definitions/GxJsonError"

    delete:
      tags:
        - TApRegion
      operationId: "DeleteTApRegion"
      summary: "Eliminar las Regiones de un País 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: "ApPaiCod"
          in: "path"
          description: "Código"
          required: true
          type: "integer"
          format: "int64"
        - name: "ApRegCod"
          in: "path"
          description: "Código División Geográfica"
          required: true
          type: "integer"
          format: "int64"

      responses:
        200:
          description: "Successful operation"
          schema:
            $ref: "#/definitions/TApRegion"
        204:
          description: "Successful operation"
          schema:
            $ref: "#/definitions/TApRegion"
        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 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:

  TApRegion:
    properties:
      ApPaiCod:
        description: Código
        type: "integer"
        format: "int64"

      ApPaiNombre:
        description: Paí­s
        type: "string"

      ApRegCod:
        description: Código División Geográfica
        type: "integer"
        format: "int64"

      ApRegDes:
        description: Descripción División Geográfica
        type: "string"

      ApRegGeo:
        description: Geo-Ubicación de regionregión
        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:
      - ApPaiCod
      - ApRegCod

  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"

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.