TicketUserServices

OutboundEnqueueBatchRequest

**Requires Authentication**
Required role:	Admin

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

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 OutboundEnqueueBatchRejection
            Public Overridable Property Index As Integer
            Public Overridable Property DedupKey As String
            Public Overridable Property Reason As String
        End Class

        Public Partial Class OutboundEnqueueBatchRequest
            Public Sub New()
                Messages = New List(Of OutboundEnqueueRequest)
            End Sub

            Public Overridable Property Messages As List(Of OutboundEnqueueRequest)
        End Class

        Public Partial Class OutboundEnqueueBatchResult
            Public Sub New()
                Rejections = New List(Of OutboundEnqueueBatchRejection)
            End Sub

            Public Overridable Property Enqueued As Integer
            Public Overridable Property Duplicate As Integer
            Public Overridable Property Rejected As Integer
            Public Overridable Property Rejections As List(Of OutboundEnqueueBatchRejection)
            Public Overridable Property StatusCode As Integer
            Public Overridable Property Message As String
        End Class

        Public Partial Class OutboundEnqueueRequest
            Public Overridable Property Channel As String
            Public Overridable Property Lane As String
            Public Overridable Property Priority As Integer
            Public Overridable Property Address As String
            Public Overridable Property Platform As String
            Public Overridable Property RecipientKey As String
            Public Overridable Property TemplateKey As String
            Public Overridable Property Language As String
            Public Overridable Property PayloadJson As String
            Public Overridable Property DedupKey As String
            Public Overridable Property CampaignId As Nullable(Of Integer)
            Public Overridable Property OwnerId As Nullable(Of Integer)
            Public Overridable Property GuardKey As String
            Public Overridable Property GuardSubject As String
            Public Overridable Property NotBefore As Nullable(Of Date)
            Public Overridable Property ExpiresAt As Nullable(Of Date)
        End Class
    End Namespace
End Namespace

VB.NET OutboundEnqueueBatchRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

{"messages":[{"channel":"String","lane":"String","priority":0,"address":"String","platform":"String","recipientKey":"String","templateKey":"String","language":"String","payloadJson":"String","dedupKey":"String","campaignId":0,"ownerId":0,"guardKey":"String","guardSubject":"String","notBefore":"0001-01-01T00:00:00.0000000","expiresAt":"0001-01-01T00:00:00.0000000"}]}

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

{"enqueued":0,"duplicate":0,"rejected":0,"rejections":[{"index":0,"dedupKey":"String","reason":"String"}],"statusCode":0,"message":"String"}