digitaluapi

<back to all web services

GetCampaignActionForm

The following routes are available for this service:
GET/campaign/actionformGet Campaign Action Form
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 GetCampaignActionFormResponse:
    campaign_action: Optional[CampaignActions] = None
    response_status: Optional[ResponseStatus] = None


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

    campaign_actions_id: int = 0

Python GetCampaignActionForm DTOs

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

HTTP + OTHER

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

GET /campaign/actionform HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"campaignAction":{"Id":0,"CampaignsId":0,"ActionsId":0,"ButtonName":"String","ActionTypesId":0,"Description":"String","OfferOrder":0,"StandOut":false,"PublicAccessGuid":"00000000000000000000000000000000","FormMeta":[{"Id":0,"ControlType":"String","Label":"String","Placeholder":"String","Help":"String","Name":"String","SortOrder":0,"Options":[{"Value":"String","Label":"String"}],"Validation":["String"]}],"Files":[{"Name":"String","FileType":"String","FileSize":"String","Extension":"String","UploadUrl":"String"}],"SentToEmailAddress":"String","CcEmailAddress":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}