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_EncuestaRealizadas"
  externalDocs:
    description: "Manual SIFCO"
    url: "https://sifco.atlassian.net/wiki/x/EQDc"
produces:
  - application/json
paths:
  /PPI_EncuestaRealizadas/{PPI_EncuestaCorrelativo}:
    get:
      tags:
        - PPI_EncuestaRealizadas
      operationId: "GetPPI_EncuestaRealizadas"
      summary: "Consultar la Encuesta a Realizarlas Encuestas Realizadas con su Correlativo correspondiente 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_EncuestaCorrelativo"
          in: "path"
          description: "Correlativo"
          required: true
          type: "integer"
          format: "int64"
      
      responses:
        200:
          description: "Successful operation"
          schema:
            $ref: "#/definitions/PPI_EncuestaRealizadas"
        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"

  
 postsecurity:
  - OAuth2: []
    ApiKeyAuth1: []
securityDefinitions:
  tagsOAuth2:
    type: oauth2
  - PPI_EncuestaRealizadas flow: password
    operationIdtokenUrl: "InsertPPI_EncuestaRealizadas"https://test.sifco.org/DemoCoopGT/oauth/access_token
    scopes:
 summary: "Insertar la Encuesta a RealizarExecute: aPermite unel Clientemétodo entipo elGET
Sistema"      Insert: parameters:Permite el método tipo POST
     - inUpdate: headerPermite el método tipo PUT
      nameDelete: Content-TypePermite el método tipo DELETE
      typeFullControl: "string"Permite el manejo de los Cuatro Métodos GET, POST, PUT,DELETE, sobre required:el trueWeb Service
  ApiKeyAuth1:
      defaulttype: application/jsonapiKey
        - in: header
    name: granttype

definitions:

 name PPI_EncuestaRealizadas:
Authorization    properties:
      typePPI_EncuestaCorrelativo:
"string"        description: Correlativo
  required: true     type: "integer"
    default: OAuth <Access Token> format: "int64"

     - inPPI_EncuestaID:
header           namedescription: GENEXUS-AGENTEncuesta  Realizada
        type: "stringinteger"
          requiredformat: true"int32"

         defaultPPI_EncuestaEstado:
SmartDevice Application         - namedescription: "PPI_EncuestaCorrelativo"Estado
          intype: "pathboolean"

         descriptionPPI_Cliente:
"Correlativo"           requireddescription: true
 Cliente
        type: "integer"
          format: "int64"

       - name: "PPI_EncuestaRealizadas"ClienteActivo:
        description: Cliente in: "body"
 Activo al Momento de la Encuesta
        descriptiontype: "SDT ofboolean"

      PPI_EncuestaRealizadas"ClienteCiclo:
          requireddescription: falseCiclo al Momento de la Encuesta
     schema:   type: "integer"
        $refformat: "#/definitions/PPI_EncuestaRealizadasint32"

      responsesPPI_EncuestaFechaRealizada:
        200description: Fecha 
        descriptiontype: "Successful operationstring"
          schemaformat: "date"

          $ref: "#/definitions/PPI_EncuestaRealizadas"EncuestaEncuestador:
        201description: Encuestador
         descriptiontype: "Createdstring"

      PPI_EncuestaOperador:
     schema:   description: Operador
        $reftype: "#/definitions/PPI_EncuestaRealizadasstring"

       400PPI_EncuestaFechaOperacion:
          description: Fecha "BadOperación
request"        type: "string"
 schema:       format: "date-time"

   $ref   PPI_EncuestaUltimoOperador:
"#/definitions/GxJsonError"        description: Ultima 401:persona en Operar
        descriptiontype: "Not Authenticated"
 "string"

      PPI_EncuestaFechaSupervision:
        schemadescription: Fecha de Supervisión
         $reftype: "#/definitions/GxJsonErrorstring"
        404format: "date-time"

      PPI_EncuestaRealizadaScore:
 description: "Data with the specified key could not be found"description: Score
          schematype: "integer"
           $refformat: "#/definitions/GxJsonErrorint32"

       500PPI_EncuestaRealizadaEstado:
          description: "InternalEstado serverde error"la Encuesta
         schema:type: "boolean"

      PPI_EncuestaSupervisor:
    $ref: "#/definitions/GxJsonError"   description: Supervisor
 put:       tagstype: "string"

      - PPI_EncuestaRealizadasgx_md5_hash:
        operationIddescription: "UpdatePPI_EncuestaRealizadas"
      summary: "Actualizar la Encuesta a Realizar a un Cliente en el Sistema"
      parameters:
        - in: headergx_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"

   name: Content-Type  EncuestaRealizadaPreguntas:
        type$ref: "string#/definitions/PPI_EncuestaRealizadas.EncuestaRealizadaPreguntas"

      EncuestaIndicadores:
  required:  true    $ref: "#/definitions/PPI_EncuestaRealizadas.EncuestaIndicadores"

    defaultrequired:
application/json      - PPI_EncuestaCorrelativo

- in  PPI_EncuestaRealizadas.EncuestaRealizadaPreguntas:
header    properties:
      namePPI_EncuestaPreguntaID: Authorization
          typedescription: "string"Pregunta
          requiredtype: true"integer"
          defaultformat: OAuth"int32"
<Access
Token>         - inPPI_EncuestaPreguntaTexto:
header        description: Texto de name: GENEXUS-AGENTla Pregunta
          type: "string"

      PPI_EncuestaPreguntaObligatoria:
   required:  true   description: Es una pregunta obligatoria
   default: SmartDevice Application   type: "boolean"

    - name: "PPI_EncuestaCorrelativo"EncuestaPreguntaTipo:
          indescription: "path"Tipo de Pregunta
        descriptiontype: "Correlativointeger"
        format:  required: true"int32"

      PPI_EncuestaRealizadaRespuesta:
      type: "integer" description: Respuesta
        formattype: "int64string"
 

     - name: "PPI_EncuestaRealizadas"EncuestaRealizadaRespTxt:
          indescription: "body"Respuesta Texto
         descriptiontype: "SDT of PPI_EncuestaRealizadasstring"

         requiredPPI_EncuestaRealizadaRespFecha:
true        description: Respuesta Fecha
schema:        type: "string"
   $ref: "#/definitions/PPI_EncuestaRealizadas"    format: "date"

       responsesPPI_EncuestaRealizadaRespMonto:
        200description: Respuesta Monto
        descriptiontype: "Successful operationnumber"
          schemaformat:  "double"

         $ref: "#/definitions/PPI_EncuestaRealizadas"EncuestaRealizadaRespCantidad:
        400description: Respuesta Cantidad
        descriptiontype: "Bad requestinteger"
        format: "int64"
schema:
      PPI_EncuestaRealizadaPreguntaScore:
      $ref: "#/definitions/GxJsonError"  description: Punteo según el Score
        401type: "integer"
         descriptionformat: "Notint32"

Authenticated"      PPI_EncuestaRespuestaScoreOriginal:
     schema   description: Punteo para la pregunta
        $reftype: "#/definitions/GxJsonErrorinteger"
        404format: "int32"


       descriptionrequired:
"Not found"     - PPI_EncuestaPreguntaID
    schemax-gx-level: "PPI_EncuestaRealizadas"


  PPI_EncuestaRealizadas.EncuestaIndicadores:
      $refproperties:
"#/definitions/GxJsonError"         409PPI_IndicadorID:
          description: "PPI_EncuestaRealizadas was changed"
  Indicador de Pobreza a Medir ID
      500:  type: "integer"
       description format: "Internal server error"
 "int32"

      PPI_Indicador:
        schemadescription: Indicador de Pobreza a Medir
       $ref type: "#/definitions/GxJsonErrorstring"

    delete  PPI_EncuestaRealizadaIndicadorValor:
      tags  description: Valor 
      - PPI_EncuestaRealizadas  type: "number"
        operationIdformat: "DeletePPI_EncuestaRealizadasdouble"


    summaryrequired:
"Eliminar la Encuesta a Realizar a un- ClientePPI_IndicadorID
en el Sistema"  x-gx-level: "PPI_EncuestaRealizadas"

  parametersGxJsonError:
    properties:
   -   inerror:
 header       $ref: "#/definitions/GxJsonError.error"

  nameGxJsonError.error:
Content-Type    properties:
      typecode:
"string"           requireddescription: trueCódigo de Error
        defaulttype: application/json"string"

       - in: headermessage:
          namedescription: AuthorizationMensaje de Error
        type: "string"


        required: true
          default: OAuth <Access Token>
        - in: header
          name: GENEXUS-AGENT
          type: "string"
          required: true
          default: SmartDevice Application
        - name: "PPI_EncuestaCorrelativo"
          in: "path"
          description: "Correlativo"
          required: true
          type: "integer"
          format: "int64"

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

  PPI_EncuestaRealizadas:
    properties:
      PPI_EncuestaCorrelativo:
        description: Correlativo
        type: "integer"
        format: "int64"

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

      PPI_EncuestaEstado:
        description: Estado
        type: "boolean"

      PPI_Cliente:
        description: Cliente
        type: "integer"
        format: "int64"

      PPI_ClienteActivo:
        description: Cliente Activo al Momento de la Encuesta
        type: "boolean"

      PPI_ClienteCiclo:
        description: Ciclo al Momento de la Encuesta
        type: "integer"
        format: "int32"

      PPI_EncuestaFechaRealizada:
        description: Fecha 
        type: "string"
        format: "date"

      PPI_EncuestaEncuestador:
        description: Encuestador
        type: "string"

      PPI_EncuestaOperador:
        description: Operador
        type: "string"

      PPI_EncuestaFechaOperacion:
        description: Fecha Operación
        type: "string"
        format: "date-time"

      PPI_EncuestaUltimoOperador:
        description: Ultima persona en Operar
        type: "string"

      PPI_EncuestaFechaSupervision:
        description: Fecha de Supervisión
        type: "string"
        format: "date-time"

      PPI_EncuestaRealizadaScore:
        description: Score
        type: "integer"
        format: "int32"

      PPI_EncuestaRealizadaEstado:
        description: Estado de la Encuesta
        type: "boolean"

      PPI_EncuestaSupervisor:
        description: Supervisor
        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"

      EncuestaRealizadaPreguntas:
        $ref: "#/definitions/PPI_EncuestaRealizadas.EncuestaRealizadaPreguntas"

      EncuestaIndicadores:
        $ref: "#/definitions/PPI_EncuestaRealizadas.EncuestaIndicadores"

    required:
      - PPI_EncuestaCorrelativo

  PPI_EncuestaRealizadas.EncuestaRealizadaPreguntas:
    properties:
      PPI_EncuestaPreguntaID:
        description: Pregunta
        type: "integer"
        format: "int32"

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

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

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

      PPI_EncuestaRealizadaRespuesta:
        description: Respuesta
        type: "string"

      PPI_EncuestaRealizadaRespTxt:
        description: Respuesta Texto
        type: "string"

      PPI_EncuestaRealizadaRespFecha:
        description: Respuesta Fecha
        type: "string"
        format: "date"

      PPI_EncuestaRealizadaRespMonto:
        description: Respuesta Monto
        type: "number"
        format: "double"

      PPI_EncuestaRealizadaRespCantidad:
        description: Respuesta Cantidad
        type: "integer"
        format: "int64"

      PPI_EncuestaRealizadaPreguntaScore:
        description: Punteo según el Score
        type: "integer"
        format: "int32"

      PPI_EncuestaRespuestaScoreOriginal:
        description: Punteo para la pregunta
        type: "integer"
        format: "int32"


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


  PPI_EncuestaRealizadas.EncuestaIndicadores:
    properties:
      PPI_IndicadorID:
        description: Indicador de Pobreza a Medir ID
        type: "integer"
        format: "int32"

      PPI_Indicador:
        description: Indicador de Pobreza a Medir
        type: "string"

      PPI_EncuestaRealizadaIndicadorValor:
        description: Valor 
        type: "number"
        format: "double"


    required:
      - PPI_IndicadorID
    x-gx-level: "PPI_EncuestaRealizadas"

  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"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.