TicketUserServices

<back to all web services

OutboundCampaignConversionsRequest

Requires Authentication
Required role:Admin
The following routes are available for this service:
POST/Outbound/Campaigns/{CampaignId}/Conversions
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class OutboundCampaignConversionsResult:
    campaign_id: Optional[int] = None
    sent_people: Optional[int] = None
    sent_converted: Optional[int] = None
    sent_rate: Optional[Decimal] = None
    holdout_people: Optional[int] = None
    holdout_converted: Optional[int] = None
    holdout_rate: Optional[Decimal] = None
    lift_points: Optional[Decimal] = None
    note: Optional[str] = None
    status_code: Optional[int] = None
    message: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class OutboundCampaignConversionsRequest:
    campaign_id: Optional[int] = None
    window_hours: Optional[int] = None

Python OutboundCampaignConversionsRequest 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 /Outbound/Campaigns/{CampaignId}/Conversions HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<OutboundCampaignConversionsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <CampaignId>0</CampaignId>
  <WindowHours>0</WindowHours>
</OutboundCampaignConversionsRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<OutboundCampaignConversionsResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <CampaignId>0</CampaignId>
  <HoldoutConverted>0</HoldoutConverted>
  <HoldoutPeople>0</HoldoutPeople>
  <HoldoutRate>0</HoldoutRate>
  <LiftPoints>0</LiftPoints>
  <Message>String</Message>
  <Note>String</Note>
  <SentConverted>0</SentConverted>
  <SentPeople>0</SentPeople>
  <SentRate>0</SentRate>
  <StatusCode>0</StatusCode>
</OutboundCampaignConversionsResult>