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

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

<SurveyCampaignResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <Item xmlns:d2p1="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel.Types">
    <d2p1:BodyHtml>String</d2p1:BodyHtml>
    <d2p1:ClosedAt>0001-01-01T00:00:00</d2p1:ClosedAt>
    <d2p1:CreatedAt>0001-01-01T00:00:00</d2p1:CreatedAt>
    <d2p1:FromEmail>String</d2p1:FromEmail>
    <d2p1:FromName>String</d2p1:FromName>
    <d2p1:ID>0</d2p1:ID>
    <d2p1:Language>String</d2p1:Language>
    <d2p1:MaxReminders>0</d2p1:MaxReminders>
    <d2p1:Name>String</d2p1:Name>
    <d2p1:ReminderAfterDays>0</d2p1:ReminderAfterDays>
    <d2p1:ReminderBodyHtml>String</d2p1:ReminderBodyHtml>
    <d2p1:ReminderSubject>String</d2p1:ReminderSubject>
    <d2p1:SentAt>0001-01-01T00:00:00</d2p1:SentAt>
    <d2p1:Status>String</d2p1:Status>
    <d2p1:Subject>String</d2p1:Subject>
  </Item>
  <Message>String</Message>
  <Stats>
    <Bounced>0</Bounced>
    <Clicked>0</Clicked>
    <DueForReminder>0</DueForReminder>
    <Opened>0</Opened>
    <Pending>0</Pending>
    <Queued>0</Queued>
    <Recipients>0</Recipients>
    <Rejected>0</Rejected>
    <RemindersSent>0</RemindersSent>
    <Responded>0</Responded>
    <Sent>0</Sent>
  </Stats>
  <StatusCode>0</StatusCode>
</SurveyCampaignResult>