Comprehensive API Access to Your 'Survey Solutions' Server Using
'httr2'
![[R logo]](../../../doc/html/Rlogo.svg)
![[Up]](../../../doc/html/left.jpg)
![[Top]](../../../doc/html/up.jpg)
Documentation for package ‘SurveySolutionsAPIv2’ version 0.1.2
Help Pages
| assignmentClass | Assignment Classes & Methods |
| boxplot_summary | S3 method to create a box plot of numeric variables for an exportClass object |
| boxplot_summary.exportClass | S3 method to create a box plot of numeric variables for an exportClass object |
| calendarevent | Create, update or delete a calendar event |
| exportClass | Export Classes & Methods |
| getinfo | assignmentClass methods |
| getinfo.assignmentClass | assignmentClass methods |
| getinfo.exportClass | assignmentClass methods |
| getinfo.UserClass | assignmentClass methods |
| is.assignmentClass | Function to check if an object is of class assignmentClass |
| is.exportClass | Function to check if an object is of class exportClass |
| is.UserClass | Function to check if an object is of class UserClass |
| summaryTable | S3 method to create a summary table of numeric variables for an exportClass object |
| summaryTable.exportClass | S3 method to create a summary table of numeric variables for an exportClass object |
| summaryTable.paradata | S3 method to create a summary table of numeric variables for an exportClass object |
| summaryTable.UserClass | S3 method to create a summary table of users for UserClass object |
| suso.options | Configuration options used for the SurveySolutionsAPIv2 package |
| suso_archUSR | Survey Solutions API call (un-) archive user |
| suso_assignInterview | Assign interview to interviewer or supervisor |
| suso_assignWorkspace | Survey Solutions API call to assign workspace (!! WORKS ONLY WITH ADMIN CREDENTIALS) |
| suso_cancelExport | Survey Solutions API call to cancel an export process |
| suso_clear_keys | Clear Credentials |
| suso_commentInterview | Leave a comment on a question in an interview |
| suso_createASS | Survey Solutions API call for Assignment Creation |
| suso_createCALEV | Create, update or delete a calendar event |
| suso_createUSER | Survey Solutions API call for User Creation |
| suso_createWorkspace | Survey Solutions API call to create workspace |
| suso_delCALEV | Create, update or delete a calendar event |
| suso_deleteInterview | Delete an interview |
| suso_deletemap | Delete Map from Server |
| suso_deleteWorkspace | Delete a workspace |
| suso_enableWorkspace | Enable or disable a workspace |
| suso_export | Survey Solutions API call to generate and download the data |
| suso_export_paradata | Export Survey Solutions paradata |
| suso_getAllAnswerInterview | Survey Solutions API call to retrieve all answers for a specific interview |
| suso_getAllHistoryInterview | Get all history for a specific interview |
| suso_getAllInterviewQuestionnaire | Survey Solutions API call to retrieve all interviews for a specific questionnaire |
| suso_getExportList | Survey Solutions API call to list export processes |
| suso_getExportProcess | Survey Solutions API call to get detailed information about an export process |
| suso_getINT | Survey Solutions API call for list of interviewers |
| suso_getInterviewPDF | Download interview PDF transcript |
| suso_getINT_info | Survey Solutions API call for info on interviewers |
| suso_getQuestDetails | Survey Solutions API call for questionnaire |
| suso_getQuestionsQuestionnaire | Survey Solutions API call for questions and responses from single questionnaire |
| suso_getStatsQuestionnaires | Survey Solutions API call for questionnaires with statistics |
| suso_getSV | Survey Solutions API call for list of supervisors |
| suso_getSV_info | Survey Solutions API call for supervisor info |
| suso_getUSR | Survey Solutions API call for info on any user |
| suso_getWorkspace | Survey Solutions API call for workspace information |
| suso_get_api_key | Get credentials |
| suso_get_assignments | Survey Solutions API call for assignment list |
| suso_get_default_key | Checks if credentials are present |
| suso_get_stats | Survey Solutions API call for Summary Tables |
| suso_get_stats_interview | Get statistics for interview |
| suso_globalNotice | Survey Solutions API call for Headquarters Global Notice settings |
| suso_keys | Survey Solutions API credentials |
| suso_mapassign | Assigns/Unassign a map to a user |
| suso_mapinfo | Receive maps currently uploaded to the server |
| suso_mapreport | Create a Map Report |
| suso_mapupload | Upload map to server |
| suso_patchApproveInterview | Approve interviews either as supervisor or as headquarter. |
| suso_patchRejectInterview | Reject interviews either as supervisor or as headquarter. |
| suso_PwCheck | Utility function to check if credentials are correct |
| suso_questCriticalityLevel | Survey Solutions API call for questionnaire criticality level setting |
| suso_questRecordAudio | Survey Solutions API call for questionnaire audio recording setting |
| suso_set_assignments | Survey Solutions API call for assignment manipulation |
| suso_set_key | Set all credentials at once |
| suso_set_maxpar_req | Convenience Function to modify the maximum number of parallel requests option |
| suso_set_prog_mess | Convenience functions to modify user notification text |
| suso_set_pwcheck_mess | Convenience functions to modify user notification text |
| suso_set_workspace | Convenience function to switch workspace |
| suso_updateCALEV | Create, update or delete a calendar event |
| suso_updateWorkspace | Update workspace details |
| UserClass | User Classes & Methods |