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

public class dtos
{

    public static class SurveyCampaignGetRequest
    {
        public Integer id = null;
        
        public Integer getId() { return id; }
        public SurveyCampaignGetRequest setId(Integer value) { this.id = value; return this; }
    }

    public static class SurveyCampaignResult
    {
        public SurveyCampaign item = null;
        public SurveyCampaignStats stats = null;
        public Integer statusCode = null;
        public String message = null;
        
        public SurveyCampaign getItem() { return item; }
        public SurveyCampaignResult setItem(SurveyCampaign value) { this.item = value; return this; }
        public SurveyCampaignStats getStats() { return stats; }
        public SurveyCampaignResult setStats(SurveyCampaignStats value) { this.stats = value; return this; }
        public Integer getStatusCode() { return statusCode; }
        public SurveyCampaignResult setStatusCode(Integer value) { this.statusCode = value; return this; }
        public String getMessage() { return message; }
        public SurveyCampaignResult setMessage(String value) { this.message = value; return this; }
    }

    public static class SurveyCampaign
    {
        public Integer id = null;
        @StringLength(200)
        public String name = null;

        @StringLength(16)
        public String status = null;

        @StringLength(300)
        public String subject = null;

        @StringLength(2147483647)
        public String bodyHtml = null;

        @StringLength(300)
        public String reminderSubject = null;

        @StringLength(2147483647)
        public String reminderBodyHtml = null;

        @StringLength(320)
        public String fromEmail = null;

        @StringLength(200)
        public String fromName = null;

        @StringLength(8)
        public String language = null;

        public Integer reminderAfterDays = null;
        public Integer maxReminders = null;
        public Date createdAt = null;
        public Date sentAt = null;
        public Date closedAt = null;
        
        public Integer getId() { return id; }
        public SurveyCampaign setId(Integer value) { this.id = value; return this; }
        public String getName() { return name; }
        public SurveyCampaign setName(String value) { this.name = value; return this; }
        public String getStatus() { return status; }
        public SurveyCampaign setStatus(String value) { this.status = value; return this; }
        public String getSubject() { return subject; }
        public SurveyCampaign setSubject(String value) { this.subject = value; return this; }
        public String getBodyHtml() { return bodyHtml; }
        public SurveyCampaign setBodyHtml(String value) { this.bodyHtml = value; return this; }
        public String getReminderSubject() { return reminderSubject; }
        public SurveyCampaign setReminderSubject(String value) { this.reminderSubject = value; return this; }
        public String getReminderBodyHtml() { return reminderBodyHtml; }
        public SurveyCampaign setReminderBodyHtml(String value) { this.reminderBodyHtml = value; return this; }
        public String getFromEmail() { return fromEmail; }
        public SurveyCampaign setFromEmail(String value) { this.fromEmail = value; return this; }
        public String getFromName() { return fromName; }
        public SurveyCampaign setFromName(String value) { this.fromName = value; return this; }
        public String getLanguage() { return language; }
        public SurveyCampaign setLanguage(String value) { this.language = value; return this; }
        public Integer getReminderAfterDays() { return reminderAfterDays; }
        public SurveyCampaign setReminderAfterDays(Integer value) { this.reminderAfterDays = value; return this; }
        public Integer getMaxReminders() { return maxReminders; }
        public SurveyCampaign setMaxReminders(Integer value) { this.maxReminders = value; return this; }
        public Date getCreatedAt() { return createdAt; }
        public SurveyCampaign setCreatedAt(Date value) { this.createdAt = value; return this; }
        public Date getSentAt() { return sentAt; }
        public SurveyCampaign setSentAt(Date value) { this.sentAt = value; return this; }
        public Date getClosedAt() { return closedAt; }
        public SurveyCampaign setClosedAt(Date value) { this.closedAt = value; return this; }
    }

    public static class SurveyCampaignStats
    {
        public Integer recipients = null;
        public Integer pending = null;
        public Integer queued = null;
        public Integer sent = null;
        public Integer bounced = null;
        public Integer rejected = null;
        public Integer opened = null;
        public Integer clicked = null;
        public Integer responded = null;
        public Integer remindersSent = null;
        public Integer dueForReminder = null;
        
        public Integer getRecipients() { return recipients; }
        public SurveyCampaignStats setRecipients(Integer value) { this.recipients = value; return this; }
        public Integer getPending() { return pending; }
        public SurveyCampaignStats setPending(Integer value) { this.pending = value; return this; }
        public Integer getQueued() { return queued; }
        public SurveyCampaignStats setQueued(Integer value) { this.queued = value; return this; }
        public Integer getSent() { return sent; }
        public SurveyCampaignStats setSent(Integer value) { this.sent = value; return this; }
        public Integer getBounced() { return bounced; }
        public SurveyCampaignStats setBounced(Integer value) { this.bounced = value; return this; }
        public Integer getRejected() { return rejected; }
        public SurveyCampaignStats setRejected(Integer value) { this.rejected = value; return this; }
        public Integer getOpened() { return opened; }
        public SurveyCampaignStats setOpened(Integer value) { this.opened = value; return this; }
        public Integer getClicked() { return clicked; }
        public SurveyCampaignStats setClicked(Integer value) { this.clicked = value; return this; }
        public Integer getResponded() { return responded; }
        public SurveyCampaignStats setResponded(Integer value) { this.responded = value; return this; }
        public Integer getRemindersSent() { return remindersSent; }
        public SurveyCampaignStats setRemindersSent(Integer value) { this.remindersSent = value; return this; }
        public Integer getDueForReminder() { return dueForReminder; }
        public SurveyCampaignStats setDueForReminder(Integer value) { this.dueForReminder = value; return this; }
    }

}

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