Versions Compared

Old Version 2

changes.mady.by.user Alfredo Lopez (Unlicensed)

Saved on

compared with

New Version 3

changes.mady.by.user Alfredo Lopez (Unlicensed)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Web Services para Consultar Encuestas ya realizadas a los Clientes.

Swagger open api macro
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 una Encuesta Realizadas a un cliente con su correlativo correspondiente 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: "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"

    post:
      tags:
        - PPI_EncuestaRealizadas
      operationId: "InsertPPI_EncuestaRealizadas"
      summary: "Insertar la Encuesta a Realizar las 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"
        - name: "PPI_EncuestaRealizadas"
          in: "body"
          description: "SDT of PPI_EncuestaRealizadas"
          required: false
          schema:
            $ref: "#/definitions/PPI_EncuestaRealizadas"

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

    put:
      tags:
        - PPI_EncuestaRealizadas
      operationId: "UpdatePPI_EncuestaRealizadas"
      summary: "Actualizar la Encuesta a Realizar las 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"
        - name: "PPI_EncuestaRealizadas"
          in: "body"
          description: "SDT of PPI_EncuestaRealizadas"
          required: true
          schema:
            $ref: "#/definitions/PPI_EncuestaRealizadas"
      
      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: "Not found"
          schema:
            $ref: "#/definitions/GxJsonError"
        409:
          description: "PPI_EncuestaRealizadas was changed"
        500:
          description: "Internal server error"
          schema:
            $ref: "#/definitions/GxJsonError"

    delete:
      tags:
        - PPI_EncuestaRealizadas
      operationId: "DeletePPI_EncuestaRealizadas"
      summary: "Eliminar la Encuesta a Realizar las 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"
        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"
Note

NO DEBE OLVIDAR

NO olvide tomar en cuenta para el uso de este Web Service, el Flujo de Trabajo descrito en Web Services de Clientes, dado a que en caso de no seguirlo al pie de la letra puede generar errores inesperados en la ejecución.

Note

RESPETE LOS ENCABEZADOS OBLIGATORIOS para que pueda consumir el WEB SERVICE respectivo.

Code Block
Content-Type: application/json
Authorization: OAuth f2a9ec34-cf83-46f5-8862-f78ac03670d1!171380a787a9152688ab61a94d66e0eb77...
GENEXUS-AGENT: SmartDevice Application
Warning

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.

Live Search
spaceKeyDOC
placeholderBúsqueda en esta Pagina
typepage

Artículos Relacionados

Filter by label (Content by label)
showLabelsfalse
max5
showSpacefalse
cqllabel in ( "informacion" , "tecnica" , "api" , "rest" , "web" , "services" , "clientes" , "encuestas" , "realizadas" ) and type = "page" and space = "DOC"

Artículos Actualizados Recientemente

Recent updates
typespage
max5
spacesDOC
themeconcise
hideHeadingtrue
Change History