Versions Compared

Old Version 5

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

Saved on

compared with

New Version 6

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 macroswagger: '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:

DESCRIPCIÓN.

Este Web Service, permite consultar las Encuestas Realizadas a los Clientes registrados en la Aplicación SIFCO WEB, obteniendo una descripción detallada de la misma tanto a nivel de preguntas, como de respuestas obtenidas de los clientes, y indicadores de valor obtenidos en la encuesta.

Swagger open api macro
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 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"
        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_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: Código de Error
        type: "string"

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


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

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


    x-gx-level: "GxJsonError"

EJEMPLOS DE REQUEST Y RESPONSE, PARA LOS SERVICIOS RESTful BAJO PROTOCOLO HTTP.

A continuación se muestra una tabla con un ejemplo de una Solicitud y un Respuesta para este Web Service.

METODO GET

Este método para este Web Service en especifico permite consultar las Encuestas Realizadas a los Clientes registrados en la Aplicación SIFCO WEB.

El siguiente ejemplo permite consultar la encuesta realizada a un Cliente registrado en la en la Aplicación SIFCO WEB.

Tipo de Mensaje HTTP

Ejemplo

REQUEST

URL:

Code Block
languagehtml
https://test.sifco.org/democoopgt/rest/ppi_encuestarealizadas/20

HEADERS

Code Block
languagejson
content-type: application/json
authorization: OAuth f2a9ec34-cf83-46f5-8862-f78........
genexus-agent: SmartDevice Application

200 (Successful operation)

Operación Exitosa

Code Block
languagejson
{
  "PPI_EncuestaCorrelativo": 20,
  "PPI_EncuestaID": 3,
  "PPI_EncuestaEstado": true,
  "PPI_Cliente": 0,
  "PPI_ClienteActivo": true,
  "PPI_ClienteCiclo": 0,
  "PPI_EncuestaFechaRealizada": "2019-09-30",
  "PPI_EncuestaEncuestador": "string",
  "PPI_EncuestaOperador": "string",
  "PPI_EncuestaFechaOperacion": "2019-09-30T01:00:13.693Z",
  "PPI_EncuestaUltimoOperador": "string",
  "PPI_EncuestaFechaSupervision": "2019-09-30T01:00:13.693Z",
  "PPI_EncuestaRealizadaScore": 0,
  "PPI_EncuestaRealizadaEstado": true,
  "PPI_EncuestaSupervisor": "string",
  "gx_md5_hash": "string",
  "EncuestaRealizadaPreguntas": {
    "PPI_EncuestaPreguntaID": 0,
    "PPI_EncuestaPreguntaTexto": "string",
    "PPI_EncuestaPreguntaObligatoria": true,
    "PPI_EncuestaPreguntaTipo": 0,
    "PPI_EncuestaRealizadaRespuesta": "string",
    "PPI_EncuestaRealizadaRespTxt": "string",
    "PPI_EncuestaRealizadaRespFecha": "2019-09-30",
    "PPI_EncuestaRealizadaRespMonto": 0,
    "PPI_EncuestaRealizadaRespCantidad": 0,
    "PPI_EncuestaRealizadaPreguntaScore": 0,
    "PPI_EncuestaRespuestaScoreOriginal": 0
  },
  "EncuestaIndicadores": {
    "PPI_IndicadorID": 0,
    "PPI_Indicador": "string",
    "PPI_EncuestaRealizadaIndicadorValor": 0
  }
}

400 (Bad Request).

Solicitud Errada

Code Block
languagejson
{
  "error": {
    "code": "string",
    "message": "string"
  }
}

401 (This service needs an Authorization Header)

(No Autenticado, asociado normalmente a que no se respetaron las cabeceras obligatorias para el consumo de este Web Service, para mayores detalles consultar (Configuración de Seguridad para Obtener Token de Acceso y Consumir de los Web Services) ).

Code Block
languagejson
{
  "error": {
    "code":"0",
    "message":"This service needs an Authorization Header"
  }
}

404 (Not Found).

Respuesta Vacía (Web Service, no encontrado)

500 (Internal Server Error)

(Error Interno del Servidor de las API’s REST).

Code Block
languagejson
{
  "error": {
    "code": "string",
    "message": "string"
  }
}
Info

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.

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
languagejson
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