get_interviews_for_questionnaire: Get list of interviews for questionnaire-version

View source: R/questionnaires.R

get_interviews_for_questionnaireR Documentation

Get list of interviews for questionnaire-version

Description

GraphQL implmentation for deprecated REST GET /api/v1/questionnaires/{id}/{version}/interviews endpoint

Usage

get_interviews_for_questionnaire(
  chunk_size = 100,
  qnr_id,
  qnr_version,
  server = Sys.getenv("SUSO_SERVER"),
  workspace = Sys.getenv("SUSO_WORKSPACE"),
  user = Sys.getenv("SUSO_USER"),
  password = Sys.getenv("SUSO_PASSWORD")
)

Arguments

chunk_size

Numeric. Number of records to take in one request.

qnr_id

Character. Questionnaire ID. GUID from server.

qnr_version

Numeric. Questionnaire version number.

server

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

workspace

Character. Name of the workspace whose questionnaires and associated 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

Data frame of interviews.


arthur-shaw/susoapi documentation built on Feb. 10, 2023, 7:47 p.m.