suso_getQuestDetails: Survey Solutions API call for questionnaire

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

Survey Solutions API call for questionnaire

Description

suso_getQuestDetails implements all Questionnaire related API commands. It allows for different operation types, see details bellow for further clarification.

Usage

suso_getQuestDetails(
  server = suso_get_api_key("susoServer"),
  usr = suso_get_api_key("susoUser"),
  pass = suso_get_api_key("susoPass"),
  workspace = NULL,
  token = NULL,
  quid = NULL,
  version = NULL,
  operation.type = c("list", "statuses", "structure", "interviews")
)

Arguments

server	Survey Solutions server address
usr	Survey Solutions API user
pass	Survey Solutions API password
workspace	server workspace, if nothing provided, defaults to primary
token	If Survey Solutions server token is provided usr and pass will be ignored
quid	QuestionnaireId for which details should be exported
version	questionnaire version
operation.type	if list is specified a list of all questionnaires on the server. If statuses a vector of all questionnaire statuses. If structure is specified, it returns a list containing all questions, rosters etc. of the specific questionnaire, as well as all validations. If interviews is specified, all interviews for a specific questionnaire. See details bellow.

Details

If list is selected, then list of questionnaires is returned.

If statuses is selected, a list of all available questionnaire statuses is returned (deprecated).

In case structure is chosen the return value is a list with two data.table elements:

• List element q contains all questions, rosters etc.

• List element val contains all validations

In this way it is straightforward to use the returen value for questionnaire manuals and the likes.

In case interviews is selected, a list of all interviews for the specific questionnaire is returned.

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