Get the respondent with responses from a survey.
Name | Description | Type | Additional information |
---|---|---|---|
surveyId
The id of a survey.
Type
integer
Additional info
Required
|
|||
surveyId |
The id of a survey. |
integer |
Required |
respondentId
The id of a respondent: this id can be retrieved from your internal system, passed as a parameter in a branching url, automated alert...
Type
integer
Additional info
Required
|
|||
respondentId |
The id of a respondent: this id can be retrieved from your internal system, passed as a parameter in a branching url, automated alert... |
integer |
Required |
Payload containing a Respondent.
Name | Description | Type | Additional information |
---|---|---|---|
Meta
The metadata such as paging parameters, status code, timestamp,... which are related to this request.
Type
MetaData
|
|||
Meta |
The metadata such as paging parameters, status code, timestamp,... which are related to this request. |
MetaData | |
Data |
The actual data returned by the request. |
Respondent | |
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 |
{ "Meta": { "Status": 1, "TotalRowCount": 1, "Limit": 1, "Offset": 1, "TotalPageCount": 1, "StartRec": 1, "StopRec": 1, "Timestamp": "2024-12-12T19:22:18.129725Z", "IsFiltered": true }, "Data": { "RespondentId": 1, "LanguageCode": "sample string 2", "RespondentStatusId": 3, "ResponseDate": "2024-12-12T19:22:18.129725Z", "CompletionTime": 4, "DistributionMethodId": 5, "BrowserId": 64, "OsId": 64, "IsMobile": true, "IpAddress": "sample string 7", "RespondentReportUrl": "sample string 8", "ReportUrl": "sample string 9", "EditUrl": "sample string 10", "Responses": [ { "QuestionId": 3, "DataLabel": "sample string 4", "ResponseId": 5, "Value": "sample string 6", "Tags": [ { "TagId": 1, "SentimentScore": 1, "SalienceScore": 1.1, "TaggedByTextMining": true }, { "TagId": 1, "SentimentScore": 1, "SalienceScore": 1.1, "TaggedByTextMining": true } ], "ScaleValue": 1, "Score": 7.0, "ResponseCaption": "sample string 8" }, { "QuestionId": 3, "DataLabel": "sample string 4", "ResponseId": 5, "Value": "sample string 6", "Tags": [ { "TagId": 1, "SentimentScore": 1, "SalienceScore": 1.1, "TaggedByTextMining": true }, { "TagId": 1, "SentimentScore": 1, "SalienceScore": 1.1, "TaggedByTextMining": true } ], "ScaleValue": 1, "Score": 7.0, "ResponseCaption": "sample string 8" } ], "Location": { "Latitude": 2.0, "Longitude": 3.0, "CountryId": "sample string 4", "City": "sample string 5" }, "Score": 11.1, "RespondentHash": "sample string 12", "PanelistStatusId": 14, "ContactStatusId": 15, "DateAdded": "2024-12-12T19:22:18.129725Z", "DateInvited": "2024-12-12T19:22:18.129725Z", "DateSawMail": "2024-12-12T19:22:18.129725Z", "DateClickedThrough": "2024-12-12T19:22:18.129725Z", "DateReminded": "2024-12-12T19:22:18.129725Z", "DateRemindedPartial": "2024-12-12T19:22:18.129725Z", "DateResponded": "2024-12-12T19:22:18.129725Z", "Password": "sample string 16", "DateSentThankYouMail": "2024-12-12T19:22:18.1307387Z", "DateToBeInvited": "2024-12-12T19:22:18.1307387Z", "DateSecondReminder": "2024-12-12T19:22:18.1307387Z", "DateToExpire": "2024-12-12T19:22:18.1307387Z", "DateLastModified": "2024-12-12T19:22:18.1307387Z", "Surveys": [ { "SurveyId": 2, "Title": "sample string 3", "PanelistStatusId": 4, "DateAdded": "2024-12-12T19:22:18.1307387Z", "PanelistReportUrl": "sample string 5" }, { "SurveyId": 2, "Title": "sample string 3", "PanelistStatusId": 4, "DateAdded": "2024-12-12T19:22:18.1307387Z", "PanelistReportUrl": "sample string 5" } ], "Groups": [ { "GroupId": 2, "Name": "sample string 3" }, { "GroupId": 2, "Name": "sample string 3" } ], "LangCode": "en", "ContactId": 18, "FirstName": "John", "LastName": "Doe", "Email": "john.doe@mail.com", "CustomField1": "sample string 19", "CustomField2": "sample string 20", "CustomField3": "sample string 21", "CustomField4": "sample string 22", "CustomField5": "sample string 23", "CustomField6": "sample string 24", "CustomField7": "sample string 25", "CustomField8": "sample string 26", "CustomField9": "sample string 27", "CustomField10": "sample string 28", "CustomField11": "sample string 29", "CustomField12": "sample string 30", "CustomField13": "sample string 31", "CustomField14": "sample string 32", "CustomField15": "sample string 33", "CustomField16": "sample string 34", "CustomField17": "sample string 35", "CustomField18": "sample string 36", "CustomField19": "sample string 37", "CustomField20": "sample string 38", "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": "2024-12-12T19:22:18.1307387Z", "IsBounced": true, "IsOptedOut": true } }
<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>2024-12-12T19:22:18.1307387+00: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>18</ContactId> <FirstName>John</FirstName> <LastName>Doe</LastName> <Email>john.doe@mail.com</Email> <CustomField1>sample string 19</CustomField1> <CustomField2>sample string 20</CustomField2> <CustomField3>sample string 21</CustomField3> <CustomField4>sample string 22</CustomField4> <CustomField5>sample string 23</CustomField5> <CustomField6>sample string 24</CustomField6> <CustomField7>sample string 25</CustomField7> <CustomField8>sample string 26</CustomField8> <CustomField9>sample string 27</CustomField9> <CustomField10>sample string 28</CustomField10> <CustomField11>sample string 29</CustomField11> <CustomField12>sample string 30</CustomField12> <CustomField13>sample string 31</CustomField13> <CustomField14>sample string 32</CustomField14> <CustomField15>sample string 33</CustomField15> <CustomField16>sample string 34</CustomField16> <CustomField17>sample string 35</CustomField17> <CustomField18>sample string 36</CustomField18> <CustomField19>sample string 37</CustomField19> <CustomField20>sample string 38</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>2024-12-12T19:22:18.1307387+00:00</DateOfBirth> <IsBounced>true</IsBounced> <IsOptedOut>true</IsOptedOut> <ContactStatusId>15</ContactStatusId> <DateAdded>2024-12-12T19:22:18.129725+00:00</DateAdded> <DateClickedThrough>2024-12-12T19:22:18.129725+00:00</DateClickedThrough> <DateInvited>2024-12-12T19:22:18.129725+00:00</DateInvited> <DateLastModified>2024-12-12T19:22:18.1307387+00:00</DateLastModified> <DateReminded>2024-12-12T19:22:18.129725+00:00</DateReminded> <DateRemindedPartial>2024-12-12T19:22:18.129725+00:00</DateRemindedPartial> <DateResponded>2024-12-12T19:22:18.129725+00:00</DateResponded> <DateSawMail>2024-12-12T19:22:18.129725+00:00</DateSawMail> <DateSecondReminder>2024-12-12T19:22:18.1307387+00:00</DateSecondReminder> <DateSentThankYouMail>2024-12-12T19:22:18.1307387+00:00</DateSentThankYouMail> <DateToBeInvited>2024-12-12T19:22:18.1307387+00:00</DateToBeInvited> <DateToExpire>2024-12-12T19:22:18.1307387+00:00</DateToExpire> <PanelistStatusId>14</PanelistStatusId> <Password>sample string 16</Password> <BrowserId>64</BrowserId> <CompletionTime>4</CompletionTime> <DistributionMethodId>5</DistributionMethodId> <EditUrl>sample string 10</EditUrl> <IpAddress>sample string 7</IpAddress> <IsMobile>true</IsMobile> <LanguageCode>sample string 2</LanguageCode> <Location> <City>sample string 5</City> <CountryId>sample string 4</CountryId> <Latitude>2</Latitude> <Longitude>3</Longitude> </Location> <OsId>64</OsId> <ReportUrl>sample string 9</ReportUrl> <RespondentHash>sample string 12</RespondentHash> <RespondentId>1</RespondentId> <RespondentReportUrl>sample string 8</RespondentReportUrl> <RespondentStatusId>3</RespondentStatusId> <ResponseDate>2024-12-12T19:22:18.129725+00:00</ResponseDate> <Responses> <Response z:Id="i4"> <DataLabel>sample string 4</DataLabel> <QuestionId>3</QuestionId> <ResponseCaption>sample string 8</ResponseCaption> <ResponseId>5</ResponseId> <ScaleValue>1</ScaleValue> <Score>7</Score> <Tags> <ResponseStringTag> <SalienceScore>1.1</SalienceScore> <SentimentScore>1</SentimentScore> <TagId>1</TagId> <TaggedByTextMining>true</TaggedByTextMining> </ResponseStringTag> <ResponseStringTag> <SalienceScore>1.1</SalienceScore> <SentimentScore>1</SentimentScore> <TagId>1</TagId> <TaggedByTextMining>true</TaggedByTextMining> </ResponseStringTag> </Tags> <Value>sample string 6</Value> </Response> <Response z:Ref="i4" /> </Responses> <Score>11.1</Score> </Data> <Meta> <IsFiltered>true</IsFiltered> <Limit>1</Limit> <Offset>1</Offset> <StartRec>1</StartRec> <Status>1</Status> <StopRec>1</StopRec> <Timestamp>2024-12-12T19:22:18.129725+00:00</Timestamp> <TotalPageCount>1</TotalPageCount> <TotalRowCount>1</TotalRowCount> </Meta> </Payload>