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

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

<CampaignActions xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel.Types">
  <ActionTypesId>0</ActionTypesId>
  <ActionsId>0</ActionsId>
  <ButtonName>String</ButtonName>
  <CampaignsId>0</CampaignsId>
  <CcEmailAddress>String</CcEmailAddress>
  <Description>String</Description>
  <Files xmlns:d2p1="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
    <d2p1:CampaignActionFile>
      <d2p1:Extension>String</d2p1:Extension>
      <d2p1:FileSize>String</d2p1:FileSize>
      <d2p1:FileType>String</d2p1:FileType>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:UploadUrl>String</d2p1:UploadUrl>
    </d2p1:CampaignActionFile>
  </Files>
  <FormMeta xmlns:d2p1="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
    <d2p1:FormField>
      <d2p1:ControlType>String</d2p1:ControlType>
      <d2p1:Help>String</d2p1:Help>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:Label>String</d2p1:Label>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:Options>
        <d2p1:FormFieldOption>
          <d2p1:Label>String</d2p1:Label>
          <d2p1:Value>String</d2p1:Value>
        </d2p1:FormFieldOption>
      </d2p1:Options>
      <d2p1:Placeholder>String</d2p1:Placeholder>
      <d2p1:SortOrder>0</d2p1:SortOrder>
      <d2p1:Validation xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:Validation>
    </d2p1:FormField>
  </FormMeta>
  <Id>0</Id>
  <OfferOrder>0</OfferOrder>
  <PublicAccessGuid>00000000-0000-0000-0000-000000000000</PublicAccessGuid>
  <SentToEmailAddress>String</SentToEmailAddress>
  <StandOut>false</StandOut>
</CampaignActions>