ES
Español
English
Português
Obtener Respuestas de Encuesta
Este endpoint retorna la definición de una encuesta (preguntas y opciones de respuesta), la información general de la encuesta y, opcionalmente, las respuestas registradas por el usuario que la respondió. La encuesta se identifica mediante su token, obtenido a través del endpoint Obtener Tokens de Encuesta.
Detalles de la petición
- URL Base: {host}/ASMSAPI/
- Uri: /api/v9/survey/response/?token={token}
- Tipo: POST
-
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/survey/response/?token={token}
Parámetros
| Nombre | Tipo de dato | Obligatorio | Descripción |
|---|---|---|---|
| token | Texto | Si | Token de la encuesta a consultar, obtenido mediante Obtener Tokens de Encuesta |
Cuerpo de la petición
true
Respuesta
{
"Answers": [
{
"Id": 90,
"QuestionId": 7,
"ResponseChoiceId": 3,
"ResponseValue": null,
"token": "1077a718-fb20-463e-94d4-8581362269c9"
},
{
"Id": 92,
"QuestionId": 11,
"ResponseChoiceId": 0,
"ResponseValue": "Todo ok",
"token": "1077a718-fb20-463e-94d4-8581362269c9"
}
],
"DataConcept": "10920",
"Questions": [
{
"CreatedBy": 1,
"CreationDate": "/Date(1680215420753+0000)/",
"HelpText": "¿Esta de acuerdo con la solución del caso?",
"Id": 7,
"IsDeleted": false,
"IsIncludedToReport": false,
"IsJustificationMandatory": false,
"IsJustificationRequired": false,
"IsMandatory": false,
"JustificationLabel": null,
"MaxValue": 0,
"ModificationDate": null,
"ModifiedBy": 1,
"QuestionOrder": 1,
"QuestionTypeCode": 3,
"QuestionTypeId": 3,
"ResponseChoices": [
{
"Id": 3,
"IsChoiceMandatory": false,
"QuestionId": 7,
"ResponseOrder": 0,
"Text": "Si"
},
{
"Id": 4,
"IsChoiceMandatory": false,
"QuestionId": 7,
"ResponseOrder": 0,
"Text": "No"
}
],
"SurveyId": 3,
"Title": "¿Esta de acuerdo con la solución del caso?"
}
],
"Survey": {
"ApplicationId": 13,
"CategoryId": 8,
"CompanyId": null,
"ConceptId": null,
"CreatedBy": 1,
"CreationDate": "/Date(1680215311867+0000)/",
"DeactivationReason": null,
"Description": "Encuestas RQ",
"EndDate": null,
"ExitPage": null,
"Id": 3,
"IsActive": true,
"IsAnswered": true,
"IsDefaultSatisfactionLevel": false,
"ModificationDate": "/Date(1753289971717+0000)/",
"ModifiedBy": 1,
"Name": "Encuestas RQ",
"Observations": null,
"ProjectId": null,
"Questions": null,
"SatisfactionLevel": null,
"StartDate": null,
"Status": 2,
"Title": "Encuestas RQ"
}
}
Parámetros de respuesta
| Nombre | Tipo de dato | Descripción |
|---|---|---|
| Answers | Lista | Listado de respuestas registradas por el usuario para la encuesta |
| DataConcept | Texto | Identificador del caso (item) sobre el cual se respondió la encuesta |
| Questions | Lista | Listado de preguntas que componen la encuesta |
| Survey | Objeto | Información general de la encuesta |
Answers
| Nombre | Tipo de dato | Descripción |
|---|---|---|
| Id | Número | Identificador de la respuesta |
| QuestionId | Número | Identificador de la pregunta asociada a la respuesta |
| ResponseChoiceId | Número | Identificador de la opción de respuesta seleccionada (aplica en preguntas de selección) |
| ResponseValue | Texto | Valor de la respuesta como texto libre (aplica en preguntas que no son de selección) |
| token | Texto | Token de la encuesta |
Questions
| Nombre | Tipo de dato | Descripción |
|---|---|---|
| Id | Número | Identificador de la pregunta |
| HelpText | Texto | Texto de la pregunta |
| Title | Texto | Título de la pregunta |
| QuestionOrder | Número | Orden de la pregunta dentro de la encuesta |
| QuestionTypeId | Número | Identificador del tipo de pregunta |
| QuestionTypeCode | Número | Código del tipo de pregunta |
| SurveyId | Número | Identificador de la encuesta a la que pertenece la pregunta |
| ResponseChoices | Lista | Listado de opciones de respuesta disponibles para la pregunta (ver más abajo) |
| IsMandatory | Booleano | Indica si la pregunta es obligatoria |
| IsJustificationRequired | Booleano | Indica si la pregunta requiere justificación |
| IsJustificationMandatory | Booleano | Indica si la justificación de la pregunta es obligatoria |
| JustificationLabel | Texto | Etiqueta mostrada para el campo de justificación |
| IsIncludedToReport | Booleano | Indica si la pregunta se incluye en los reportes |
| IsDeleted | Booleano | Indica si la pregunta fue eliminada |
| MaxValue | Número | Valor máximo permitido para la respuesta, según el tipo de pregunta |
| CreatedBy | Número | Identificador del usuario que creó la pregunta |
| ModifiedBy | Número | Identificador del usuario que modificó la pregunta |
| CreationDate | Número (Tiempo UNIX en milisegundos) | Fecha de creación de la pregunta |
| ModificationDate | Número (Tiempo UNIX en milisegundos) | Fecha de última modificación de la pregunta |
ResponseChoices
| Nombre | Tipo de dato | Descripción |
|---|---|---|
| Id | Número | Identificador de la opción de respuesta |
| QuestionId | Número | Identificador de la pregunta a la que pertenece la opción |
| Text | Texto | Texto de la opción de respuesta |
| ResponseOrder | Número | Orden de la opción dentro de la pregunta |
| IsChoiceMandatory | Booleano | Indica si seleccionar esta opción exige una justificación |
Survey
| Nombre | Tipo de dato | Descripción |
|---|---|---|
| Id | Número | Identificador de la encuesta |
| Name | Texto | Nombre de la encuesta |
| Title | Texto | Título de la encuesta |
| Description | Texto | Descripción de la encuesta |
| IsActive | Booleano | Indica si la encuesta está activa |
| IsAnswered | Booleano | Indica si la encuesta ya fue respondida |
| Status | Número | Identificador del estado de la encuesta |
| ApplicationId | Número | Identificador de la aplicación a la que pertenece la encuesta |
| CategoryId | Número | Identificador de la categoría de la encuesta |
| CompanyId | Número | Identificador de la compañía asociada a la encuesta, si aplica |
| ConceptId | Número | Identificador del concepto asociado a la encuesta, si aplica |
| ProjectId | Número | Identificador del proyecto asociado a la encuesta, si aplica |
| IsDefaultSatisfactionLevel | Booleano | Indica si la encuesta usa el nivel de satisfacción por defecto |
| SatisfactionLevel | Número | Nivel de satisfacción configurado para la encuesta, si aplica |
| Observations | Texto | Observaciones registradas sobre la encuesta |
| ExitPage | Texto | URL de redirección al finalizar la encuesta, si está configurada |
| StartDate | Número (Tiempo UNIX en milisegundos) | Fecha de inicio de vigencia de la encuesta |
| EndDate | Número (Tiempo UNIX en milisegundos) | Fecha de fin de vigencia de la encuesta |
| DeactivationReason | Texto | Motivo de desactivación de la encuesta, si aplica |
| CreatedBy | Número | Identificador del usuario que creó la encuesta |
| ModifiedBy | Número | Identificador del usuario que modificó la encuesta |
| CreationDate | Número (Tiempo UNIX en milisegundos) | Fecha de creación de la encuesta |
| ModificationDate | Número (Tiempo UNIX en milisegundos) | Fecha de última modificación de la encuesta |
| Questions | Lista | No se puebla en esta respuesta (las preguntas se retornan en el nivel raíz Questions) |
Mensajes de error
| Código | Estado HTTP | Mensaje de error |
|---|---|---|
| 400 | BadRequest | ERROR_GETTING_SURVEY (token inexistente o inválido) |
| 400 | BadRequest | EmptyValue - \r\nParameter name: token (no se envió el token) |
| 400 | BadRequest | SURVEY_HAS_ALREADY_BEEN_ANSWERED (se envió false como cuerpo y la encuesta ya fue respondida) |