TicketUserServices

<back to all web services

SurveyCampaignListRequest

Requires Authentication
Required role:Admin
The following routes are available for this service:
GET/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 SurveyCampaignListResult:
    items: Optional[List[SurveyCampaign]] = None
    status_code: Optional[int] = None
    message: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SurveyCampaignListRequest:
    status: Optional[str] = None

Python SurveyCampaignListRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /SurveyCampaign HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"items":[{"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"}],"statusCode":0,"message":"String"}