Get Surveys
Request
Route
GET https://{IP_CORE_URL}/IntegratedPanelService/api/Surveys/?memberCode={MemberCode}&partnerGuid={PartnerGUID}&numberOfSurveys=2&mobileCompatible=false&deviceTypeIDs=1&deviceTypeIDs=2
Parameters
| Name | Type | Description |
|---|---|---|
| MemberCode | int | Unique Respondent Code from the Partner |
| PartnerGUID | Guid | Unique Partner code provided by Toluna |
| NumberOfSurveys | string | Number of Surveys the Partner is requesting to receive to show the Member (maximum 5 available) |
| MobileCompatible | bool | Optional - When TRUE, only mobile compatible surveys will be shown. This property will be deprecated in the future with an announcement. Use DeviceTypeIDs instead. |
| DeviceTypeIDs | int | Indicated the device types for which Surveys should be returned. Supported values: 1=Desktop/Laptop, 2=Tablet, 3=Phone. When “DeviceTypeIDs” are supplied, the “MobileCompatible” parameter is ignored |
Response
Possible Codes
| Code | Etiology, actions |
|---|---|
| 200 | OK. Request processed normally, results returned without issue |
| 400 | Bad Request. Request is malformed or incomplete. Review message details and take appropriate action |
| 500 | Internal Error. An exception occurred while processing the request. Toluna likely has the details captured in its logs |
Body Details
| Name | Type | Description |
|---|---|---|
| SurveyID | int | Toluna-specified Survey identifier |
| Name | string | Toluna-specified Survey name |
| URL | string | Clicking on the URL will take this specific Respondent to the survey. URL’s are unique to the respondent and are NOT to be used by other respondents. |
| Duration | int | Estimated length of interview |
| IR | int | Incidence rate fo the Survey in % |
| MemberAmount | decimal | This is currently only returned as a value > 0 if the partner has a specific amount that is paid to each of their respondents for a survey |
| PartnerAmount | decimal | Amount Toluna has agreed to pay Partner for a complete. The value shown is linked to the URL and is valid for any complete generated from a member’s interaction with the link, regardless of changes to the LOI and IR of the survey |
| WaveId | int | Current iteration of the survey. Studies related to one another can be sent in “waves” that the Member experiences as unique surveys. SurveyID+WaveId is always unique |
Example Response
[
{
"SurveyID": 21737,
"Name": "1063626-US-IP1",
"URL":
"https://ups.surveyrouter.com/TrafficUI/MSCUI/Page.aspx?pgtid=20&di=zi19HDWwzDwhDXE2DjZ8NIlZX8LPjuUJh
kV37eSE1dC3kE4",
"Duration": 0,
"IR": 100,
"MemberAmount": 0,
"PartnerAmount": 2,
"WaveId": 100,
"IsTqsSurvey": true
}
]