Respond to a survey

Módulo Workforce

POST/surveys/{id}/respondsurveys.respond

Responds once with answers keyed by question id. Anonymous answers carry no respondent. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.

Requiere la capacidad knowledge.sop.acknowledge.
Alcances de OAuth: knowledge.
Envía el encabezado Idempotency-Key. Una repetición con la misma clave devuelve la respuesta original.
Estados de error: 400, 401, 404, 409, 422, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

surveys.respond: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the survey.

Cuerpo de la solicitud: SurveyResponseRequest

surveys.respond: SurveyResponseRequest
Campo	Tipo	Obligatorio	Descripción
answers	object	Sí	Answers keyed by question id.

{
  "answers": {
    "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f": 4
  }
}

Respuesta 200: SurveyResponseResult

surveys.respond: SurveyResponseResult
Campo	Tipo	Obligatorio	Descripción
response_id	string (uuid) \| null	Sí	The response, or null for an anonymous survey.

{
  "response_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/surveys/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/respond" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"answers":{"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f":4}}'

const { data } = await xos.surveys.respond("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "answers": {
      "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f": 4
    }
  });

response = xos.surveys.respond("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"answers": {"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f": 4}})

xos surveys respond 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"answers":{"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f":4}}'