TicketUserServices

<back to all web services

CampaignConversionRunRequest

The following routes are available for this service:
POST/CampaignConversions/Run
CampaignConversionRunRequest Parameters:
NameParameterData TypeRequiredDescription
CampaignIdbodyintNo
PeoplebodyList<CampaignConversionPerson>No
WindowHoursbodyintNo
TargetEventIdbodyint?No
IncludeFoodbodyboolNo
CampaignConversionPerson Parameters:
NameParameterData TypeRequiredDescription
PhoneformstringNo
EmailformstringNo
RecipientIdformint?No
ChannelformstringNo
SentAtformDateTimeNo
CampaignConversionResult Parameters:
NameParameterData TypeRequiredDescription
RunIdformstringNo
PeopleMeasuredformintNo
PeopleConvertedformintNo
TotalAmountformdecimalNo
BySurfaceformList<CampaignConversionSurfaceCount>No
ByChannelformList<CampaignConversionSurfaceCount>No
HeadlineConversionsformintNo
HeadlineAmountformdecimalNo
MedianHoursToConvertformintNo
NotesformList<string>No
StatusCodeformintNo
MessageformstringNo
CampaignConversionSurfaceCount Parameters:
NameParameterData TypeRequiredDescription
KeyformstringNo
PeopleformintNo
CountformintNo
AmountformdecimalNo

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>