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 .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 /CampaignConversions/Preview HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"people":[{"phone":"String","email":"String","recipientId":0,"channel":"String","sentAt":"0001-01-01T00:00:00.0000000"}],"windowHours":0,"targetEventId":0,"includeFood":false}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"runId":"String","peopleMeasured":0,"peopleConverted":0,"totalAmount":0,"bySurface":[{"key":"String","people":0,"count":0,"amount":0}],"byChannel":[{"key":"String","people":0,"count":0,"amount":0}],"headlineConversions":0,"headlineAmount":0,"medianHoursToConvert":0,"notes":["String"],"statusCode":0,"message":"String"}