Get survey properties

Get properties of a survey. All internal properties of a survey are available.

lsGetSurveyProperties(
  surveyID,
  properties = NULL,
  lsAPIurl = getOption("lsAPIurl"),
  sessionKey = NULL
)

Arguments

surveyID	ID of the survey
properties	(optional) A vector with the particular property names to request, otherwise get all settings
lsAPIurl	(optional) The URL of the LimeSurvey RemoteControl 2 JSON-RPC API
sessionKey	(optional) Authentication token, see lsGetSessionKey()

Value

A list of survey properties or a single property

References

• https://api.limesurvey.org/classes/remotecontrol_handle.html#method_get_survey_properties

• https://api.limesurvey.org/classes/Survey.html (for a list of available properties)

Examples

if (FALSE) {
  lsGetSurveyProperties("123456")
  lsGetSurveyProperties("123456", properties = list("anonymized"))
  lsGetSurveyProperties("123456", properties = list("adminemail",
                                                    "anonymized"))
}