Man pages for arthur-shaw/susoapi
Interface for Survey Solutions' APIs

approve_interview_as_hqApprove an interview as headquarters
approve_interview_as_supApprove interview as supervisor
archive_assignmentArchive an assignment
archive_userArchives interviewer or supervisor with all his interviewers
assign_interview_to_intReassign interview to interviewer
assign_interview_to_supReassign an interview to a supervisor
assign_users_to_workspacesManager user assignment to a workspace
cancel_exportCancel export process
change_assignment_quantityChange assignment quantity
check_assignment_audioGets status of audio recording for provided assignment
check_credentialsCheck that server credentials are valid
close_assignmentClose assignment
comment_questionLeave a comment on a question
create_userCreates new user with specified role.
create_workspaceCreate a workspace
delete_global_noticeDelete the global notice
delete_interviewDelete an interview
delete_workspaceDelete a workspace
disable_workspaceDisable a workspace
enable_workspaceEnable a workspace
get_assignment_detailsGet details for a single assignment
get_assignment_historyGet assignment history
get_assignment_quantity_settingReturns whether assignment quantity can be changed or not
get_assignmentsGet all assignments
get_export_fileDownloads export file.
get_export_job_detailsGet detailed information about export process
get_export_jobsGet list of export jobs
get_global_noticeGet the global notice
get_interviewersGet list of all interviewers
get_interview_historyGet interview history
get_interviewsGet interviews
get_interviews_for_questionnaireGet list of interviews for questionnaire-version
get_interview_statsGet statistics by interview
get_interview_transcriptGet interview transcript
get_possible_interview_statusesGet possible interview statuses
get_questionnaire_documentSave JSON representation of the questionnaire
get_questionnairesGet all questionnaires
get_supervisorsGet list of all supervisors
get_user_action_logGet action log for single user
get_user_detailsGets detailed info about single user
get_workspace_detailsGet details of a single workspace
get_workspacesGet list of workspaces
get_workspace_statusGet detailed workspace status
reassign_assignmentReassign assignment to another user
reject_interview_as_hqReject an interview as headquarters
reject_interview_as_supReject an interview as supervisor
set_assignment_audioSet whether assignment will record audio or not
set_credentialsSet server credentials
set_global_noticeSet the global notice
set_questionnaire_audioEnable audio recording for questionnaire
show_credentialsShow saved server credentials
start_exportStart export file creation
unapprove_interviewUnapprove an interview
unarchive_assignmentUnarchive an assignment
unarchive_userUnarchives single user
update_workspaceUpdate workspace
arthur-shaw/susoapi documentation built on Feb. 10, 2023, 7:47 p.m.