| Required role: | Admin |
| 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 .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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/json
Content-Type: application/json
Content-Length: length
{"item":{"id":0,"name":"String","status":"String","subject":"String","bodyHtml":"String","reminderSubject":"String","reminderBodyHtml":"String","fromEmail":"String","fromName":"String","language":"String","reminderAfterDays":0,"maxReminders":0,"createdAt":"0001-01-01T00:00:00.0000000","sentAt":"0001-01-01T00:00:00.0000000","closedAt":"0001-01-01T00:00:00.0000000"}}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"item":{"id":0,"name":"String","status":"String","subject":"String","bodyHtml":"String","reminderSubject":"String","reminderBodyHtml":"String","fromEmail":"String","fromName":"String","language":"String","reminderAfterDays":0,"maxReminders":0,"createdAt":"0001-01-01T00:00:00.0000000","sentAt":"0001-01-01T00:00:00.0000000","closedAt":"0001-01-01T00:00:00.0000000"},"stats":{"recipients":0,"pending":0,"queued":0,"sent":0,"bounced":0,"rejected":0,"opened":0,"clicked":0,"responded":0,"remindersSent":0,"dueForReminder":0},"statusCode":0,"message":"String"}