SOAP - WSDL: http://api.ideascale.com/a/soap/v1?WSDL      
The following SOAP Method Calls are available: -
ideascale.GetIdeas
Returns all the Ideas (based on the filter and sorting model)
Parameters
Name Type Description
username String The account username
password String Account Password
portalId Integer The Portal ID
categoryId Integer The Category ID (Pass -1 for all Categories)
sortMode Integer 0 - Recent, 1 - By Vote Count
Return
Type Description
Idea[] (Array)
  • An array of Idea objects - Idea is a Complex Type. See the WSDL for details on the Idea type. NOTE - The system will only return 10 rows by default for performance considerations.


surveyconsole.GetSurveyNames
Returns all the Active Surveys for the Account
Parameters
Name Type Description
username String The account username
password String The account password
Return
Type Description
String[] (Array)
  • The Surveys for the account


surveyconsole.CreateEmailAddressGroup
Creates a New Email Address Group. An Email Address Group is holder for storing email addresses. Use the groupCode for subsequent calls related to sending surveys etc.
Parameters
Name Type Description
username String The account username
password String The account password
groupName String The display name for the group
groupCode String The code for the group. Use this code for subsequent address-book related calls
Return
Type Description
Integer
  • 0 - Successful
  • 999 - Internal Server Error


surveyconsole.GetSurveyTrackingURL
Returns the Unique URL to the Survey along with the necessary tracking information
Parameters
Name Type Description
username String The account username
password String The account password
surveyName String The survey name (See also surveyconsole.GetSurveyNames)
groupCode String The code for the group. If a Group with this code already exists then the email address will be added to this group. If not, then a new group with this code will be created (See also surveyconsole.CreateEmailAddressGroup)
emailAddress String The Email Address of the respondent
Return
Type Description
String
  • The URL to send to the respondent


surveyconsole.GetSurveyInHTML
Returns the HTML Code for the Survey
Parameters
Name Type Description
username String The account username
password String The account password
surveyName String The survey name (See also surveyconsole.GetSurveyNames)
Return
Type Description
String
  • The HTML Code for the survey


surveyconsole.GetRawData
Returns the RAW (CSV) data for a timeperiod
Parameters
Name Type Description
username String The account username
password String The account password
surveyName String The survey name (See also surveyconsole.GetSurveyNames)
startTime dateTime.iso8601 Start Time
endTime dateTime.iso8601 End Time
Return
Type Description
String
  • The RAW data - Each response in a single line (Newline Delimiter)


surveyconsole.GetRawDataForAllSurveys
Returns the RAW (CSV) data for a timeperiod for all the surveys in your account
Parameters
Name Type Description
username String The account username
password String The account password
startTime dateTime.iso8601 Start Time
endTime dateTime.iso8601 End Time
Return
Type Description
String
  • The RAW data - Each response in a single line (Newline Delimiter)


surveyconsole.GetSurveyResponseData
Returns the formatted HTML data for a contact (email address)
Parameters
Name Type Description
username String The account username
password String The account password
surveyName String The Name of the Survey
groupCode String The Name of the Email List
emailAddress String The Email Address to search for
Return
Type Description
String
  • The HTML Formatted data for ALL RESPONSES linked to the email address


surveyconsole.SendSurveyToGroup
Sends a survey invitation to a list of email addresses
Parameters
Name Type Description
username String The account username
password String The account password
surveyName String The Name of the Survey
groupCode String The Name of the Email List
emailAddress String[] The Email Addresses to send to
Return
Type Description
Void


More