check_assignment_audio: Gets status of audio recording for provided assignment

View source: R/assignments.R

check_assignment_audioR Documentation

Gets status of audio recording for provided assignment

Description

Informs whether audio audit is enabled for the target assignment. Wrapper for GET ​/api​/v1​/assignments​/{id}​/recordAudio endpoint

Usage

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

Arguments

id

Assignment ID number

server

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

API user name

password

API password

Value

Data frame with ⁠id' and ⁠Enabledcolumns.EnabledisTRUE⁠if audio is enabled;⁠FALSE⁠if not enabled;⁠NA' if the request fails for any reason.


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