TicketUserServices

OutboundEnqueueBatchRequest

**Requires Authentication**
Required role:	Admin

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

import java.math.*
import java.util.*
import net.servicestack.client.*


open class OutboundEnqueueBatchRequest
{
    var messages:ArrayList<OutboundEnqueueRequest> = ArrayList<OutboundEnqueueRequest>()
}

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

open class OutboundEnqueueBatchResult
{
    var enqueued:Int? = null
    var duplicate:Int? = null
    var rejected:Int? = null
    var rejections:ArrayList<OutboundEnqueueBatchRejection> = ArrayList<OutboundEnqueueBatchRejection>()
    var statusCode:Int? = null
    var message:String? = null
}

open class OutboundEnqueueBatchRejection
{
    var index:Int? = null
    var dedupKey:String? = null
    var reason:String? = null
}

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