Close assignment — close_assignment • susoapi

Closes assignment by setting Size to the amount of collected interviews. Wrapper for PATCH /api/v1/assignments/{id}/close endpoint

Usage

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

Arguments

id: Numeric. Assignment ID number
verbose: Logical. Print whether operation was successful or not
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