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.*


open class SurveyRecipientImportRequest
{
    var campaignId:Int? = null
    var rows:ArrayList<SurveyRecipientImportRow> = ArrayList<SurveyRecipientImportRow>()
}

open class SurveyRecipientImportRow
{
    var email:String? = null
    var segment:String? = null
    var surveyUrl:String? = null
}

open class SurveyRecipientImportResult
{
    var inserted:Int? = null
    var skipped:Int? = null
    var invalid:Int? = null
    var invalidRows:ArrayList<String> = ArrayList<String>()
    var statusCode:Int? = null
    var message:String? = null
}

Kotlin 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>