archive_user: Archives interviewer or supervisor with all his interviewers

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

Archives interviewer or supervisor with all his interviewers

Description

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

Usage

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

Arguments

user_id	Character. User ID. GUID from server.
verbose	Logical. If verbose == TRUE, return logical outcome and print message. Otherwise, be silent.
server	Character. Full server web address (e.g., https://demo.mysurvey.solutions, https://my.domain)
workspace	Character. Name of the workspace whose users 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

Side-effect on the server: APPROVE interview. If verbose == TRUE, return logical outcome and print message.

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