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
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class GetCampaignActionFiles
{
    @DataMember(Order=1)
    @Validate(Validator="NotNull")
    open var CampaignsId:Long? = null

    open var CampaignActionsId:Long? = null
}

open class CampaignActions
{
    @DataMember(Order=1)
    @Required()
    open var Id:Long? = null

    @DataMember(Order=2)
    @Required()
    @References(Type=Campaigns::class)
    open var CampaignsId:Long? = null

    @DataMember(Order=3)
    @References(Type=Actions::class)
    open var ActionsId:Long? = null

    @DataMember(Order=4)
    open var ButtonName:String? = null

    @DataMember(Order=5)
    @References(Type=ActionTypes::class)
    open var ActionTypesId:Int? = null

    @DataMember(Order=6)
    open var Description:String? = null

    @DataMember(Order=7)
    open var OfferOrder:Short? = null

    @DataMember(Order=8)
    open var StandOut:Boolean? = null

    @DataMember(Order=9)
    @Required()
    open var PublicAccessGuid:UUID? = null

    @DataMember(Order=10)
    open var FormMeta:ArrayList<FormField>? = null

    @DataMember(Order=11)
    open var Files:ArrayList<CampaignActionFile>? = null

    @DataMember(Order=12)
    open var SentToEmailAddress:String? = null

    @DataMember(Order=13)
    open var CcEmailAddress:String? = null
}

open class FormField
{
    open var Id:Int? = null
    open var ControlType:String? = null
    open var Label:String? = null
    open var Placeholder:String? = null
    open var Help:String? = null
    open var Name:String? = null
    open var SortOrder:Int? = null
    open var Options:ArrayList<FormFieldOption>? = null
    open var Validation:ArrayList<String>? = null
}

open class FormFieldOption
{
    open var Value:String? = null
    open var Label:String? = null
}

open class CampaignActionFile
{
    open var Name:String? = null
    open var FileType:String? = null
    open var FileSize:String? = null
    open var Extension:String? = null
    open var UploadUrl:String? = null
}

Kotlin GetCampaignActionFiles 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.

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
}