TicketUserServices

<back to all web services

SurveyRecipientImportRequest

Requires Authentication
Required role:Admin
The following routes are available for this service:
POST/SurveyCampaign/{CampaignId}/Recipients
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class SurveyRecipientImportRequest
    {
        public Integer campaignId = null;
        public ArrayList<SurveyRecipientImportRow> rows = null;
        
        public Integer getCampaignId() { return campaignId; }
        public SurveyRecipientImportRequest setCampaignId(Integer value) { this.campaignId = value; return this; }
        public ArrayList<SurveyRecipientImportRow> getRows() { return rows; }
        public SurveyRecipientImportRequest setRows(ArrayList<SurveyRecipientImportRow> value) { this.rows = value; return this; }
    }

    public static class SurveyRecipientImportRow
    {
        public String email = null;
        public String segment = null;
        public String surveyUrl = null;
        
        public String getEmail() { return email; }
        public SurveyRecipientImportRow setEmail(String value) { this.email = value; return this; }
        public String getSegment() { return segment; }
        public SurveyRecipientImportRow setSegment(String value) { this.segment = value; return this; }
        public String getSurveyUrl() { return surveyUrl; }
        public SurveyRecipientImportRow setSurveyUrl(String value) { this.surveyUrl = value; return this; }
    }

    public static class SurveyRecipientImportResult
    {
        public Integer inserted = null;
        public Integer skipped = null;
        public Integer invalid = null;
        public ArrayList<String> invalidRows = null;
        public Integer statusCode = null;
        public String message = null;
        
        public Integer getInserted() { return inserted; }
        public SurveyRecipientImportResult setInserted(Integer value) { this.inserted = value; return this; }
        public Integer getSkipped() { return skipped; }
        public SurveyRecipientImportResult setSkipped(Integer value) { this.skipped = value; return this; }
        public Integer getInvalid() { return invalid; }
        public SurveyRecipientImportResult setInvalid(Integer value) { this.invalid = value; return this; }
        public ArrayList<String> getInvalidRows() { return invalidRows; }
        public SurveyRecipientImportResult setInvalidRows(ArrayList<String> value) { this.invalidRows = value; return this; }
        public Integer getStatusCode() { return statusCode; }
        public SurveyRecipientImportResult setStatusCode(Integer value) { this.statusCode = value; return this; }
        public String getMessage() { return message; }
        public SurveyRecipientImportResult setMessage(String value) { this.message = value; return this; }
    }

}

Java SurveyRecipientImportRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /SurveyCampaign/{CampaignId}/Recipients HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SurveyRecipientImportRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <CampaignId>0</CampaignId>
  <Rows>
    <SurveyRecipientImportRow>
      <Email>String</Email>
      <Segment>String</Segment>
      <SurveyUrl>String</SurveyUrl>
    </SurveyRecipientImportRow>
  </Rows>
</SurveyRecipientImportRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SurveyRecipientImportResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <Inserted>0</Inserted>
  <Invalid>0</Invalid>
  <InvalidRows xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </InvalidRows>
  <Message>String</Message>
  <Skipped>0</Skipped>
  <StatusCode>0</StatusCode>
</SurveyRecipientImportResult>