Definition

GET - 3/surveys/{surveyId}/panelists/{contactId}

Retrieve a panelist from a survey by contactId.

Request information

surveyId

The id of a survey.


Type integer
Additional info
Required
contactId

The id of a contact linked to this survey.


Type integer
Additional info
Required

Response information

Payload containing the Panelist for the requested contactId.


Meta

The metadata such as paging parameters, status code, timestamp,... which are related to this request.


Type MetaData
Data

The actual data returned by the request.


Type Panelist
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.


Type Hateoas
Sample:
{
  "Meta": {
    "Status": 1,
    "TotalRowCount": 1,
    "Limit": 1,
    "Offset": 1,
    "TotalPageCount": 1,
    "StartRec": 1,
    "StopRec": 1,
    "Timestamp": "2019-08-25T06:03:00.2795406Z",
    "IsFiltered": true
  },
  "Data": {
    "PreviewUrl": "sample string 1",
    "LiveUrl": "sample string 2",
    "MailPreviewUrl": "sample string 3",
    "OptoutSourceId": 64,
    "PanelistStatusId": 5,
    "DateAdded": "2019-08-25T06:03:00.2795406Z",
    "DateInvited": "2019-08-25T06:03:00.2795406Z",
    "DateSawMail": "2019-08-25T06:03:00.2795406Z",
    "DateClickedThrough": "2019-08-25T06:03:00.2795406Z",
    "DateReminded": "2019-08-25T06:03:00.2795406Z",
    "DateRemindedPartial": "2019-08-25T06:03:00.2795406Z",
    "DateResponded": "2019-08-25T06:03:00.2795406Z",
    "Password": "sample string 6",
    "DateSentThankYouMail": "2019-08-25T06:03:00.2795406Z",
    "DateToBeInvited": "2019-08-25T06:03:00.2795406Z",
    "DateSecondReminder": "2019-08-25T06:03:00.2795406Z",
    "DateToExpire": "2019-08-25T06:03:00.2795406Z",
    "DateLastModified": "2019-08-25T06:03:00.2795406Z",
    "Surveys": [
      {
        "SurveyId": 2,
        "Title": "sample string 3",
        "PanelistStatusId": 4,
        "DateAdded": "2019-08-25T06:03:00.2795406Z",
        "PanelistReportUrl": "sample string 5"
      },
      {
        "SurveyId": 2,
        "Title": "sample string 3",
        "PanelistStatusId": 4,
        "DateAdded": "2019-08-25T06:03:00.2795406Z",
        "PanelistReportUrl": "sample string 5"
      }
    ],
    "Groups": [
      {
        "GroupId": 2,
        "Name": "sample string 3"
      },
      {
        "GroupId": 2,
        "Name": "sample string 3"
      }
    ],
    "LangCode": "en",
    "ContactId": 8,
    "FirstName": "John",
    "LastName": "Doe",
    "Email": "john.doe@mail.com",
    "CustomField1": "sample string 9",
    "CustomField2": "sample string 10",
    "CustomField3": "sample string 11",
    "CustomField4": "sample string 12",
    "CustomField5": "sample string 13",
    "CustomField6": "sample string 14",
    "CustomField7": "sample string 15",
    "CustomField8": "sample string 16",
    "CustomField9": "sample string 17",
    "CustomField10": "sample string 18",
    "CustomField11": "sample string 19",
    "CustomField12": "sample string 20",
    "CustomField13": "sample string 21",
    "CustomField14": "sample string 22",
    "CustomField15": "sample string 23",
    "CustomField16": "sample string 24",
    "CustomField17": "sample string 25",
    "CustomField18": "sample string 26",
    "CustomField19": "sample string 27",
    "CustomField20": "sample string 28",
    "Street": "Main Street",
    "HouseNumber": "123",
    "Suite": "B",
    "PostalCode": "98765-4321",
    "City": "Anytown",
    "State": "CA",
    "Province": "Orange County",
    "Phone": "+1-202-555-0117",
    "CountryId": "US",
    "Gender": "M",
    "DateOfBirth": "2019-08-25T06:03:00.280518Z",
    "IsBounced": true,
    "IsOptedOut": true
  }
}
Sample:
<Payload xmlns:i="http://www.w3.org/2001/XMLSchema-instance" z:Id="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/">
  <Data z:Id="i2">
    <Groups>
      <GroupReference>
        <GroupId>2</GroupId>
        <Name>sample string 3</Name>
      </GroupReference>
      <GroupReference>
        <GroupId>2</GroupId>
        <Name>sample string 3</Name>
      </GroupReference>
    </Groups>
    <LangCode>en</LangCode>
    <Surveys>
      <SurveyReference z:Id="i3">
        <DateAdded>2019-08-25T07:03:00.2795406+01:00</DateAdded>
        <PanelistReportUrl>sample string 5</PanelistReportUrl>
        <PanelistStatusId>4</PanelistStatusId>
        <SurveyId>2</SurveyId>
        <Title>sample string 3</Title>
      </SurveyReference>
      <SurveyReference z:Ref="i3" />
    </Surveys>
    <ContactId>8</ContactId>
    <FirstName>John</FirstName>
    <LastName>Doe</LastName>
    <Email>john.doe@mail.com</Email>
    <CustomField1>sample string 9</CustomField1>
    <CustomField2>sample string 10</CustomField2>
    <CustomField3>sample string 11</CustomField3>
    <CustomField4>sample string 12</CustomField4>
    <CustomField5>sample string 13</CustomField5>
    <CustomField6>sample string 14</CustomField6>
    <CustomField7>sample string 15</CustomField7>
    <CustomField8>sample string 16</CustomField8>
    <CustomField9>sample string 17</CustomField9>
    <CustomField10>sample string 18</CustomField10>
    <CustomField11>sample string 19</CustomField11>
    <CustomField12>sample string 20</CustomField12>
    <CustomField13>sample string 21</CustomField13>
    <CustomField14>sample string 22</CustomField14>
    <CustomField15>sample string 23</CustomField15>
    <CustomField16>sample string 24</CustomField16>
    <CustomField17>sample string 25</CustomField17>
    <CustomField18>sample string 26</CustomField18>
    <CustomField19>sample string 27</CustomField19>
    <CustomField20>sample string 28</CustomField20>
    <Street>Main Street</Street>
    <HouseNumber>123</HouseNumber>
    <Suite>B</Suite>
    <PostalCode>98765-4321</PostalCode>
    <City>Anytown</City>
    <State>CA</State>
    <Province>Orange County</Province>
    <Phone>+1-202-555-0117</Phone>
    <CountryId>US</CountryId>
    <Gender>M</Gender>
    <DateOfBirth>2019-08-25T07:03:00.280518+01:00</DateOfBirth>
    <IsBounced>true</IsBounced>
    <IsOptedOut>true</IsOptedOut>
    <DateAdded>2019-08-25T07:03:00.2795406+01:00</DateAdded>
    <DateClickedThrough>2019-08-25T07:03:00.2795406+01:00</DateClickedThrough>
    <DateInvited>2019-08-25T07:03:00.2795406+01:00</DateInvited>
    <DateLastModified>2019-08-25T07:03:00.2795406+01:00</DateLastModified>
    <DateReminded>2019-08-25T07:03:00.2795406+01:00</DateReminded>
    <DateRemindedPartial>2019-08-25T07:03:00.2795406+01:00</DateRemindedPartial>
    <DateResponded>2019-08-25T07:03:00.2795406+01:00</DateResponded>
    <DateSawMail>2019-08-25T07:03:00.2795406+01:00</DateSawMail>
    <DateSecondReminder>2019-08-25T07:03:00.2795406+01:00</DateSecondReminder>
    <DateSentThankYouMail>2019-08-25T07:03:00.2795406+01:00</DateSentThankYouMail>
    <DateToBeInvited>2019-08-25T07:03:00.2795406+01:00</DateToBeInvited>
    <DateToExpire>2019-08-25T07:03:00.2795406+01:00</DateToExpire>
    <PanelistStatusId>5</PanelistStatusId>
    <Password>sample string 6</Password>
    <LiveUrl>sample string 2</LiveUrl>
    <MailPreviewUrl>sample string 3</MailPreviewUrl>
    <OptoutSourceId>64</OptoutSourceId>
    <PreviewUrl>sample string 1</PreviewUrl>
  </Data>
  <Meta>
    <IsFiltered>true</IsFiltered>
    <Limit>1</Limit>
    <Offset>1</Offset>
    <StartRec>1</StartRec>
    <Status>1</Status>
    <StopRec>1</StopRec>
    <Timestamp>2019-08-25T07:03:00.2795406+01:00</Timestamp>
    <TotalPageCount>1</TotalPageCount>
    <TotalRowCount>1</TotalRowCount>
  </Meta>
</Payload>

Related Examples

Title
Add a new contact to a survey