digitaluapi

<back to all web services

GetCampaignActionForm

The following routes are available for this service:
GET/campaign/actionformGet Campaign Action Form
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using digitaluapi.ServiceModel;
using digitaluapi.ServiceModel.Types;

namespace digitaluapi.ServiceModel
{
    public partial class CampaignActionFile
    {
        public virtual string Name { get; set; }
        public virtual string FileType { get; set; }
        public virtual string FileSize { get; set; }
        public virtual string Extension { get; set; }
        public virtual string UploadUrl { get; set; }
    }

    public partial class FormField
    {
        public virtual int Id { get; set; }
        public virtual string ControlType { get; set; }
        public virtual string Label { get; set; }
        public virtual string Placeholder { get; set; }
        public virtual string Help { get; set; }
        public virtual string Name { get; set; }
        public virtual int SortOrder { get; set; }
        public virtual List<FormFieldOption> Options { get; set; }
        public virtual List<string> Validation { get; set; }
    }

    public partial class FormFieldOption
    {
        public virtual string Value { get; set; }
        public virtual string Label { get; set; }
    }

    public partial class GetCampaignActionForm
    {
        [DataMember(Order=1)]
        [Validate("NotNull")]
        public virtual long CampaignsId { get; set; }

        public virtual long CampaignActionsId { get; set; }
    }

    public partial class GetCampaignActionFormResponse
    {
        public virtual CampaignActions campaignAction { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

namespace digitaluapi.ServiceModel.Types
{
    public partial class CampaignActions
    {
        [DataMember(Order=1)]
        [Required]
        public virtual long Id { get; set; }

        [DataMember(Order=2)]
        [Required]
        [References(typeof(digitaluapi.ServiceModel.Types.Campaigns))]
        public virtual long CampaignsId { get; set; }

        [DataMember(Order=3)]
        [References(typeof(digitaluapi.ServiceModel.Types.Actions))]
        public virtual long? ActionsId { get; set; }

        [DataMember(Order=4)]
        public virtual string ButtonName { get; set; }

        [DataMember(Order=5)]
        [References(typeof(digitaluapi.ServiceModel.Types.ActionTypes))]
        public virtual int? ActionTypesId { get; set; }

        [DataMember(Order=6)]
        public virtual string Description { get; set; }

        [DataMember(Order=7)]
        public virtual short? OfferOrder { get; set; }

        [DataMember(Order=8)]
        public virtual bool? StandOut { get; set; }

        [DataMember(Order=9)]
        [Required]
        public virtual Guid PublicAccessGuid { get; set; }

        [DataMember(Order=10)]
        public virtual List<FormField> FormMeta { get; set; }

        [DataMember(Order=11)]
        public virtual List<CampaignActionFile> Files { get; set; }

        [DataMember(Order=12)]
        public virtual string SentToEmailAddress { get; set; }

        [DataMember(Order=13)]
        public virtual string CcEmailAddress { get; set; }
    }

}

C# GetCampaignActionForm 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/actionform HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetCampaignActionFormResponse 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>
</GetCampaignActionFormResponse>