ls_call: Call LimeSurvey API Directly

Description Usage Arguments Details Value See Also Examples

View source: R/limesurvey.R

Description

General function used internally by every other ls_ fellow. Useful when you want something special that is not (yet) implemented in reschola.

Usage

1
ls_call(method, params = list())

Arguments

method

character, a method supported by LimeSurvey API.

params

list, arguments of the method. Need to be in order stated in documentation. Note that sSessionKey auth credentials are already provided as the first entry of params list.

Details

The list of available LimeSurvey API calls briefly documents the functionality provided. You must strictly adhere to the arguments positions, as they are passed as an array.

Value

A tibble, or raw object if server response cannot be reasonably coerced to a tibble.

See Also

Other LimeSurvey functions: ls_add_participants(), ls_export(), ls_get_attrs(), ls_invite(), ls_login(), ls_participants(), ls_responses(), ls_set_participant_properties(), ls_surveys()

Examples

1
2
3
4
## Not run: 
ls_call("get_survey_properties", params = list(iSurveyID = 123456))

## End(Not run)

scholaempirica/reschola documentation built on Jan. 22, 2022, 2 p.m.