TicketUserServices

<back to all web services

SurveyCampaignGetRequest

Requires Authentication
Required role:Admin
The following routes are available for this service:
GET/SurveyCampaign/{Id}
import Foundation
import ServiceStack

public class SurveyCampaignGetRequest : Codable
{
    public var id:Int?

    required public init(){}
}

public class SurveyCampaignResult : Codable
{
    public var item:SurveyCampaign?
    public var stats:SurveyCampaignStats?
    public var statusCode:Int?
    public var message:String?

    required public init(){}
}

public class SurveyCampaign : Codable
{
    public var id:Int?
    // @StringLength(200)
    public var name:String?

    // @StringLength(16)
    public var status:String?

    // @StringLength(300)
    public var subject:String?

    // @StringLength(Int32.max)
    public var bodyHtml:String?

    // @StringLength(300)
    public var reminderSubject:String?

    // @StringLength(Int32.max)
    public var reminderBodyHtml:String?

    // @StringLength(320)
    public var fromEmail:String?

    // @StringLength(200)
    public var fromName:String?

    // @StringLength(8)
    public var language:String?

    public var reminderAfterDays:Int?
    public var maxReminders:Int?
    public var createdAt:Date?
    public var sentAt:Date?
    public var closedAt:Date?

    required public init(){}
}

public class SurveyCampaignStats : Codable
{
    public var recipients:Int?
    public var pending:Int?
    public var queued:Int?
    public var sent:Int?
    public var bounced:Int?
    public var rejected:Int?
    public var opened:Int?
    public var clicked:Int?
    public var responded:Int?
    public var remindersSent:Int?
    public var dueForReminder:Int?

    required public init(){}
}


Swift 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
}