TicketUserServices

SurveyCampaignCreateRequest

**Requires Authentication**
Required role:	Admin

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

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SurveyCampaign:
    id: Optional[int] = None
    # @StringLength(200)
    name: Optional[str] = None

    # @StringLength(16)
    status: Optional[str] = None

    # @StringLength(300)
    subject: Optional[str] = None

    # @StringLength(2147483647)
    body_html: Optional[str] = None

    # @StringLength(300)
    reminder_subject: Optional[str] = None

    # @StringLength(2147483647)
    reminder_body_html: Optional[str] = None

    # @StringLength(320)
    from_email: Optional[str] = None

    # @StringLength(200)
    from_name: Optional[str] = None

    # @StringLength(8)
    language: Optional[str] = None

    reminder_after_days: Optional[int] = None
    max_reminders: Optional[int] = None
    created_at: Optional[datetime.datetime] = None
    sent_at: Optional[datetime.datetime] = None
    closed_at: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SurveyCampaignStats:
    recipients: Optional[int] = None
    pending: Optional[int] = None
    queued: Optional[int] = None
    sent: Optional[int] = None
    bounced: Optional[int] = None
    rejected: Optional[int] = None
    opened: Optional[int] = None
    clicked: Optional[int] = None
    responded: Optional[int] = None
    reminders_sent: Optional[int] = None
    due_for_reminder: Optional[int] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SurveyCampaignResult:
    item: Optional[SurveyCampaign] = None
    stats: Optional[SurveyCampaignStats] = None
    status_code: Optional[int] = None
    message: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SurveyCampaignCreateRequest:
    item: Optional[SurveyCampaign] = None

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