digitaluapi

SaveCampaignActionClientCustomForm

The following routes are available for this service:
PUT POST	/campaign/inbox/customform

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 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 CampaignActionFormResults:
    custom_form_results: Optional[str] = None
    comments: Optional[str] = None
    campaign_action_files: Optional[List[CampaignActionFile]] = None


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

    # @Required()
    # @References(typeof(CampaignActions))
    campaign_actions_id: int = 0

    # @References(typeof(Customers))
    customers_id: Optional[int] = None

    # @Required()
    # @Computed()
    action_timestamp: datetime.datetime = datetime.datetime(1, 1, 1)

    form_meta_responses: Optional[CampaignActionFormResults] = None
    form_meta_custom_responses: Optional[Dict[str, str]] = None
    campaign_instance_comms_id: Optional[int] = None
    form_meta_files_responses: Optional[List[CampaignActionFile]] = None
    form_meta_comments: Optional[str] = None
    status_codes_id: int = 0
    sent_to_email_address: Optional[str] = None
    version_number: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SaveCampaignActionClientFormResponse:
    campaign_actions_form_responses: Optional[CampaignActionsFormResponses] = None
    response_status: Optional[ResponseStatus] = None


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

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

POST /campaign/inbox/customform HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SaveCampaignActionClientCustomForm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <CampaignActionsRequestsId>0</CampaignActionsRequestsId>
  <CommsGuid>00000000-0000-0000-0000-000000000000</CommsGuid>
  <CustomFormResults xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </CustomFormResults>
</SaveCampaignActionClientCustomForm>

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

<SaveCampaignActionClientFormResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <CampaignActionsFormResponses xmlns:d2p1="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel.Types">
    <d2p1:ActionTimestamp xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>0001-01-01T00:00:00Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </d2p1:ActionTimestamp>
    <d2p1:CampaignActionsId>0</d2p1:CampaignActionsId>
    <d2p1:CampaignInstanceCommsId>0</d2p1:CampaignInstanceCommsId>
    <d2p1:CustomersId>0</d2p1:CustomersId>
    <d2p1:FormMetaComments>String</d2p1:FormMetaComments>
    <d2p1:FormMetaCustomResponses 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:FormMetaCustomResponses>
    <d2p1:FormMetaFilesResponses>
      <CampaignActionFile>
        <Extension>String</Extension>
        <FileSize>String</FileSize>
        <FileType>String</FileType>
        <Name>String</Name>
        <UploadUrl>String</UploadUrl>
      </CampaignActionFile>
    </d2p1:FormMetaFilesResponses>
    <d2p1:FormMetaResponses>
      <CampaignActionFiles>
        <CampaignActionFile>
          <Extension>String</Extension>
          <FileSize>String</FileSize>
          <FileType>String</FileType>
          <Name>String</Name>
          <UploadUrl>String</UploadUrl>
        </CampaignActionFile>
      </CampaignActionFiles>
      <Comments>String</Comments>
      <CustomFormResults>String</CustomFormResults>
    </d2p1:FormMetaResponses>
    <d2p1:Id>0</d2p1:Id>
    <d2p1:SentToEmailAddress>String</d2p1:SentToEmailAddress>
    <d2p1:StatusCodesId>0</d2p1:StatusCodesId>
    <d2p1:VersionNumber>0</d2p1:VersionNumber>
  </CampaignActionsFormResponses>
  <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>
</SaveCampaignActionClientFormResponse>