TicketUserServices

<back to all web services

CampaignConversionRunRequest

The following routes are available for this service:
POST/CampaignConversions/Run
import Foundation
import ServiceStack

public class CampaignConversionRunRequest : Codable
{
    public var campaignId:Int?
    public var people:[CampaignConversionPerson] = []
    public var windowHours:Int?
    public var targetEventId:Int?
    public var includeFood:Bool?

    required public init(){}
}

public class CampaignConversionPerson : Codable
{
    public var phone:String?
    public var email:String?
    public var recipientId:Int?
    public var channel:String?
    public var sentAt:Date?

    required public init(){}
}

public class CampaignConversionResult : Codable
{
    public var runId:String?
    public var peopleMeasured:Int?
    public var peopleConverted:Int?
    public var totalAmount:Double?
    public var bySurface:[CampaignConversionSurfaceCount] = []
    public var byChannel:[CampaignConversionSurfaceCount] = []
    public var headlineConversions:Int?
    public var headlineAmount:Double?
    public var medianHoursToConvert:Int?
    public var notes:[String] = []
    public var statusCode:Int?
    public var message:String?

    required public init(){}
}

public class CampaignConversionSurfaceCount : Codable
{
    public var key:String?
    public var people:Int?
    public var count:Int?
    public var amount:Double?

    required public init(){}
}


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

<CampaignConversionRunRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <CampaignId>0</CampaignId>
  <IncludeFood>false</IncludeFood>
  <People>
    <CampaignConversionPerson>
      <Channel>String</Channel>
      <Email>String</Email>
      <Phone>String</Phone>
      <RecipientId>0</RecipientId>
      <SentAt>0001-01-01T00:00:00</SentAt>
    </CampaignConversionPerson>
  </People>
  <TargetEventId>0</TargetEventId>
  <WindowHours>0</WindowHours>
</CampaignConversionRunRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CampaignConversionResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <ByChannel>
    <CampaignConversionSurfaceCount>
      <Amount>0</Amount>
      <Count>0</Count>
      <Key>String</Key>
      <People>0</People>
    </CampaignConversionSurfaceCount>
  </ByChannel>
  <BySurface>
    <CampaignConversionSurfaceCount>
      <Amount>0</Amount>
      <Count>0</Count>
      <Key>String</Key>
      <People>0</People>
    </CampaignConversionSurfaceCount>
  </BySurface>
  <HeadlineAmount>0</HeadlineAmount>
  <HeadlineConversions>0</HeadlineConversions>
  <MedianHoursToConvert>0</MedianHoursToConvert>
  <Message>String</Message>
  <Notes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Notes>
  <PeopleConverted>0</PeopleConverted>
  <PeopleMeasured>0</PeopleMeasured>
  <RunId>String</RunId>
  <StatusCode>0</StatusCode>
  <TotalAmount>0</TotalAmount>
</CampaignConversionResult>