Web Service Method Listing

[administrator]

A number of people have requested this information, so a list of all web service methods for the 4.5 Developer Kit release follows (I apologize for the format since this is a copy/paste job from the actual documentation, which is an MSDN-style compiled help file) :


User Management

AddGroupToGroupAccessList(Guid, Int32, Int32, array[]()[])	Add a user group to the access list for a group and give the added group the specified permissions. If the group is already on the access list, the group’s current permissions will be overwritten by the new permissions.
AddUserToGroup(Guid, String, Int32)	Add the user with the specified unique identifier to the user group.
AddUserToGroupAccessList(Guid, Int32, String, array[]()[])	Add a user to the access list for a group and give the user the specified permissions. If the user is already on the group’s access list, the user’s current permissions will be overwritten by the new permissions.
AddUserToRole(Guid, String, String)	Add a user to a security role.
AuthenticateUser(String, String)
ChangeUserPassword(Guid, String, String)	Change the specified Checkbox user's password.
CreateUser(Guid, String, String, array<(Of <(Object, Object>)>)>[]()[], Boolean)	Create a new Checkbox user with the specified identity and profile information.
CreateUserGroup(Guid, String, String)	Create a new user group with the specified name and description. If successful, the return value will be a positive integer representing the database ID of the new group. An exception is thrown if a group with the specified name already exists.
DeleteUser(Guid, String, Boolean)	Delete the specified user and associated profile information and (optionally) all responses associated with that user
DeleteUserGroup(Guid, Int32)	Delete the user group with the specified database id.
DeleteUserProfile(Guid, String)	Delete the profile information associated with a user, but not the user itself.
GetUserGroup(Guid, String)	Get a data object containing basic information about a user group.
GetUserGroupById(Guid, Int32)	Get a data object containing basic information about a user group.
GetUserIdentities(Guid, String, String)	Retrieve a list of user names matching the specified filters. If the filterField and filterValue parameters are NULL or String.Empty, all available users will be listed. Regardless of filter settings, only users in User Groups viewable by the requesting user are returned.
GetUserProfile(Guid, String)
ListGroupAccessListPermissionsForGroup(Guid, Int32, Int32)	List the permissions a specific group has on the access list for a group. An empty list is returned if the group is not on the access list.
ListGroupAccessListPermissionsForUser(Guid, Int32, String)	List the permissions a specific user has on the access list for a group. An empty list is returned if the user is not on the access list or has no configured permissions for the access list.
ListGroupDefaultPolicyPermissions(Guid, Int32)
ListUserGroupMembers(Guid, Int32)	Get an array of user names for users in a particular user group.
ListUserGroups(Guid)	Retrieve a list of user groups that the requesting has permission to view or manage. The returned UserGroupData class contains accessors for getting the database ID, name, and description of the user group.
ListUserRoles(Guid, String)	List the names of the security roles that the specified user is a member of.
RemoveGroupFromGroupAccessList(Guid, Int32, Int32)	Remove a user group from another user group's access control list.
RemoveUserFromGroup(Guid, String, Int32)	Add the user with the specified unique identifier to the user group.
RemoveUserFromGroupAccessList(Guid, Int32, String)	Remove a user from a group’s access list.
RemoveUserFromRole(Guid, String, String)	Remove a user from a given security role.
RenameUser(Guid, String, String)	Change the login name of a given user.
SetGroupDefaultPolicyPermissions(Guid, Int32, array[]()[])	Set the default policy of the user group to include the specified permissions.
UpdateUserGroup(Guid, Int32, String, String)	Update the name and description of the specified user group.
UpdateUserProfile(Guid, String, array<(Of <(Object, Object>)>)>[]()[])	Update a user's profile using the specified profile information.
UserExists(Guid, String)	Return a boolean indicating if a user with the specified name exists in Checkbox.

Survey Management

AddGroupToFolderAccessList(Guid, Int32, Int32, array[]()[])	Add a user group to the access list for a folder and give the added group the specified permissions. If the group is already on the access list, the group’s current permissions will be overwritten by the new permissions.
AddGroupToSurveyAccessList(Guid, Int32, Int32, array[]()[])	Add a user group to the access list for a survey and give the added group the specified permissions. If the group is already on the access list, the group’s current permissions will be overwritten by the new permissions.
AddUserToFolderAccessList(Guid, String, Int32, array[]()[])	Add a user to the access list for a folder and give the user the specified permissions. If the user is already on the folder’s access list, the user’s current permissions will be overwritten by the new permissions.
AddUserToSurveyAccessList(Guid, String, Int32, array[]()[])	Add a user to the access list for a survey and give the user the specified permissions. If the user is already on the survey’s access list, the user’s current permissions will be overwritten by the new permissions.
AuthenticateUser(String, String)
CopySurvey(Guid, Int32, String, String)	Copy the survey with the specified ID.
CreateFolder(Guid, String, String)	Create a new folder with the specified name and return a FolderData object representing the new folder. If a folder could not be created, a NULL value is returned.
CreateSurvey(Guid, String, String)	Create a new survey with the specified name and description.
DeleteFolder(Guid, Int32)	Delete the folder with the specified ID. Any surveys contained in the folder will be deleted as well.
DeleteSurvey(Guid, Int32)	Delete the survey with the specified Id.
GetSurveyInfoByGuid(Guid, Guid)	Get a ResponseTemplateData object for a survey with the specified GUID.
GetSurveyInfoById(Guid, Int32)	Get a ResponseTemplateData object for a survey with the specified database ID.
GetSurveyInfoByName(Guid, String)	Get a ResponseTemplateData object for a survey with the specified name.
ListFolderAccessListPermissionsForGroup(Guid, Int32, Int32)	List the permissions a specific group has on the access list for a folder. An empty list is returned if the group is not on the access list.
ListFolderAccessListPermissionsForUser(Guid, String, Int32)	List the permissions a specific user has on the access list for a folder. An empty list is returned if the user is not on the access list or has no configured permissions for the access list.
ListFolderDefaultPolicyPermissions(Guid, Int32)
ListManageableFolders(Guid)	Retrieve a list of folders that the calling principal can manage.
ListSurveyAccessListPermissionsForGroup(Guid, Int32, Int32)	List the permissions a specific group has on the access list for a survey. An empty list is returned if the group is not on the access list.
ListSurveyAccessListPermissionsForUser(Guid, String, Int32)	List the permissions a specific user has on the access list for a survey. An empty list is returned if the user is not on the access list or has no configured permissions for the access list.
ListSurveyDefaultPolicyPermissions(Guid, Int32)
ListSurveys(Guid, String, String, String)	Retrieve an array of ResponseTemplateData objects describing the surveys available to the provided login principal.
ListViewableFolders(Guid)	Retrieve a list of folders that the calling principal has permission to view the contents of.
MoveSurveyToFolder(Guid, Int32, Int32)	Move a survey into the folder with the specified id.
RemoveGroupFromFolderAccessList(Guid, Int32, Int32)	Remove a user group from a folder's access control list.
RemoveGroupFromSurveyAccessList(Guid, Int32, Int32)	Remove a user group from a survey's access control list.
RemoveUserFromFolderAccessList(Guid, String, Int32)	Remove a user from a folder’s access list.
RemoveUserFromSurveyAccessList(Guid, String, Int32)	Remove a user from a survey’s access list.
SetFolderDefaultPolicyPermissions(Guid, Int32, array[]()[])	Set the default policy of a specified folder to include the specified permissions.
SetSurveyDefaultPolicyPermissions(Guid, Int32, array[]()[])	Set the default policy of a specified survey to include the specified permissions.
SurveyWithNameExists(Guid, String)	Check if a survey with the specified name already exists. This is useful when using the API to copy surveys to prevent creating multipile surveys with the same name.
UpdateFolder(Guid, Int32, String, String)	Update the name and description of an existing folder.
UpdateSurveyProperties(Guid, ResponseTemplateData)	Update a survey's properties.

Invitation Management

InvitationManagementServiceProxy()()()
AddEmailAddressesToInvitation(Guid, Int32, array[]()[])	Add a list of email addresses directly to an invitation.
AddEmailListPanelsToInvitation(Guid, Int32, array[]()[])	Add a list of email list panels to an invitation.
AddGroupToEmailListPanelAccessList(Guid, Int32, Int32, array[]()[])	Add a user group to the access list for an email list and give the added group the specified permissions. If the group is already on the access list, the group’s current permissions will be overwritten by the new permissions.
AddUserGroupsToInvitation(Guid, Int32, array[]()[])	Add a list of user groups to an invitation.
AddUsersToInvitation(Guid, Int32, array[]()[])	Add a list of Checkbox users to an invitation.
AddUserToEmailListPanelAccessList(Guid, Int32, String, array[]()[])	Add a user to the access list for an email list and give the user the specified permissions. If the user is already on the email list panel’s access list, the user’s current permissions will be overwritten by the new permissions.
AuthenticateUser(String, String)
CreateInvitation(Guid, Int32)	Create an invitation associated with the specified response template.
DeleteInvitation(Guid, Int32)	Delete an invitation with the specified database Id.
DeleteInvitationRecipients(Guid, Int32, array[]()[])	Remove a list of recipients from the invitation.
GetEmailListPanelInfo(Guid, Int32)	Retrieve a EmailListPanelData object that contains information about an email list panel.
GetInvitation(Guid, Int32)	Get a data object representing an invitation. This object can be passed to UpdateInvitation(...) to make changes to the invitation.
ListEmailListPanelAccessListPermissionsForGroup(Gu id, Int32, Int32)	List the permissions a specific group has on the access list for an email list panel. An empty list is returned if the group is not on the access list.
ListEmailListPanelAccessListPermissionsForUser(Gui d, Int32, String)	List the permissions a specific user has on the access list for an email list panel. An empty list is returned if the user is not on the access list or has no configured permissions for the access list.
ListEmailListPanelAddresses(Guid, Int32)	List the email addresses contained in an email list panel.
ListEmailListPanelDefaultPolicyPermissions(Guid, Int32)
ListEmailPanels(Guid, String)	List the email panels that the calling user has the specified access to.
ListInvitationRecipients(Guid, Int32, String)	List all recipients for an invitation.
ListInvitations(Guid, Int32)
RemoveEmailAddressesFromEmailListPanel(Guid, Int32, array[]()[])	Remove the specified email addresses from an email list panel.
RemoveGroupFromEmailListPanelAccessList(Guid, Int32, Int32)	Remove a user group from an email list panel's access control list.
RemoveUserFromEmailListPanelAccessList(Guid, Int32, String)	Remove a user from an email list panel’s access list.
SendInvitationToFilteredRecipientList(Guid, Int32, String)	Send the invitation to recipients on the invitation.
SendInvitationToRecipientList(Guid, Int32, array[]()[])	Send an invitation to the specified list of recipients.
SetEmailListPanelDefaultPolicyPermissions(Guid, Int32, array[]()[])	Set the default policy of an email list panel to include the specified permissions.
UpdateEmailListPanel(Guid, EmailListPanelData)	Update the name and description of an email list panel.
UpdateInvitation(Guid, InvitationData)	Persist to Checkbox changes made to an InvitationData object.

Reporting

ReportingServiceProxy()()()
AuthenticateUser(String, String)
GetDataForResponseWithGuid(Guid, Guid, Boolean)	Retrieve the response data for a response with the specified guid
GetDataForResponseWithId(Guid, Guid, Boolean)	Retrieve the response data for a response with the specified id
GetDataForResponseWithIdAsync(Guid, Guid, Boolean)
GetDataForResponseWithIdAsync(Guid, Guid, Boolean, Object)
GetReportWithName(Guid, Int32, String, Boolean, Boolean)	Load data a report with the specified name.
ListAnswersForResponseGuid(Guid, Guid)	List answers for a given response.
ListAnswersForResponseId(Guid, Int64)	List answers for a given response.
ListReportsForSurvey(Guid, Int32, String, Boolean, Boolean)	List the reports available for a given survey.
ListResponsesForSurveyWithId(Guid, Int32, Boolean, String, String, Nullable<(Of <(DateTime>)>), Nullable<(Of <(DateTime>)>), Boolean, Boolean)	Retrieve an (optionally) filtered list of responses for a given survey.
ListResponsesForSurveyWithName(Guid, String, Boolean, String, String, Nullable<(Of <(DateTime>)>), Nullable<(Of <(DateTime>)>), Boolean, Boolean)	Retrieve an (optionally) filtered list of responses for a given survey.