TicketUserServices

OutboundCampaignCreateRequest

**Requires Authentication**
Required role:	Admin

The following routes are available for this service:
POST	/Outbound/Campaigns

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports TicketUserServices.ServiceModel

Namespace Global

    Namespace TicketUserServices.ServiceModel

        Public Partial Class OutboundCampaignCreateRequest
            Public Sub New()
                People = New List(Of OutboundCampaignPerson)
            End Sub

            Public Overridable Property OwnerId As Integer
            Public Overridable Property Name As String
            Public Overridable Property Lane As String
            Public Overridable Property TemplateKey As String
            Public Overridable Property PayloadJson As String
            Public Overridable Property ChannelOrder As String
            Public Overridable Property HoldoutPercent As Nullable(Of Integer)
            Public Overridable Property GuardKey As String
            Public Overridable Property GuardSubject As String
            Public Overridable Property SendAt As Nullable(Of Date)
            Public Overridable Property ExpiresAt As Nullable(Of Date)
            Public Overridable Property AudienceSource As String
            Public Overridable Property People As List(Of OutboundCampaignPerson)
        End Class

        Public Partial Class OutboundCampaignDevice
            Public Overridable Property Token As String
            Public Overridable Property Platform As String
        End Class

        Public Partial Class OutboundCampaignPerson
            Public Sub New()
                Devices = New List(Of OutboundCampaignDevice)
            End Sub

            Public Overridable Property Phone As String
            Public Overridable Property Email As String
            Public Overridable Property Devices As List(Of OutboundCampaignDevice)
            Public Overridable Property PushConsent As Nullable(Of Boolean)
            Public Overridable Property SmsConsent As Nullable(Of Boolean)
            Public Overridable Property EmailConsent As Nullable(Of Boolean)
            Public Overridable Property PayloadJson As String
        End Class

        Public Partial Class OutboundCampaignResult
            Public Sub New()
                Decisions = New Dictionary(Of String, Integer)
                QueuedByChannel = New Dictionary(Of String, Integer)
                MessageStatuses = New Dictionary(Of String, Integer)
            End Sub

            Public Overridable Property CampaignId As Integer
            Public Overridable Property Decisions As Dictionary(Of String, Integer)
            Public Overridable Property QueuedByChannel As Dictionary(Of String, Integer)
            Public Overridable Property MessageStatuses As Dictionary(Of String, Integer)
            Public Overridable Property Duplicates As Integer
            Public Overridable Property NoIdentity As Integer
            Public Overridable Property StatusCode As Integer
            Public Overridable Property Message As String
        End Class
    End Namespace
End Namespace

VB.NET OutboundCampaignCreateRequest 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 HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<OutboundCampaignCreateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <AudienceSource>String</AudienceSource>
  <ChannelOrder>String</ChannelOrder>
  <ExpiresAt>0001-01-01T00:00:00</ExpiresAt>
  <GuardKey>String</GuardKey>
  <GuardSubject>String</GuardSubject>
  <HoldoutPercent>0</HoldoutPercent>
  <Lane>String</Lane>
  <Name>String</Name>
  <OwnerId>0</OwnerId>
  <PayloadJson>String</PayloadJson>
  <People>
    <OutboundCampaignPerson>
      <Devices>
        <OutboundCampaignDevice>
          <Platform>String</Platform>
          <Token>String</Token>
        </OutboundCampaignDevice>
      </Devices>
      <Email>String</Email>
      <EmailConsent>false</EmailConsent>
      <PayloadJson>String</PayloadJson>
      <Phone>String</Phone>
      <PushConsent>false</PushConsent>
      <SmsConsent>false</SmsConsent>
    </OutboundCampaignPerson>
  </People>
  <SendAt>0001-01-01T00:00:00</SendAt>
  <TemplateKey>String</TemplateKey>
</OutboundCampaignCreateRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<OutboundCampaignResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <CampaignId>0</CampaignId>
  <Decisions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringint>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>0</d2p1:Value>
    </d2p1:KeyValueOfstringint>
  </Decisions>
  <Duplicates>0</Duplicates>
  <Message>String</Message>
  <MessageStatuses xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringint>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>0</d2p1:Value>
    </d2p1:KeyValueOfstringint>
  </MessageStatuses>
  <NoIdentity>0</NoIdentity>
  <QueuedByChannel xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringint>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>0</d2p1:Value>
    </d2p1:KeyValueOfstringint>
  </QueuedByChannel>
  <StatusCode>0</StatusCode>
</OutboundCampaignResult>