Name | Description | Type | Additional information |
---|---|---|---|
Response
The value entered by the respondent. In case of a upload question type, the url to the uploaded file.
Type
string
|
|||
Response |
The value entered by the respondent. In case of a upload question type, the url to the uploaded file. |
string | |
ResponseStringId
A unique ID for a open text response.
Type
integer
|
|||
ResponseStringId |
A unique ID for a open text response. |
integer | |
Tags
In case text analysis has been done, the tags and sentiment indicated for the value.
Type
Collection of ResponseStringTag
|
|||
Tags |
In case text analysis has been done, the tags and sentiment indicated for the value. |
Collection of ResponseStringTag | |
RespondentId
Unique respondent number
Type
integer
|
|||
RespondentId |
Unique respondent number |
integer | |
LanguageCode
2-letter ISO 639-1 language code
Type
string
|
|||
LanguageCode |
2-letter ISO 639-1 language code |
string | |
RespondentStatusId
The id shows the completion level: partial, reached end or screened out.
Type
integer
Additional info
|
|||
RespondentStatusId |
The id shows the completion level: partial, reached end or screened out. |
integer | |
ResponseDate
Date Responded (in ISO 8601 format)
Type
date
Additional info
In case of an anonymous survey the time is reset to 00:00:00 ,Obsolete: This field will be replaced with DateResponded. |
|||
ResponseDate |
Date Responded (in ISO 8601 format) |
date |
In case of an anonymous survey the time is reset to 00:00:00 ,Obsolete: This field will be replaced with DateResponded. |
CompletionTime
Time (in seconds) spent completing the survey
Type
integer
Additional info
Not available for an anonymous survey |
|||
CompletionTime |
Time (in seconds) spent completing the survey |
integer |
Not available for an anonymous survey |
DistributionMethodId
The channel used to reach the survey e.g. email, SMS, etc.
Type
integer
Additional info
|
|||
DistributionMethodId |
The channel used to reach the survey e.g. email, SMS, etc. |
integer | |
BrowserId
The id of the browser used to complete the survey
Type
byte
Additional info
|
|||
BrowserId |
The id of the browser used to complete the survey |
byte | |
OsId
The id of the operating system used to complete the survey
Type
byte
Additional info
|
|||
OsId |
The id of the operating system used to complete the survey |
byte | |
IsMobile
Whether or not the respondent was using a mobile operating system to complete the survey
Type
boolean
|
|||
IsMobile |
Whether or not the respondent was using a mobile operating system to complete the survey |
boolean | |
IpAddress
The IP address used to complete the survey
Type
string
Additional info
Not available for an anonymous survey |
|||
IpAddress |
The IP address used to complete the survey |
string |
Not available for an anonymous survey |
RespondentReportUrl
Url to the respondent’s answer summary webpage
Type
string
|
|||
RespondentReportUrl |
Url to the respondent’s answer summary webpage |
string | |
ReportUrl
Url to the internal respondent's answer summary webpage
Type
string
Additional info
The report contains contactinformation and hidden questions. |
|||
ReportUrl |
Url to the internal respondent's answer summary webpage |
string |
The report contains contactinformation and hidden questions. |
EditUrl
This URL will allow you to change responses given to this survey.
Type
string
Additional info
Be sure you have permission from the respondent and you must respect the ICC/Esomar international code at all times. Learn more |
|||
EditUrl |
This URL will allow you to change responses given to this survey. |
string |
Be sure you have permission from the respondent and you must respect the ICC/Esomar international code at all times. Learn more |
Responses
All responses for this respondent. When retrieving a list of respondents, this property is by default not available. For instance if you are building an overview of respondents, you won't use the responses. If you would like this additional information, you can use the expand parameter
Type
Collection of Response
Additional info
|
|||
Responses |
All responses for this respondent. When retrieving a list of respondents, this property is by default not available. For instance if you are building an overview of respondents, you won't use the responses. If you would like this additional information, you can use the expand parameter |
Collection of Response | |
Location
Location based on the IP address. When retrieving a list of respondents, this property is by default not available. If you would like this additional information, you can use the expand parameter
Type
IPLocation
Additional info
Expandable, not available for an anonymous survey |
|||
Location |
Location based on the IP address. When retrieving a list of respondents, this property is by default not available. If you would like this additional information, you can use the expand parameter |
IPLocation |
Expandable, not available for an anonymous survey |
Score
The total score for this respondent: sum of all SurveyQuestionResponse.Value
Type
decimal number
|
|||
Score |
The total score for this respondent: sum of all SurveyQuestionResponse.Value |
decimal number | |
RespondentHash
The unique hash for this respondent, when using an external url in branching you should include and validate the respondent hash. The external url can be very useful when building custom respondent reports.
Type
string
|
|||
RespondentHash |
The unique hash for this respondent, when using an external url in branching you should include and validate the respondent hash. The external url can be very useful when building custom respondent reports. |
string | |
PanelistStatusId
Status of the panelist e.g. included, invited, bounced, etc. Learn more.
Type
integer
Additional info
,
Obsolete: Replaced with ContactStatusId |
|||
PanelistStatusId |
Status of the panelist e.g. included, invited, bounced, etc. Learn more. |
integer |
, Obsolete: Replaced with ContactStatusId |
ContactStatusId
Status of the contact e.g. included, invited, bounced, etc. Learn more.
Type
integer
Additional info
|
|||
ContactStatusId |
Status of the contact e.g. included, invited, bounced, etc. Learn more. |
integer | |
DateAdded
Date added to the survey
Type
date
Additional info
|
|||
DateAdded |
Date added to the survey |
date |
|
DateInvited
Date invitation has been sent
Type
date
Additional info
|
|||
DateInvited |
Date invitation has been sent |
date |
|
DateSawMail
Date the mail has been viewed
Type
date
Additional info
|
|||
DateSawMail |
Date the mail has been viewed |
date |
|
DateClickedThrough
Type
date
Additional info
|
|||
DateClickedThrough | date |
|
|
DateReminded
Date reminder has been sent
Type
date
Additional info
|
|||
DateReminded |
Date reminder has been sent |
date |
|
DateRemindedPartial
Date partial reminder has been sent
Type
date
Additional info
|
|||
DateRemindedPartial |
Date partial reminder has been sent |
date |
|
DateResponded
Date the panelist responded to the survey
Type
date
Additional info
|
|||
DateResponded |
Date the panelist responded to the survey |
date |
|
Password
The password which respondents need to access the survey. This is only available if the distribution panel "Paper - with panel" is active.
Type
string
|
|||
Password |
The password which respondents need to access the survey. This is only available if the distribution panel "Paper - with panel" is active. |
string | |
DateSentThankYouMail
Date thank you mail has been sent
Type
date
Additional info
|
|||
DateSentThankYouMail |
Date thank you mail has been sent |
date |
|
DateToBeInvited
Date invitation will be sent in case it's different then the DateAdded
Type
date
Additional info
|
|||
DateToBeInvited |
Date invitation will be sent in case it's different then the DateAdded |
date | |
DateSecondReminder
Date second reminder has been sent
Type
date
Additional info
|
|||
DateSecondReminder |
Date second reminder has been sent |
date |
|
DateToExpire |
Date the invitation will expire |
date | |
DateLastModified
Date and time that the panelist was last modified. This date only relates to the panelist information, not to contact/respondent data.
Type
date
Additional info
|
|||
DateLastModified |
Date and time that the panelist was last modified. This date only relates to the panelist information, not to contact/respondent data. |
date | |
ContactId
Unique contact number.
Type
integer
|
|||
ContactId |
Unique contact number. |
integer | |
FirstName
Contact’s first name.
Type
string
Additional info
Not available when retrieving respondents for an anonymous survey |
|||
FirstName |
Contact’s first name. |
string |
Not available when retrieving respondents for an anonymous survey |
LastName
Contact’s last name.
Type
string
Additional info
Not available when retrieving respondents for an anonymous survey |
|||
LastName |
Contact’s last name. |
string |
Not available when retrieving respondents for an anonymous survey |
Email
Contact's email address.
Type
string
Additional info
Not available when retrieving respondents for an anonymous survey |
|||
Contact's email address. |
string |
Not available when retrieving respondents for an anonymous survey |
|
LangCode |
2-letter ISO 639-1 language code |
string | |
CustomField1
A field which can be used to store additional contact information.
Type
string
|
|||
CustomField1 |
A field which can be used to store additional contact information. |
string | |
CustomField2
A field which can be used to store additional contact information.
Type
string
|
|||
CustomField2 |
A field which can be used to store additional contact information. |
string | |
CustomField3
A field which can be used to store additional contact information.
Type
string
|
|||
CustomField3 |
A field which can be used to store additional contact information. |
string | |
CustomField4
A field which can be used to store additional contact information.
Type
string
|
|||
CustomField4 |
A field which can be used to store additional contact information. |
string | |
CustomField5
A field which can be used to store additional contact information.
Type
string
|
|||
CustomField5 |
A field which can be used to store additional contact information. |
string | |
CustomField6
A field which can be used to store additional contact information.
Type
string
|
|||
CustomField6 |
A field which can be used to store additional contact information. |
string | |
CustomField7
A field which can be used to store additional contact information.
Type
string
|
|||
CustomField7 |
A field which can be used to store additional contact information. |
string | |
CustomField8
A field which can be used to store additional contact information.
Type
string
|
|||
CustomField8 |
A field which can be used to store additional contact information. |
string | |
CustomField9
A field which can be used to store additional contact information.
Type
string
|
|||
CustomField9 |
A field which can be used to store additional contact information. |
string | |
CustomField10
A field which can be used to store additional contact information.
Type
string
|
|||
CustomField10 |
A field which can be used to store additional contact information. |
string | |
CustomField11
A field which can be used to store additional contact information.
Type
string
|
|||
CustomField11 |
A field which can be used to store additional contact information. |
string | |
CustomField12
A field which can be used to store additional contact information.
Type
string
|
|||
CustomField12 |
A field which can be used to store additional contact information. |
string | |
CustomField13
A field which can be used to store additional contact information.
Type
string
|
|||
CustomField13 |
A field which can be used to store additional contact information. |
string | |
CustomField14
A field which can be used to store additional contact information.
Type
string
|
|||
CustomField14 |
A field which can be used to store additional contact information. |
string | |
CustomField15
A field which can be used to store additional contact information.
Type
string
|
|||
CustomField15 |
A field which can be used to store additional contact information. |
string | |
CustomField16
A field which can be used to store additional contact information.
Type
string
|
|||
CustomField16 |
A field which can be used to store additional contact information. |
string | |
CustomField17
A field which can be used to store additional contact information.
Type
string
|
|||
CustomField17 |
A field which can be used to store additional contact information. |
string | |
CustomField18
A field which can be used to store additional contact information.
Type
string
|
|||
CustomField18 |
A field which can be used to store additional contact information. |
string | |
CustomField19
A field which can be used to store additional contact information.
Type
string
|
|||
CustomField19 |
A field which can be used to store additional contact information. |
string | |
CustomField20
A field which can be used to store additional contact information.
Type
string
|
|||
CustomField20 |
A field which can be used to store additional contact information. |
string | |
Street
Contact's street name.
Type
string
Additional info
Not available when retrieving respondents for an anonymous survey |
|||
Street |
Contact's street name. |
string |
Not available when retrieving respondents for an anonymous survey |
HouseNumber
Contact's house number.
Type
string
Additional info
Not available when retrieving respondents for an anonymous survey |
|||
HouseNumber |
Contact's house number. |
string |
Not available when retrieving respondents for an anonymous survey |
Suite
Contact's apt. number.
Type
string
Additional info
Not available when retrieving respondents for an anonymous survey |
|||
Suite |
Contact's apt. number. |
string |
Not available when retrieving respondents for an anonymous survey |
PostalCode
Postal code.
Type
string
|
|||
PostalCode |
Postal code. |
string | |
City
Contact's city.
Type
string
|
|||
City |
Contact's city. |
string | |
State |
ISO 3166-2 two-last letters state code. |
string | |
Province
Contact's procince.
Type
string
|
|||
Province |
Contact's procince. |
string | |
Phone
Contact's phone number in the E.164 format (+[country code] [area code] [number])
Type
string
Additional info
Not available when retrieving respondents for an anonymous survey |
|||
Phone |
Contact's phone number in the E.164 format (+[country code] [area code] [number]) |
string |
Not available when retrieving respondents for an anonymous survey |
CountryId |
ISO 3166-1 two-letter country code. |
string | |
Gender
Contact's gender.
Type
string
Additional info
Matching regular expression pattern: ^[m|M|f|F]$
|
|||
Gender |
Contact's gender. |
string |
Matching regular expression pattern: ^[m|M|f|F]$ |
DateOfBirth
Contact's birthday.
Type
date
Additional info
* ISO 8601 format * Not available when retrieving respondents for an anonymous survey |
|||
DateOfBirth |
Contact's birthday. |
date |
* ISO 8601 format * Not available when retrieving respondents for an anonymous survey |
IsBounced
Indicates if the email address for this contact is currently on the bounce list.
Type
boolean
|
|||
IsBounced |
Indicates if the email address for this contact is currently on the bounce list. |
boolean | |
IsOptedOut
Indicates if this contact is currently on the opt out list.
Type
boolean
|
|||
IsOptedOut |
Indicates if this contact is currently on the opt out list. |
boolean | |
Links |
HATEOAS related to this object. It wil contain relevant url's such as previous and next page for paged results, create/update/delete action. These url's can be used in your application for the next steps in your application logic. |
Hateoas |