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