get_supers: Get information about supervisors on the server

In l2nguyen/susoapir: API wrapper for Survey Solutions

Description

get_supers returns a data frame containing information about supervisor account. Due to the current limitations of the API, only supervisors that are not archived/locked appear in the output data frame. The data frame will have the following columns:

• SuperName: Username of supervisor

• SuperId: Unique ID of supervisor

• IsLocked: If supervisor is currently locked/archived

• CreationDate: Date the supervisor account was created

• DeviceId: Unique Id of the tablet that the user was using on the last synchronisation to server. If the user has never synced any data with the server using a tablet, this variable will be null.

Usage

get_supers(server = NULL, user = NULL, password = NULL)

Arguments

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

A data frame data frame containining information about supervisor accounts.

Examples

## Not run: 
get_supers(server = "lfs2018", user = "APIuser2018", password = "SafePassword123")

## End(Not run)

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