Survey Solutions API call for User Creation — suso

Creates Survey Solutions users (observers, interviewers or supervisors).

Usage

suso_createUSER(
  userlist = NULL,
  server = suso_get_api_key("susoServer"),
  apiUser = suso_get_api_key("susoUser"),
  apiPass = suso_get_api_key("susoPass"),
  workspace = NULL,
  token = NULL,
  showUser = T
)

Arguments

userlist: dataframe with upload data
server: Survey Solutions server address
apiUser: Survey Solutions API user
apiPass: Survey Solutions API password
workspace: server workspace, if nothing provided, defaults to primary
token: If Survey Solutions server token is provided apiUser and apiPass will be ignored
showUser: userName in console

Details

Dataframe needs to be provided with the mandatory columns for user creation which are: Role, UserName, Password and Supervisor (in case of interviewer), optional you can also provide FullName, PhoneNumber and Email. Return value is a data.table, which includes the user information as well as the response's status code. Important is also that the UserName and Password are provided in the required format.