digitaluapi

GetCampaignActionClientForm

The following routes are available for this service:
GET	/campaign/inbox/formmeta

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class GetCampaignActionClientForm
{
    open var CommsGuid:UUID? = null
    open var CampaignActionsRequestsId:Long? = null
}

open class InboxActionResponse
{
    open var campaignAction:CampaignActions? = null
    open var ResponseStatus:ResponseStatus? = 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 GetCampaignActionClientForm 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/inbox/formmeta HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml

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

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