digitaluapi

SaveCampaignActionClientForm

The following routes are available for this service:
PUT POST	/campaign/inbox/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 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 SaveCampaignActionClientForm:
    comms_guid: Optional[str] = None
    campaign_actions_requests_id: int = 0
    comments: Optional[str] = None
    campaign_action_files: Optional[List[CampaignActionFile]] = None

Python SaveCampaignActionClientForm DTOs

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

HTTP + JSV

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

POST /campaign/inbox/form HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CommsGuid: 00000000000000000000000000000000,
	CampaignActionsRequestsId: 0,
	Comments: String,
	CampaignActionFiles: 
	[
		{
			Name: String,
			FileType: String,
			FileSize: String,
			Extension: String,
			UploadUrl: String
		}
	]
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	CampaignActionsFormResponses: 
	{
		Id: 0,
		CampaignActionsId: 0,
		CustomersId: 0,
		ActionTimestamp: 0001-01-01T00:00:00.0000000+00:00,
		FormMetaResponses: 
		{
			CustomFormResults: String,
			Comments: String,
			CampaignActionFiles: 
			[
				{
					Name: String,
					FileType: String,
					FileSize: String,
					Extension: String,
					UploadUrl: String
				}
			]
		},
		FormMetaCustomResponses: 
		{
			String: String
		},
		CampaignInstanceCommsId: 0,
		FormMetaFilesResponses: 
		[
			{
				Name: String,
				FileType: String,
				FileSize: String,
				Extension: String,
				UploadUrl: String
			}
		],
		FormMetaComments: String,
		StatusCodesId: 0,
		SentToEmailAddress: String,
		VersionNumber: 0
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}