TicketUserServices

OutboundEnqueueBatchRequest

**Requires Authentication**
Required role:	Admin

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

import Foundation
import ServiceStack

public class OutboundEnqueueBatchRequest : Codable
{
    public var messages:[OutboundEnqueueRequest] = []

    required public init(){}
}

public class OutboundEnqueueRequest : Codable
{
    public var channel:String?
    public var lane:String?
    public var priority:Int?
    public var address:String?
    public var platform:String?
    public var recipientKey:String?
    public var templateKey:String?
    public var language:String?
    public var payloadJson:String?
    public var dedupKey:String?
    public var campaignId:Int?
    public var ownerId:Int?
    public var guardKey:String?
    public var guardSubject:String?
    public var notBefore:Date?
    public var expiresAt:Date?

    required public init(){}
}

public class OutboundEnqueueBatchResult : Codable
{
    public var enqueued:Int?
    public var duplicate:Int?
    public var rejected:Int?
    public var rejections:[OutboundEnqueueBatchRejection] = []
    public var statusCode:Int?
    public var message:String?

    required public init(){}
}

public class OutboundEnqueueBatchRejection : Codable
{
    public var index:Int?
    public var dedupKey:String?
    public var reason:String?

    required public init(){}
}

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

<OutboundEnqueueBatchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <Messages>
    <OutboundEnqueueRequest>
      <Address>String</Address>
      <CampaignId>0</CampaignId>
      <Channel>String</Channel>
      <DedupKey>String</DedupKey>
      <ExpiresAt>0001-01-01T00:00:00</ExpiresAt>
      <GuardKey>String</GuardKey>
      <GuardSubject>String</GuardSubject>
      <Lane>String</Lane>
      <Language>String</Language>
      <NotBefore>0001-01-01T00:00:00</NotBefore>
      <OwnerId>0</OwnerId>
      <PayloadJson>String</PayloadJson>
      <Platform>String</Platform>
      <Priority>0</Priority>
      <RecipientKey>String</RecipientKey>
      <TemplateKey>String</TemplateKey>
    </OutboundEnqueueRequest>
  </Messages>
</OutboundEnqueueBatchRequest>

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

<OutboundEnqueueBatchResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <Duplicate>0</Duplicate>
  <Enqueued>0</Enqueued>
  <Message>String</Message>
  <Rejected>0</Rejected>
  <Rejections>
    <OutboundEnqueueBatchRejection>
      <DedupKey>String</DedupKey>
      <Index>0</Index>
      <Reason>String</Reason>
    </OutboundEnqueueBatchRejection>
  </Rejections>
  <StatusCode>0</StatusCode>
</OutboundEnqueueBatchResult>