suso_assignWorkspace: Survey Solutions API call to assign workspace

In michael-cw/SurveySolutionsAPI: Comprehensive API access to your Survey Solutions Server

Survey Solutions API call to assign workspace

Description

suso_assignWorkspace Allows you to assign a workspace to a specific user. For more details please read https://docs.mysurvey.solutions/headquarters/accounts/workspaces/. To run this command you require admin credentials.

Usage

suso_assignWorkspace(
  server = suso_get_api_key("susoServer"),
  apiUser = suso_get_api_key("susoUser"),
  apiPass = suso_get_api_key("susoPass"),
  token = NULL,
  assign_workspace = NULL,
  your_workspace = NULL,
  uid = NULL,
  sv_id = NULL
)

Arguments

server	Survey Solutions server address
apiUser	Survey Solutions ADMIN user
apiPass	Survey Solutions ADMIN password
token	If Survey Solutions server token is provided apiUser and apiPass will be ignored
assign_workspace	The workspace which you want to assign to the new user
your_workspace	The workspace the API user has currently access to.
uid	The User ID of the user to be assigned.
sv_id	The supervisor's ID to which the interviewer should be assigned to, if it is a supervisor who is assigned, just use the same as in uid.

Details

Be aware, that for using this call you require admin credentials, and not the regular API user credentials.

Value

If succesfull, returns a data.table with the details as well as the Status message "Worspaces list updated".

Examples

## Not run: 
# Use Admin Credentials!
suso_assignWorkspace(
          your_workspace = "myworkspace",
          assign_workspace = "myworkspace1",
          uid = "xxx-xxx-xxx-xxx-xxx",
          sv_id = "xxx-xxx-xxx-xxx-xxx",
          apiUser = "xxxxxx",
          apiPass = "xxxxxx")

## End(Not run)

michael-cw/SurveySolutionsAPI documentation built on Jan. 14, 2024, 2:58 a.m.