assign_interview_to_int: Reassign interview to interviewer

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

Reassign interview to interviewer

Description

Has the server-side side-effect of reassigning a single interview to a target interviewer. For interactive use, prints a message to describe the outcome of the action. If verbose = TRUE, returns a logical value about the outcome that may be useful for functions that need to track successes and failures.

Usage

assign_interview_to_int(
  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. User ID. GUID from server.
user_name	Character. User name of target interviewer.
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}/assign 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.