TicketUserServices

<back to all web services

CampaignConversionRunRequest

The following routes are available for this service:
POST/CampaignConversions/Run
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using TicketUserServices.ServiceModel;

namespace TicketUserServices.ServiceModel
{
    public partial class CampaignConversionPerson
    {
        public virtual string Phone { get; set; }
        public virtual string Email { get; set; }
        public virtual int? RecipientId { get; set; }
        public virtual string Channel { get; set; }
        public virtual DateTime SentAt { get; set; }
    }

    public partial class CampaignConversionResult
    {
        public CampaignConversionResult()
        {
            BySurface = new List<CampaignConversionSurfaceCount>{};
            ByChannel = new List<CampaignConversionSurfaceCount>{};
            Notes = new List<string>{};
        }

        public virtual string RunId { get; set; }
        public virtual int PeopleMeasured { get; set; }
        public virtual int PeopleConverted { get; set; }
        public virtual decimal TotalAmount { get; set; }
        public virtual List<CampaignConversionSurfaceCount> BySurface { get; set; }
        public virtual List<CampaignConversionSurfaceCount> ByChannel { get; set; }
        public virtual int HeadlineConversions { get; set; }
        public virtual decimal HeadlineAmount { get; set; }
        public virtual int MedianHoursToConvert { get; set; }
        public virtual List<string> Notes { get; set; }
        public virtual int StatusCode { get; set; }
        public virtual string Message { get; set; }
    }

    public partial class CampaignConversionRunRequest
    {
        public CampaignConversionRunRequest()
        {
            People = new List<CampaignConversionPerson>{};
        }

        public virtual int CampaignId { get; set; }
        public virtual List<CampaignConversionPerson> People { get; set; }
        public virtual int WindowHours { get; set; }
        public virtual int? TargetEventId { get; set; }
        public virtual bool IncludeFood { get; set; }
    }

    public partial class CampaignConversionSurfaceCount
    {
        public virtual string Key { get; set; }
        public virtual int People { get; set; }
        public virtual int Count { get; set; }
        public virtual decimal Amount { get; set; }
    }

}

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

{"campaignId":0,"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"}