digitaluapi

GetCampaignActionClientForm

The following routes are available for this service:
GET	/campaign/inbox/formmeta

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 InboxActionResponse:
    campaign_action: Optional[CampaignActions] = None
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetCampaignActionClientForm:
    comms_guid: Optional[str] = None
    campaign_actions_requests_id: int = 0

Python GetCampaignActionClientForm 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/inbox/formmeta HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<InboxActionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <campaignAction xmlns:d2p1="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel.Types">
    <d2p1:ActionTypesId>0</d2p1:ActionTypesId>
    <d2p1:ActionsId>0</d2p1:ActionsId>
    <d2p1:ButtonName>String</d2p1:ButtonName>
    <d2p1:CampaignsId>0</d2p1:CampaignsId>
    <d2p1:CcEmailAddress>String</d2p1:CcEmailAddress>
    <d2p1:Description>String</d2p1:Description>
    <d2p1:Files>
      <CampaignActionFile>
        <Extension>String</Extension>
        <FileSize>String</FileSize>
        <FileType>String</FileType>
        <Name>String</Name>
        <UploadUrl>String</UploadUrl>
      </CampaignActionFile>
    </d2p1:Files>
    <d2p1:FormMeta>
      <FormField>
        <ControlType>String</ControlType>
        <Help>String</Help>
        <Id>0</Id>
        <Label>String</Label>
        <Name>String</Name>
        <Options>
          <FormFieldOption>
            <Label>String</Label>
            <Value>String</Value>
          </FormFieldOption>
        </Options>
        <Placeholder>String</Placeholder>
        <SortOrder>0</SortOrder>
        <Validation xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>String</d5p1:string>
        </Validation>
      </FormField>
    </d2p1:FormMeta>
    <d2p1:Id>0</d2p1:Id>
    <d2p1:OfferOrder>0</d2p1:OfferOrder>
    <d2p1:PublicAccessGuid>00000000-0000-0000-0000-000000000000</d2p1:PublicAccessGuid>
    <d2p1:SentToEmailAddress>String</d2p1:SentToEmailAddress>
    <d2p1:StandOut>false</d2p1:StandOut>
  </campaignAction>
</InboxActionResponse>