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
GetCampaignActionFiles Parameters:
NameParameterData TypeRequiredDescription
CampaignsIdquerylongYes
CampaignActionsIdquerylongNo
CampaignActions Parameters:
NameParameterData TypeRequiredDescription
IdformlongYes
CampaignsIdformlongYes
ActionsIdformlong?No
ButtonNameformstringNo
ActionTypesIdformint?No
DescriptionformstringNo
OfferOrderformshort?No
StandOutformbool?No
PublicAccessGuidformGuidYes
FormMetaformList<FormField>No
FilesformList<CampaignActionFile>No
SentToEmailAddressformstringNo
CcEmailAddressformstringNo
FormField Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
ControlTypeformstringNo
LabelformstringNo
PlaceholderformstringNo
HelpformstringNo
NameformstringNo
SortOrderformintNo
OptionsformList<FormFieldOption>No
ValidationformList<string>No
FormFieldOption Parameters:
NameParameterData TypeRequiredDescription
ValueformstringNo
LabelformstringNo
CampaignActionFile Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
FileTypeformstringNo
FileSizeformstringNo
ExtensionformstringNo
UploadUrlformstringNo

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.

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

{
	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
}