Definition

POST - 3/surveys/{SurveyId}/panelists/{ContactId}

Add a panelist to a survey by contactid.

Request information

NameDescriptionTypeAdditional information
SurveyId

The id of a survey.

integer

Required

ContactId

The id of a contact to be linked to this survey.

integer

Required

Additional options available when adding a contact.

NameDescriptionTypeAdditional information
DateToBeMailed

Date and time on which the invitation will be sent. If not passed, the invitation will be sent once the survey is live or immediately if the survey is already live.

date

ISO 8601 format

DateToExpire

Date and time on which the invitation should expire and the contact can no longer respond to the survey, if not available the invitation will be active until the survey is closed.

date

ISO 8601 format

Sample:
{
  "DateToBeMailed": "2019-01-17T16:12:38.6571329Z",
  "DateToExpire": "2019-01-17T16:12:38.6571329Z"
}
Sample:
<ReusingContact xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <DateToBeMailed>2019-01-17T16:12:38.6571329+00:00</DateToBeMailed>
  <DateToExpire>2019-01-17T16:12:38.6571329+00:00</DateToExpire>
</ReusingContact>

Response information


NameDescriptionTypeAdditional information
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.

ContactCreateResult

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

Sample:
{
  "Meta": {
    "Status": 1,
    "TotalRowCount": 1,
    "Limit": 1,
    "Offset": 1,
    "TotalPageCount": 1,
    "StartRec": 1,
    "StopRec": 1,
    "Timestamp": "2019-01-17T16:12:38.6571329Z",
    "IsFiltered": true
  },
  "Data": {
    "Succeeded": true,
    "FailureMessage": "sample string 2",
    "ContactId": 1
  }
}
Sample:
<Payload xmlns:i="http://www.w3.org/2001/XMLSchema-instance" z:Id="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/">
  <Data>
    <FailureMessage>sample string 2</FailureMessage>
    <Succeeded>true</Succeeded>
    <ContactId>1</ContactId>
  </Data>
  <Meta>
    <IsFiltered>true</IsFiltered>
    <Limit>1</Limit>
    <Offset>1</Offset>
    <StartRec>1</StartRec>
    <Status>1</Status>
    <StopRec>1</StopRec>
    <Timestamp>2019-01-17T16:12:38.6571329+00:00</Timestamp>
    <TotalPageCount>1</TotalPageCount>
    <TotalRowCount>1</TotalRowCount>
  </Meta>
</Payload>