TicketUserServices

<back to all web services

SurveyRecipientImportRequest

Requires Authentication
Required role:Admin
The following routes are available for this service:
POST/SurveyCampaign/{CampaignId}/Recipients
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 SurveyRecipientImportResult:
    inserted: Optional[int] = None
    skipped: Optional[int] = None
    invalid: Optional[int] = None
    invalid_rows: Optional[List[str]] = None
    status_code: Optional[int] = None
    message: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SurveyRecipientImportRow:
    email: Optional[str] = None
    segment: Optional[str] = None
    survey_url: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SurveyRecipientImportRequest:
    campaign_id: Optional[int] = None
    rows: Optional[List[SurveyRecipientImportRow]] = None

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

HTTP + JSON

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

POST /SurveyCampaign/{CampaignId}/Recipients HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"campaignId":0,"rows":[{"email":"String","segment":"String","surveyUrl":"String"}]}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"inserted":0,"skipped":0,"invalid":0,"invalidRows":["String"],"statusCode":0,"message":"String"}