TicketUserServices

<back to all web services

OutboundEnqueueBatchRequest

Requires Authentication
Required role:Admin
The following routes are available for this service:
POST/Outbound/EnqueueBatch
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using TicketUserServices.ServiceModel;

namespace TicketUserServices.ServiceModel
{
    public partial class OutboundEnqueueBatchRejection
    {
        public virtual int Index { get; set; }
        public virtual string DedupKey { get; set; }
        public virtual string Reason { get; set; }
    }

    public partial class OutboundEnqueueBatchRequest
    {
        public OutboundEnqueueBatchRequest()
        {
            Messages = new List<OutboundEnqueueRequest>{};
        }

        public virtual List<OutboundEnqueueRequest> Messages { get; set; }
    }

    public partial class OutboundEnqueueBatchResult
    {
        public OutboundEnqueueBatchResult()
        {
            Rejections = new List<OutboundEnqueueBatchRejection>{};
        }

        public virtual int Enqueued { get; set; }
        public virtual int Duplicate { get; set; }
        public virtual int Rejected { get; set; }
        public virtual List<OutboundEnqueueBatchRejection> Rejections { get; set; }
        public virtual int StatusCode { get; set; }
        public virtual string Message { get; set; }
    }

    public partial class OutboundEnqueueRequest
    {
        public virtual string Channel { get; set; }
        public virtual string Lane { get; set; }
        public virtual int Priority { get; set; }
        public virtual string Address { get; set; }
        public virtual string Platform { get; set; }
        public virtual string RecipientKey { get; set; }
        public virtual string TemplateKey { get; set; }
        public virtual string Language { get; set; }
        public virtual string PayloadJson { get; set; }
        public virtual string DedupKey { get; set; }
        public virtual int? CampaignId { get; set; }
        public virtual int? OwnerId { get; set; }
        public virtual string GuardKey { get; set; }
        public virtual string GuardSubject { get; set; }
        public virtual DateTime? NotBefore { get; set; }
        public virtual DateTime? ExpiresAt { get; set; }
    }

}

C# 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
}