digitaluapi

<back to all web services

GetCampaignActionFiles

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
GET/campaign/actions/filesGet Campaign Action Files
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 FormFieldOption:
    value: Optional[str] = None
    label: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormField:
    id: int = 0
    control_type: Optional[str] = None
    label: Optional[str] = None
    placeholder: Optional[str] = None
    help: Optional[str] = None
    name: Optional[str] = None
    sort_order: int = 0
    options: Optional[List[FormFieldOption]] = None
    validation: Optional[List[str]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CampaignActionFile:
    name: Optional[str] = None
    file_type: Optional[str] = None
    file_size: Optional[str] = None
    extension: Optional[str] = None
    upload_url: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CampaignActions:
    # @Required()
    id: int = 0

    # @Required()
    # @References(typeof(Campaigns))
    campaigns_id: int = 0

    # @References(typeof(Actions))
    actions_id: Optional[int] = None

    button_name: Optional[str] = None
    # @References(typeof(ActionTypes))
    action_types_id: Optional[int] = None

    description: Optional[str] = None
    offer_order: Optional[int] = None
    stand_out: Optional[bool] = None
    # @Required()
    public_access_guid: Optional[str] = None

    form_meta: Optional[List[FormField]] = None
    files: Optional[List[CampaignActionFile]] = None
    sent_to_email_address: Optional[str] = None
    cc_email_address: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetCampaignActionFiles:
    # @Validate(Validator="NotNull")
    campaigns_id: int = 0

    campaign_actions_id: int = 0

Python GetCampaignActionFiles 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.

GET /campaign/actions/files HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CampaignActions xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel.Types">
  <ActionTypesId>0</ActionTypesId>
  <ActionsId>0</ActionsId>
  <ButtonName>String</ButtonName>
  <CampaignsId>0</CampaignsId>
  <CcEmailAddress>String</CcEmailAddress>
  <Description>String</Description>
  <Files xmlns:d2p1="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
    <d2p1:CampaignActionFile>
      <d2p1:Extension>String</d2p1:Extension>
      <d2p1:FileSize>String</d2p1:FileSize>
      <d2p1:FileType>String</d2p1:FileType>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:UploadUrl>String</d2p1:UploadUrl>
    </d2p1:CampaignActionFile>
  </Files>
  <FormMeta xmlns:d2p1="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
    <d2p1:FormField>
      <d2p1:ControlType>String</d2p1:ControlType>
      <d2p1:Help>String</d2p1:Help>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:Label>String</d2p1:Label>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:Options>
        <d2p1:FormFieldOption>
          <d2p1:Label>String</d2p1:Label>
          <d2p1:Value>String</d2p1:Value>
        </d2p1:FormFieldOption>
      </d2p1:Options>
      <d2p1:Placeholder>String</d2p1:Placeholder>
      <d2p1:SortOrder>0</d2p1:SortOrder>
      <d2p1:Validation xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:Validation>
    </d2p1:FormField>
  </FormMeta>
  <Id>0</Id>
  <OfferOrder>0</OfferOrder>
  <PublicAccessGuid>00000000-0000-0000-0000-000000000000</PublicAccessGuid>
  <SentToEmailAddress>String</SentToEmailAddress>
  <StandOut>false</StandOut>
</CampaignActions>