| Requires any of the roles: | Client, Admin, Partner |
| GET | /campaign/responses/summary/{PublicAccessGuid} | Campaign Action Summary Responses |
|---|
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 CampaignActionInboxResponsesView:
id: Optional[int] = None
public_access_guid: Optional[str] = None
campaign_actions_id: int = 0
campaign_action_description: Optional[str] = None
action_type: Optional[str] = None
total_campaign_action_requests: Optional[int] = None
total_inbox_responses: Optional[int] = None
total_unique_responses: Optional[int] = None
response_percent: Optional[Decimal] = None
ca_public_access_guid: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CampaignActionPaymentResponsesView:
id: Optional[int] = None
public_access_guid: Optional[str] = None
campaign_actions_id: int = 0
campaign_action_description: Optional[str] = None
action_type: Optional[str] = None
total_campaign_action_requests: Optional[int] = None
total_payment_responses: Optional[int] = None
total_paid: Optional[float] = None
total_outstanding: Optional[float] = None
ca_public_access_guid: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CampaignCustomerVerificationsView:
id: Optional[int] = None
public_access_guid: Optional[str] = None
description: Optional[str] = None
total_verifications: Optional[int] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CampaignActionSummaryResponses:
campaign_action_inbox_responses: Optional[List[CampaignActionInboxResponsesView]] = None
campaign_action_payment_responses: Optional[List[CampaignActionPaymentResponsesView]] = None
campaign_customer_verification_responses: Optional[List[CampaignCustomerVerificationsView]] = None
response_status: Optional[ResponseStatus] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CampaignActionSummaryRequest:
# @Validate(Validator="NotNull")
public_access_guid: Optional[str] = None
Python CampaignActionSummaryRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /campaign/responses/summary/{PublicAccessGuid} HTTP/1.1
Host: duengageapi.uat.scadsoftware.com
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"campaignActionInboxResponses":[{"Id":0,"PublicAccessGuid":"00000000000000000000000000000000","CampaignActionsId":0,"CampaignActionDescription":"String","ActionType":"String","TotalCampaignActionRequests":0,"TotalInboxResponses":0,"TotalUniqueResponses":0,"ResponsePercent":0,"CaPublicAccessGuid":"00000000000000000000000000000000"}],"campaignActionPaymentResponses":[{"Id":0,"PublicAccessGuid":"00000000000000000000000000000000","CampaignActionsId":0,"CampaignActionDescription":"String","ActionType":"String","TotalCampaignActionRequests":0,"TotalPaymentResponses":0,"TotalPaid":0,"TotalOutstanding":0,"CaPublicAccessGuid":"00000000000000000000000000000000"}],"campaignCustomerVerificationResponses":[{"Id":0,"PublicAccessGuid":"00000000000000000000000000000000","Description":"String","TotalVerifications":0}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}