ES
Español
English
Português
    Obtener Tokens de Encuesta

    Este endpoint retorna el listado de encuestas (y sus tokens) asociadas a un caso específico. El token obtenido se utiliza posteriormente para consultar las respuestas de cada encuesta mediante el endpoint Obtener Respuestas de Encuesta.

    Detalles de la petición

    • URL Base: {host}/ASMSAPI/
    • Uri: /api/v9/item/{itemId}/{itemType}/surveys/answered
    • Tipo: GET
    • Encabezados requeridos:

      • content-type: application/json
      • X-Authorization: Bearer {token}

    Descripción de la URL

    • {host}: Representa el dominio del ambiente en el que se encuentra la API.
    • ASMSAPI/: Prefijo fijo de la API.
    • Uri: Endpoint específico para la petición.


    ⚐ EJEMPLO URL:

    https://{host}/ASMSAPI/api/v9/item/{itemId}/{itemType}/surveys/answered
    


    Parámetros

    Nombre Tipo de dato Obligatorio Descripción
    itemId Número Si Identificador del caso sobre el cual se consultan las encuestas
    itemType Número Si Identificador del tipo de caso - Incidente = 1 - Problema = 2 - Cambio = 3 - Requerimiento de servicio = 4 - Liberación = 13

    Cuerpo de la petición

    N/A

    Ejemplos de uri

    • api/v9/item/10920/4/surveys/answered

    Respuesta

    {
    
          "count": 2,
    
          "list": [
    
                {
    
                      "description": "Encuestas RQ",
    
                      "id": 3,
    
                      "name": "Encuestas RQ",
    
                      "title": "Encuestas RQ",
    
                      "token": "1077a718-fb20-463e-94d4-8581362269c9"
    
                },
    
                {
    
                      "description": "Encuestas RQ 2",
    
                      "id": 17,
    
                      "name": "Encuestas RQ 2",
    
                      "title": "Encuestas RQ 2",
    
                      "token": "b0f298f8-0766-40c0-b147-cfcef8cfb65e"
    
                }
    
          ],
    
          "result": true
    
    }
    

    ⚐ Nota: Si el caso no tiene encuestas asociadas (o el itemId no existe), la respuesta es 200 OK con {"count":0,"list":null,"result":false}.

    Parámetros de respuesta

    Nombre Tipo de dato Descripción
    count Número Cantidad de encuestas asociadas al caso
    list Lista Listado de encuestas asociadas al caso. Es null cuando no hay encuestas asociadas
    id Número Identificador de la encuesta
    name Texto Nombre de la encuesta
    description Texto Descripción de la encuesta
    title Texto Título de la encuesta
    token Texto Token único de la encuesta; se usa para consultar sus respuestas mediante Obtener Respuestas de Encuesta
    result Booleano Indica si se encontraron encuestas asociadas al caso

    Mensajes de error

    Código Estado HTTP Mensaje de error
    400 BadRequest FailureHasSurvey - \r\nParameter name: itemType