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 .csv suffix or ?format=csv

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{"campaignId":0,"rows":[{"email":"String","segment":"String","surveyUrl":"String"}]}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"inserted":0,"skipped":0,"invalid":0,"invalidRows":["String"],"statusCode":0,"message":"String"}