set_questionnaire_audio: Enable audio recording for questionnaire

In arthur-shaw/susoapi: Interface for Survey Solutions' APIs

Enable audio recording for questionnaire

Description

Sets audio recording enabled setting for provided questionnaire. Wrapper of POST /api/v1/questionnaires/{id}/{version}/recordAudio endpoint

Usage

set_questionnaire_audio(
  qnr_id,
  qnr_version,
  enable,
  server = Sys.getenv("SUSO_SERVER"),
  workspace = Sys.getenv("SUSO_WORKSPACE"),
  user = Sys.getenv("SUSO_USER"),
  password = Sys.getenv("SUSO_PASSWORD")
)

Arguments

qnr_id	Character. Questionnaire ID. GUID from server.
qnr_version	Numeric. Questionnaire version number.
enable	Logical. Whether to enable. Values: c(TRUE, FALSE)
server	Character. Full server web address (e.g., https://demo.mysurvey.solutions, https://my.domain)
workspace	Character. Name of the workspace whose questionnaire audio settings to change. In workspace list, value of NAME, not ⁠DISPLAY NAME⁠, for the target workspace.
user	Character. API user name
password	Character. API password

Value

TRUE/FALSE depending on whether operation succeeded or not.

arthur-shaw/susoapi documentation built on Oct. 15, 2024, 3:44 a.m.