start_export: Start export of the data for a questionnaire

In l2nguyen/susoapir: API wrapper for Survey Solutions

Description

start_export starts the export of a version of a questionnaire for a specified data type

Usage

start_export(
  qx_name = NULL,
  template_id = NULL,
  version = NULL,
  export_type = "tabular",
  return_time = FALSE,
  server = NULL,
  user = NULL,
  password = NULL
)

Arguments

qx_name	Name of questionnaire. This is case sensitive and should match the name of your questionnaire exactly. Do not specify both template_id and qx_name.
template_id	Questionnaire Id for the template. Do not include any dashes. Do not specify both template_id and qx_name.
version	Version number of questionnaire
export_type	Data type to export. Valid options are: tablular, stata, spss, binary, paradata. Default is tabular.
return_time	Option to return the time that the export was started. Start time will be in UTC.
server	Prefix for the survey server. It is whatever comes before mysurvey.solutions: [prefix].mysurvey.solutions.
user	Username for the API user on the server.
password	Password for the API user on the server.

Value

Starts the export for the questionnaire.

Examples

## Not run: 
start_time <- start_export(qx_name="Labour Force Survey Q1",
version=4, start_time=TRUE,
server = "lfs2018", user = "APIuser2018", password = "SafePassword123")

## End(Not run)

l2nguyen/susoapir documentation built on Jan. 14, 2020, 2:29 p.m.