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: "PPI_Encuesta"
  externalDocs:
    description: "Manual SIFCO"
    url: "https://sifco.atlassian.net/wiki/x/HoDb"
produces:
  - application/json
paths:
  /PPI_Encuesta/{PPI_EncuestaID}:
    get:
      tags:
        - PPI_Encuesta
      operationId: "GetPPI_Encuesta"
      summary: "Consultar la Encuesta a Realizar a un Cliente 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: "PPI_EncuestaID"
          in: "path"
          description: "Encuesta Realizada"
          required: true
          type: "integer"
          format: "int32"
      
      responses:
        200:
          description: "Successful operation"
          schema:
            $ref: "#/definitions/PPI_Encuesta"
        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"

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:

  PPI_Encuesta:
    properties:
      PPI_EncuestaID:
        description: Encuesta Realizada
        type: "integer"
        format: "int32"

      PPI_EncuestaDescripcion:
        description: Nombre de la Encuesta
        type: "string"

      PPI_EncuestaExplicacion:
        description: Descripción Técnica de la Encuesta
        type: "string"

      PPI_EncuestaUsuario:
        description: Usuario que Modifica la Encuesta
        type: "string"

      PPI_EncuestaFechaUltimoCambio:
        description: Fecha del Ultimo Cambio
        type: "string"
        format: "date-time"

      PPI_EncuestaEstado:
        description: Estado
        type: "boolean"

      PPI_EncuestaScoreMax:
        description: Total del Score
        type: "integer"
        format: "int32"

      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"

      Preguntas:
        $ref: "#/definitions/PPI_Encuesta.PreguntasEncuesta"

    required:
      - PPI_EncuestaID

  PPI_Encuesta.PreguntasEncuesta:
    properties:
      PPI_EncuestaPreguntaID:
        description: Pregunta
        type: "integer"
        format: "int32"

      PPI_EncuestaPreguntaTexto:
        description: Texto de la Pregunta
        type: "string"

      PPI_EncuestaPreguntaTipo:
        description: Tipo de Pregunta
        type: "integer"
        format: "int32"

      PPI_EncuestaPreguntasScore:
        description: Score Máximo de la Pregunta
        type: "integer"
        format: "int32"

      PPI_EncuestaPreguntaObligatoria:
        description: Es una pregunta obligatoria
        type: "boolean"

      Respuestas:
        $ref: "#/definitions/PPI_Encuesta.PreguntasEncuesta.Respuestas"

    required:
      - PPI_EncuestaPreguntaID
    x-gx-level: "PPI_Encuesta"

  PPI_Encuesta.PreguntasEncuesta.Respuestas:
    properties:
      PPI_EncuestaRespuesta:
        description: Respuesta
        type: "string"

      PPI_EncuestaRespuestaScore:
        description: Valor de la Respuesta
        type: "integer"
        format: "int32"


    required:
      - PPI_EncuestaRespuesta
    x-gx-level: "Preguntas"

  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"

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.