ls_login: Login to LimeSurvey API

In scholaempirica/reschola: The Schola Empirica Package

Login to LimeSurvey API

Description

Obtains XML-RPC/JSON-RPC session key and stores it in dedicated environment for further use by fellow ls_ functions.

Usage

ls_login(
  api_url =
    "https://dotazniky.scholaempirica.org/limesurvey/index.php/admin/remotecontrol"
)

Arguments

api_url

character, URL of the API endpoint, default to SCHOLA EMPIRICA's LimeSurvey API.

Details

By default, https://dotazniky.scholaempirica.org/ is used as the LimeSurvey server prividing the API. The credentials used for user authentication are obtained through interactive prompts, mainly for security reasons. The function tries to obtain the credentials from the system environment variable table first. If none found, the user is asked for them and is provided with guidance for permanent credential storage.

Value

No "explicit" return value, but assigns the session key to a dedicated environment.

See Also

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

Examples

## Not run: 
ls_login()

## End(Not run)

scholaempirica/reschola documentation built on Oct. 16, 2024, 6:43 a.m.