TicketUserServices

<back to all web services

SurveyCampaignGetRequest

Requires Authentication
Required role:Admin
The following routes are available for this service:
GET/SurveyCampaign/{Id}
import java.math.*
import java.util.*
import net.servicestack.client.*


open class SurveyCampaignGetRequest
{
    var id:Int? = null
}

open class SurveyCampaignResult
{
    var item:SurveyCampaign? = null
    var stats:SurveyCampaignStats? = null
    var statusCode:Int? = null
    var message:String? = null
}

open class SurveyCampaign
{
    var id:Int? = null
    @StringLength(200)
    var name:String? = null

    @StringLength(16)
    var status:String? = null

    @StringLength(300)
    var subject:String? = null

    @StringLength(2147483647)
    var bodyHtml:String? = null

    @StringLength(300)
    var reminderSubject:String? = null

    @StringLength(2147483647)
    var reminderBodyHtml:String? = null

    @StringLength(320)
    var fromEmail:String? = null

    @StringLength(200)
    var fromName:String? = null

    @StringLength(8)
    var language:String? = null

    var reminderAfterDays:Int? = null
    var maxReminders:Int? = null
    var createdAt:Date? = null
    var sentAt:Date? = null
    var closedAt:Date? = null
}

open class SurveyCampaignStats
{
    var recipients:Int? = null
    var pending:Int? = null
    var queued:Int? = null
    var sent:Int? = null
    var bounced:Int? = null
    var rejected:Int? = null
    var opened:Int? = null
    var clicked:Int? = null
    var responded:Int? = null
    var remindersSent:Int? = null
    var dueForReminder:Int? = null
}

Kotlin SurveyCampaignGetRequest 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.

GET /SurveyCampaign/{Id} HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	item: 
	{
		id: 0,
		name: String,
		status: String,
		subject: String,
		bodyHtml: String,
		reminderSubject: String,
		reminderBodyHtml: String,
		fromEmail: String,
		fromName: String,
		language: String,
		reminderAfterDays: 0,
		maxReminders: 0,
		createdAt: 0001-01-01,
		sentAt: 0001-01-01,
		closedAt: 0001-01-01
	},
	stats: 
	{
		recipients: 0,
		pending: 0,
		queued: 0,
		sent: 0,
		bounced: 0,
		rejected: 0,
		opened: 0,
		clicked: 0,
		responded: 0,
		remindersSent: 0,
		dueForReminder: 0
	},
	statusCode: 0,
	message: String
}