TicketUserServices

<back to all web services

OutboundEnqueueRequest

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

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

    [<AllowNullLiteral>]
    type OutboundEnqueueResult() = 
        member val Status:String = null with get,set
        member val MessageId:Nullable<Int64> = new Nullable<Int64>() with get,set
        member val Reason:String = null 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

F# OutboundEnqueueRequest 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/Enqueue HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<OutboundEnqueueRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <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>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<OutboundEnqueueResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <Message>String</Message>
  <MessageId>0</MessageId>
  <Reason>String</Reason>
  <Status>String</Status>
  <StatusCode>0</StatusCode>
</OutboundEnqueueResult>