Skip to contents

Archive an assignment

Source: R/assignments.R
archive_assignment.Rd

Wrapper for PATCH /api/v1/assignments/{id}/archive endpoint

Usage

archive_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. 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

API user name

password

API password

Value

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