TicketUserServices

<back to all web services

SurveyCampaignSendRequest

Requires Authentication
Required role:Admin
The following routes are available for this service:
POST/SurveyCampaign/{CampaignId}/Send
import Foundation
import ServiceStack

public class SurveyCampaignSendRequest : Codable
{
    public var campaignId:Int?
    public var limit:Int?
    public var testMode:Bool?
    public var testEmails:[String] = []
    public var useEngine:Bool?

    required public init(){}
}

public class SurveyCampaignSendResult : Codable
{
    public var queued:Int?
    public var skipped:Int?
    public var remaining:Int?
    public var statusCode:Int?
    public var message:String?

    required public init(){}
}


Swift SurveyCampaignSendRequest 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}/Send HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SurveyCampaignSendRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <CampaignId>0</CampaignId>
  <Limit>0</Limit>
  <TestEmails xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </TestEmails>
  <TestMode>false</TestMode>
  <UseEngine>false</UseEngine>
</SurveyCampaignSendRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SurveyCampaignSendResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <Message>String</Message>
  <Queued>0</Queued>
  <Remaining>0</Remaining>
  <Skipped>0</Skipped>
  <StatusCode>0</StatusCode>
</SurveyCampaignSendResult>