TicketUserServices

<back to all web services

SurveyCampaignSendRequest

Requires Authentication
Required role:Admin
The following routes are available for this service:
POST/SurveyCampaign/{CampaignId}/Send
namespace TicketUserServices.ServiceModel

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

    [<AllowNullLiteral>]
    type SurveyCampaignSendResult() = 
        member val Queued:Int32 = new Int32() with get,set
        member val Skipped:Int32 = new Int32() with get,set
        member val Remaining:Int32 = new Int32() with get,set
        member val StatusCode:Int32 = new Int32() with get,set
        member val Message:String = null with get,set

    [<AllowNullLiteral>]
    type SurveyCampaignSendRequest() = 
        member val CampaignId:Int32 = new Int32() with get,set
        member val Limit:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val TestMode:Boolean = new Boolean() with get,set
        member val TestEmails:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val UseEngine:Nullable<Boolean> = new Nullable<Boolean>() with get,set

F# SurveyCampaignSendRequest 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 /SurveyCampaign/{CampaignId}/Send HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	campaignId: 0,
	limit: 0,
	testMode: False,
	testEmails: 
	[
		String
	],
	useEngine: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	queued: 0,
	skipped: 0,
	remaining: 0,
	statusCode: 0,
	message: String
}