Function reference • susoapi

Authentication

Functions for setting up and checking details for connecting with a Survey Solutions server

set_credentials(): Set server credentials

show_credentials(): Show saved server credentials

check_credentials(): Check that server credentials are valid

Workspaces

Functions for taking actions on workspaces, including assigning users to them

Get info

get_workspaces(): Get list of workspaces

get_workspace_details(): Get details of a single workspace

get_workspace_status(): Get detailed workspace status

Modify

create_workspace(): Create a workspace

update_workspace(): Update workspace

delete_workspace(): Delete a workspace

disable_workspace(): Disable a workspace

enable_workspace(): Enable a workspace

assign_users_to_workspaces(): Manager user assignment to a workspace

Questionnaires

Functions for compiling them, getting associated interviews, setting options, and getting their JSON respresentation.

get_questionnaires(): Get all questionnaires

get_interviews_for_questionnaire(): Get list of interviews for questionnaire-version

get_questionnaire_document(): Save JSON representation of the questionnaire

set_questionnaire_audio(): Enable audio recording for questionnaire

Interviews

Functions for approving, assigning, rejecting, and reviewing interviews.

Approve

approve_interview_as_sup(): Approve interview as supervisor

approve_interview_as_hq(): Approve an interview as headquarters

Assign

assign_interview_to_int(): Reassign interview to interviewer

assign_interview_to_sup(): Reassign an interview to a supervisor

Reject

reject_interview_as_sup(): Reject an interview as supervisor

reject_interview_as_hq(): Reject an interview as headquarters

unapprove_interview(): Unapprove an interview

comment_question(): Leave a comment on a question

Review

get_interviews(): Get interviews

get_interview_stats(): Get statistics by interview

get_interview_history(): Get interview history

get_interview_transcript(): Get interview transcript

Remove

delete_interview(): Delete an interview

Info

get_possible_interview_statuses(): Get possible interview statuses

Assignments

Functions for creating, inspecting, collecting, modifying, and adjusting the audio of assignments

Inspect

get_assignment_details(): Get details for a single assignment

get_assignment_history(): Get assignment history

Collect

get_assignments(): Get all assignments

Modify

archive_assignment(): Archive an assignment

unarchive_assignment(): Unarchive an assignment

close_assignment(): Close assignment

get_assignment_quantity_setting(): Returns whether assignment quantity can be changed or not

change_assignment_quantity(): Change assignment quantity

reassign_assignment(): Reassign assignment to another user

Adjust audio

check_assignment_audio(): Gets status of audio recording for provided assignment

set_assignment_audio(): Set whether assignment will record audio or not

Users

Functions for collecting, modifying, and monitoring supervisor and interviewer users

Collect

get_supervisors(): Get list of all supervisors

get_interviewers(): Get list of all interviewers

Modify

create_user(): Creates new user with specified role.

archive_user(): Archives interviewer or supervisor with all his interviewers

unarchive_user(): Unarchives single user

Monitor

get_user_action_log(): Get action log for single user

get_user_details(): Gets detailed info about single user

Export

Functions for exporting data: starting an export job, inquiring about its status, and downloading export files

Start, stop

start_export(): Start export file creation

cancel_export(): Cancel export process

Monitor

get_export_job_details(): Get detailed information about export process

get_export_jobs(): Get list of export jobs

Download

get_export_file(): Downloads export file.

Settings

Functions for modify the global notice (i.e., the information banner at the top of site).

set_global_notice(): Set the global notice

get_global_notice(): Get the global notice

delete_global_notice(): Delete the global notice