Skip to contents

Save JSON representation of the questionnaire

Source: R/questionnaires.R
get_questionnaire_document.Rd

Fetches JSON representation of the questionnaire. Save it to disk. Wrapper for GET ​/api​/v1​/questionnaires​/{id}​/{version}​/document endpoint

Usage

get_questionnaire_document(
  qnr_id,
  qnr_version,
  path,
  server = Sys.getenv("SUSO_SERVER"),
  workspace = Sys.getenv("SUSO_WORKSPACE"),
  user = Sys.getenv("SUSO_USER"),
  password = Sys.getenv("SUSO_PASSWORD")
)

Arguments

qnr_id

Character. Questionnaire ID. GUID from server

qnr_version

Numeric. Version number of questionnaire

path

Character. Directory where export JSON representation of the questionnaire should be downloaded

server

Character. Full server web address (e.g., https://demo.mysurvey.solutions, https://my.domain)

workspace

Character. Name of the workspace whose questionnaire document to get. In workspace list, value of NAME, not DISPLAY NAME, for the target workspace.

user

Character. API user name

password

Character. API password