assign_interview_to_sup: Reassign an interview to a supervisor

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

Reassign an interview to a supervisor

Description

Has the server-side side-effect of reassigning a single interview to a supervisor. For interactive use, prints a message about the outcome. For programmatic use, if verbose = TRUE, returns a logical value about whether interview successfully assigned, which may be useful for functionst that need to track success and failure of operations.

Usage

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

Arguments

interview_id	Character. Interview ID. GUID from server or interview__id from exported data
user_id	Character. ID of target user. GUID from server.
user_name	Character. User name of target user.
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 interviews to get. In workspace list, value of NAME, not DISPLAY NAME, for the target workspace.
user	Character. API user name
password	Character. API password

Details

Wrapper for PATCH ​/api​/v1​/interviews​/{id}​/assignsupervisor endpoint

Value

If verbose = FALSE, no return value. If verbose = TRUE, return logical outcome.

arthur-shaw/susoapi documentation built on Feb. 10, 2023, 7:47 p.m.