TicketUserServices

SurveyCampaignCreateRequest

**Requires Authentication**
Required role:	Admin

The following routes are available for this service:
POST	/SurveyCampaign


export class SurveyCampaign
{
    public id?: number;
    // @StringLength(200)
    public name?: string;

    // @StringLength(16)
    public status?: string;

    // @StringLength(300)
    public subject?: string;

    // @StringLength(2147483647)
    public bodyHtml?: string;

    // @StringLength(300)
    public reminderSubject?: string;

    // @StringLength(2147483647)
    public reminderBodyHtml?: string;

    // @StringLength(320)
    public fromEmail?: string;

    // @StringLength(200)
    public fromName?: string;

    // @StringLength(8)
    public language?: string;

    public reminderAfterDays?: number;
    public maxReminders?: number;
    public createdAt?: string;
    public sentAt?: string;
    public closedAt?: string;

    public constructor(init?: Partial<SurveyCampaign>) { (Object as any).assign(this, init); }
}

export class SurveyCampaignStats
{
    public recipients?: number;
    public pending?: number;
    public queued?: number;
    public sent?: number;
    public bounced?: number;
    public rejected?: number;
    public opened?: number;
    public clicked?: number;
    public responded?: number;
    public remindersSent?: number;
    public dueForReminder?: number;

    public constructor(init?: Partial<SurveyCampaignStats>) { (Object as any).assign(this, init); }
}

export class SurveyCampaignResult
{
    public item?: SurveyCampaign;
    public stats?: SurveyCampaignStats;
    public statusCode?: number;
    public message?: string;

    public constructor(init?: Partial<SurveyCampaignResult>) { (Object as any).assign(this, init); }
}

export class SurveyCampaignCreateRequest
{
    public item?: SurveyCampaign;

    public constructor(init?: Partial<SurveyCampaignCreateRequest>) { (Object as any).assign(this, init); }
}

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

POST /SurveyCampaign HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SurveyCampaignCreateRequest 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>
</SurveyCampaignCreateRequest>

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>