| GET | /campaign/actionform | Get Campaign Action Form |
|---|
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;
public class dtos
{
public static class GetCampaignActionForm
{
@DataMember(Order=1)
@Validate(Validator="NotNull")
public Long CampaignsId = null;
public Long CampaignActionsId = null;
public Long getCampaignsId() { return CampaignsId; }
public GetCampaignActionForm setCampaignsId(Long value) { this.CampaignsId = value; return this; }
public Long getCampaignActionsId() { return CampaignActionsId; }
public GetCampaignActionForm setCampaignActionsId(Long value) { this.CampaignActionsId = value; return this; }
}
public static class GetCampaignActionFormResponse
{
public CampaignActions campaignAction = null;
public ResponseStatus ResponseStatus = null;
public CampaignActions getCampaignAction() { return campaignAction; }
public GetCampaignActionFormResponse setCampaignAction(CampaignActions value) { this.campaignAction = value; return this; }
public ResponseStatus getResponseStatus() { return ResponseStatus; }
public GetCampaignActionFormResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
}
public static class CampaignActions
{
@DataMember(Order=1)
@Required()
public Long Id = null;
@DataMember(Order=2)
@Required()
@References(Type=Campaigns.class)
public Long CampaignsId = null;
@DataMember(Order=3)
@References(Type=Actions.class)
public Long ActionsId = null;
@DataMember(Order=4)
public String ButtonName = null;
@DataMember(Order=5)
@References(Type=ActionTypes.class)
public Integer ActionTypesId = null;
@DataMember(Order=6)
public String Description = null;
@DataMember(Order=7)
public Short OfferOrder = null;
@DataMember(Order=8)
public Boolean StandOut = null;
@DataMember(Order=9)
@Required()
public UUID PublicAccessGuid = null;
@DataMember(Order=10)
public ArrayList<FormField> FormMeta = null;
@DataMember(Order=11)
public ArrayList<CampaignActionFile> Files = null;
@DataMember(Order=12)
public String SentToEmailAddress = null;
@DataMember(Order=13)
public String CcEmailAddress = null;
public Long getId() { return Id; }
public CampaignActions setId(Long value) { this.Id = value; return this; }
public Long getCampaignsId() { return CampaignsId; }
public CampaignActions setCampaignsId(Long value) { this.CampaignsId = value; return this; }
public Long getActionsId() { return ActionsId; }
public CampaignActions setActionsId(Long value) { this.ActionsId = value; return this; }
public String getButtonName() { return ButtonName; }
public CampaignActions setButtonName(String value) { this.ButtonName = value; return this; }
public Integer getActionTypesId() { return ActionTypesId; }
public CampaignActions setActionTypesId(Integer value) { this.ActionTypesId = value; return this; }
public String getDescription() { return Description; }
public CampaignActions setDescription(String value) { this.Description = value; return this; }
public Short getOfferOrder() { return OfferOrder; }
public CampaignActions setOfferOrder(Short value) { this.OfferOrder = value; return this; }
public Boolean isStandOut() { return StandOut; }
public CampaignActions setStandOut(Boolean value) { this.StandOut = value; return this; }
public UUID getPublicAccessGuid() { return PublicAccessGuid; }
public CampaignActions setPublicAccessGuid(UUID value) { this.PublicAccessGuid = value; return this; }
public ArrayList<FormField> getFormMeta() { return FormMeta; }
public CampaignActions setFormMeta(ArrayList<FormField> value) { this.FormMeta = value; return this; }
public ArrayList<CampaignActionFile> getFiles() { return Files; }
public CampaignActions setFiles(ArrayList<CampaignActionFile> value) { this.Files = value; return this; }
public String getSentToEmailAddress() { return SentToEmailAddress; }
public CampaignActions setSentToEmailAddress(String value) { this.SentToEmailAddress = value; return this; }
public String getCcEmailAddress() { return CcEmailAddress; }
public CampaignActions setCcEmailAddress(String value) { this.CcEmailAddress = value; return this; }
}
public static class FormField
{
public Integer Id = null;
public String ControlType = null;
public String Label = null;
public String Placeholder = null;
public String Help = null;
public String Name = null;
public Integer SortOrder = null;
public ArrayList<FormFieldOption> Options = null;
public ArrayList<String> Validation = null;
public Integer getId() { return Id; }
public FormField setId(Integer value) { this.Id = value; return this; }
public String getControlType() { return ControlType; }
public FormField setControlType(String value) { this.ControlType = value; return this; }
public String getLabel() { return Label; }
public FormField setLabel(String value) { this.Label = value; return this; }
public String getPlaceholder() { return Placeholder; }
public FormField setPlaceholder(String value) { this.Placeholder = value; return this; }
public String getHelp() { return Help; }
public FormField setHelp(String value) { this.Help = value; return this; }
public String getName() { return Name; }
public FormField setName(String value) { this.Name = value; return this; }
public Integer getSortOrder() { return SortOrder; }
public FormField setSortOrder(Integer value) { this.SortOrder = value; return this; }
public ArrayList<FormFieldOption> getOptions() { return Options; }
public FormField setOptions(ArrayList<FormFieldOption> value) { this.Options = value; return this; }
public ArrayList<String> getValidation() { return Validation; }
public FormField setValidation(ArrayList<String> value) { this.Validation = value; return this; }
}
public static class FormFieldOption
{
public String Value = null;
public String Label = null;
public String getValue() { return Value; }
public FormFieldOption setValue(String value) { this.Value = value; return this; }
public String getLabel() { return Label; }
public FormFieldOption setLabel(String value) { this.Label = value; return this; }
}
public static class CampaignActionFile
{
public String Name = null;
public String FileType = null;
public String FileSize = null;
public String Extension = null;
public String UploadUrl = null;
public String getName() { return Name; }
public CampaignActionFile setName(String value) { this.Name = value; return this; }
public String getFileType() { return FileType; }
public CampaignActionFile setFileType(String value) { this.FileType = value; return this; }
public String getFileSize() { return FileSize; }
public CampaignActionFile setFileSize(String value) { this.FileSize = value; return this; }
public String getExtension() { return Extension; }
public CampaignActionFile setExtension(String value) { this.Extension = value; return this; }
public String getUploadUrl() { return UploadUrl; }
public CampaignActionFile setUploadUrl(String value) { this.UploadUrl = value; return this; }
}
}
Java GetCampaignActionForm DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>