set_assignment_audio: Set whether assignment will record audio or not

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

Set whether assignment will record audio or not

Description

Wrapper for PATCH ​/api​/v1​/assignments​/{id}​/recordAudio endpoint

Usage

set_assignment_audio(
  id,
  enable,
  verbose,
  server = Sys.getenv("SUSO_SERVER"),
  workspace = Sys.getenv("SUSO_WORKSPACE"),
  user = Sys.getenv("SUSO_USER"),
  password = Sys.getenv("SUSO_PASSWORD")
)

Arguments

id	Number. Assignment ID number
enable	Logical. Whether to enable or disable audio–TRUE or FALSE, respectively
verbose	Logical. Returns information about success of operation: message and TRUE/FALSE return value.
server	Character. Full server web address (e.g., https://demo.mysurvey.solutions, https://my.domain)
workspace	Character. Name of the workspace whose assignments to get. In workspace list, value of NAME, not ⁠DISPLAY NAME⁠, for the target workspace.
user	Character. API user name
password	Character. API password

Value

If verbose = FALSE, no return value. If verbose = TRUE, return logical outcome: TRUE if succeeded; FALSE otherwise

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