TicketUserServices

<back to all web services

OutboundEnqueueBatchRequest

Requires Authentication
Required role:Admin
The following routes are available for this service:
POST/Outbound/EnqueueBatch
namespace TicketUserServices.ServiceModel

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type OutboundEnqueueBatchRejection() = 
        member val Index:Int32 = new Int32() with get,set
        member val DedupKey:String = null with get,set
        member val Reason:String = null with get,set

    [<AllowNullLiteral>]
    type OutboundEnqueueBatchResult() = 
        member val Enqueued:Int32 = new Int32() with get,set
        member val Duplicate:Int32 = new Int32() with get,set
        member val Rejected:Int32 = new Int32() with get,set
        member val Rejections:ResizeArray<OutboundEnqueueBatchRejection> = new ResizeArray<OutboundEnqueueBatchRejection>() with get,set
        member val StatusCode:Int32 = new Int32() with get,set
        member val Message:String = null with get,set

    [<AllowNullLiteral>]
    type OutboundEnqueueRequest() = 
        member val Channel:String = null with get,set
        member val Lane:String = null with get,set
        member val Priority:Int32 = new Int32() with get,set
        member val Address:String = null with get,set
        member val Platform:String = null with get,set
        member val RecipientKey:String = null with get,set
        member val TemplateKey:String = null with get,set
        member val Language:String = null with get,set
        member val PayloadJson:String = null with get,set
        member val DedupKey:String = null with get,set
        member val CampaignId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val OwnerId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val GuardKey:String = null with get,set
        member val GuardSubject:String = null with get,set
        member val NotBefore:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val ExpiresAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set

    [<AllowNullLiteral>]
    type OutboundEnqueueBatchRequest() = 
        member val Messages:ResizeArray<OutboundEnqueueRequest> = new ResizeArray<OutboundEnqueueRequest>() with get,set

F# OutboundEnqueueBatchRequest DTOs

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

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
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-01,
			expiresAt: 0001-01-01
		}
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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