Skip to contents

Has server-side side-effect of rejecting a single interview as Headquarters. If verbose = TRUE, return logical outcome and print message.

Usage

reject_interview_as_hq(
  interview_id,
  comment = "",
  responsible_id = "",
  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 rejection.

responsible_id

Character. User ID. GUID from server or interview__id from exported data. User ID of the interviewer/supervisor to which the interview should be rejected.

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}/hqreject endpoint