Skip to contents

Has server-side side-effect of unapproving a single interview, returningn it to Approved by Headquarters status. 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

unapprove_interview(
  interview_id,
  comment = "",
  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

comment

Character. Comment to post upon unapproval

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

Value

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

Details

Wrapper for PATCH /api/v1/interviews/{id}/hqunapprove endpoint