TicketUserServices

CampaignConversionRunRequest

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


export class CampaignConversionSurfaceCount
{
    public key?: string;
    public people?: number;
    public count?: number;
    public amount?: number;

    public constructor(init?: Partial<CampaignConversionSurfaceCount>) { (Object as any).assign(this, init); }
}

export class CampaignConversionResult
{
    public runId?: string;
    public peopleMeasured?: number;
    public peopleConverted?: number;
    public totalAmount?: number;
    public bySurface?: CampaignConversionSurfaceCount[];
    public byChannel?: CampaignConversionSurfaceCount[];
    public headlineConversions?: number;
    public headlineAmount?: number;
    public medianHoursToConvert?: number;
    public notes?: string[];
    public statusCode?: number;
    public message?: string;

    public constructor(init?: Partial<CampaignConversionResult>) { (Object as any).assign(this, init); }
}

export class CampaignConversionPerson
{
    public phone?: string;
    public email?: string;
    public recipientId?: number;
    public channel?: string;
    public sentAt?: string;

    public constructor(init?: Partial<CampaignConversionPerson>) { (Object as any).assign(this, init); }
}

export class CampaignConversionRunRequest
{
    public campaignId?: number;
    public people?: CampaignConversionPerson[];
    public windowHours?: number;
    public targetEventId?: number;
    public includeFood?: boolean;

    public constructor(init?: Partial<CampaignConversionRunRequest>) { (Object as any).assign(this, init); }
}

TypeScript 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>