| Name | Description | Type | Additional information |
|---|---|---|---|
|
PreviewUrl
This URL leads to an preview version of the survey.
Type
string
|
|||
| PreviewUrl |
This URL leads to an preview version of the survey. |
string | |
|
LiveUrl
This is the LIVE personal URL for this panelist. All results will be recorded.
Type
string
|
|||
| LiveUrl |
This is the LIVE personal URL for this panelist. All results will be recorded. |
string | |
|
MailPreviewUrl
This is the personal URL for a preview of the mail for this panelist.
Type
string
|
|||
| MailPreviewUrl |
This is the personal URL for a preview of the mail for this panelist. |
string | |
| OptoutSourceId |
Origin of the optout. |
byte | |
|
ReportUrl
This is the personal URL for a report of this contact.
Type
string
|
|||
| ReportUrl |
This is the personal URL for a report of this contact. |
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 | |