TicketUserServices

<back to all web services

CampaignConversionPreviewRequest

The following routes are available for this service:
POST/CampaignConversions/Preview
namespace TicketUserServices.ServiceModel

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type CampaignConversionSurfaceCount() = 
        member val Key:String = null with get,set
        member val People:Int32 = new Int32() with get,set
        member val Count:Int32 = new Int32() with get,set
        member val Amount:Decimal = new Decimal() with get,set

    [<AllowNullLiteral>]
    type CampaignConversionResult() = 
        member val RunId:String = null with get,set
        member val PeopleMeasured:Int32 = new Int32() with get,set
        member val PeopleConverted:Int32 = new Int32() with get,set
        member val TotalAmount:Decimal = new Decimal() with get,set
        member val BySurface:ResizeArray<CampaignConversionSurfaceCount> = new ResizeArray<CampaignConversionSurfaceCount>() with get,set
        member val ByChannel:ResizeArray<CampaignConversionSurfaceCount> = new ResizeArray<CampaignConversionSurfaceCount>() with get,set
        member val HeadlineConversions:Int32 = new Int32() with get,set
        member val HeadlineAmount:Decimal = new Decimal() with get,set
        member val MedianHoursToConvert:Int32 = new Int32() with get,set
        member val Notes:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val StatusCode:Int32 = new Int32() with get,set
        member val Message:String = null with get,set

    [<AllowNullLiteral>]
    type CampaignConversionPerson() = 
        member val Phone:String = null with get,set
        member val Email:String = null with get,set
        member val RecipientId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Channel:String = null with get,set
        member val SentAt:DateTime = new DateTime() with get,set

    [<AllowNullLiteral>]
    type CampaignConversionPreviewRequest() = 
        member val People:ResizeArray<CampaignConversionPerson> = new ResizeArray<CampaignConversionPerson>() with get,set
        member val WindowHours:Int32 = new Int32() with get,set
        member val TargetEventId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val IncludeFood:Boolean = new Boolean() with get,set

F# CampaignConversionPreviewRequest 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/Preview HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CampaignConversionPreviewRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <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>
</CampaignConversionPreviewRequest>
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>