TicketUserServices

<back to all web services

SurveyCampaignSendRequest

Requires Authentication
Required role:Admin
The following routes are available for this service:
POST/SurveyCampaign/{CampaignId}/Send
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 SurveyCampaignSendResult:
    queued: Optional[int] = None
    skipped: Optional[int] = None
    remaining: Optional[int] = None
    status_code: Optional[int] = None
    message: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SurveyCampaignSendRequest:
    campaign_id: Optional[int] = None
    limit: Optional[int] = None
    test_mode: Optional[bool] = None
    test_emails: Optional[List[str]] = None
    use_engine: Optional[bool] = None

Python SurveyCampaignSendRequest 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/{CampaignId}/Send HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SurveyCampaignSendRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <CampaignId>0</CampaignId>
  <Limit>0</Limit>
  <TestEmails xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </TestEmails>
  <TestMode>false</TestMode>
  <UseEngine>false</UseEngine>
</SurveyCampaignSendRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SurveyCampaignSendResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <Message>String</Message>
  <Queued>0</Queued>
  <Remaining>0</Remaining>
  <Skipped>0</Skipped>
  <StatusCode>0</StatusCode>
</SurveyCampaignSendResult>