digitaluapi

GetCampaignActionClientForm

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

import Foundation
import ServiceStack

public class GetCampaignActionClientForm : Codable
{
    public var commsGuid:String
    public var campaignActionsRequestsId:Int

    required public init(){}
}

public class InboxActionResponse : Codable
{
    public var campaignAction:CampaignActions
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class CampaignActions : Codable
{
    // @DataMember(Order=1)
    // @Required()
    public var id:Int?

    // @DataMember(Order=2)
    // @Required()
    // @References(typeof(Campaigns))
    public var campaignsId:Int?

    // @DataMember(Order=3)
    // @References(typeof(Actions))
    public var actionsId:Int?

    // @DataMember(Order=4)
    public var buttonName:String

    // @DataMember(Order=5)
    // @References(typeof(ActionTypes))
    public var actionTypesId:Int?

    // @DataMember(Order=6)
    public var Description:String

    // @DataMember(Order=7)
    public var offerOrder:Int16?

    // @DataMember(Order=8)
    public var standOut:Bool?

    // @DataMember(Order=9)
    // @Required()
    public var publicAccessGuid:String?

    // @DataMember(Order=10)
    public var formMeta:[FormField]

    // @DataMember(Order=11)
    public var files:[CampaignActionFile]

    // @DataMember(Order=12)
    public var sentToEmailAddress:String

    // @DataMember(Order=13)
    public var ccEmailAddress:String

    required public init(){}
}

public class FormField : Codable
{
    public var id:Int
    public var controlType:String
    public var label:String
    public var placeholder:String
    public var help:String
    public var name:String
    public var sortOrder:Int
    public var options:[FormFieldOption]
    public var validation:[String]

    required public init(){}
}

public class FormFieldOption : Codable
{
    public var value:String
    public var label:String

    required public init(){}
}

public class CampaignActionFile : Codable
{
    public var name:String
    public var fileType:String
    public var fileSize:String
    public var `extension`:String
    public var uploadUrl:String

    required public init(){}
}

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