suso_patchApproveInterview: Approve interviews either as supervisor or as headquarter.

In michael-cw/SurveySolutionsAPI: Comprehensive API access to your Survey Solutions Server

Approve interviews either as supervisor or as headquarter.

Description

Allows you to approve interviews in supervisor or headquarters role as well as to provide a comment (i.e. reason) for the approval.

Usage

suso_patchApproveInterview(
  server = suso_get_api_key("susoServer"),
  apiUser = suso_get_api_key("susoUser"),
  apiPass = suso_get_api_key("susoPass"),
  workspace = NULL,
  token = NULL,
  intID = "",
  HQ = FALSE,
  comment = "Well done!"
)

Arguments

server	Survey Solutions server address
apiUser	Survey Solutions API user
apiPass	Survey Solutions API password
workspace	server workspace, if nothing provided, defaults to primary
token	If Survey Solutions server token is provided apiUser and apiPass will be ignored
intID	the InterviewId of the interview.
HQ	if FALSE, approve as supervisor, if TRUE rejected as headquarters
comment	comment which should be sent with the questionnaire

Details

For details please see: https://docs.mysurvey.solutions/headquarters/interviews/survey-workflow/

Examples

## Not run: 
# approve the interview as supervisor
suso_patchApproveInterview(
          workspace = "myworkspace",
          intID = "dee7705f-d611-4b12-9b97-2b8e5b80c4ea"
          )
# approve the interview as headquarters
suso_patchApproveInterview(
          workspace = "myworkspace",
          intID = "dee7705f-d611-4b12-9b97-2b8e5b80c4ea",
          HQ = TRUE
          )
# approve the interview and provide a comment
suso_patchApproveInterview(
          workspace = "myworkspace",
          intID = "dee7705f-d611-4b12-9b97-2b8e5b80c4ea",
          comment = "Well done!"
          )


## End(Not run)

michael-cw/SurveySolutionsAPI documentation built on Jan. 14, 2024, 2:58 a.m.