digitaluapi

<back to all web services

SetCampaignActionForm

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
PUT/campaign/actionformSet Campaign Action Form
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class SetCampaignActionForm
    {
        @DataMember(Order=1)
        @Validate(Validator="NotNull")
        public Long CampaignsId = null;

        public Long CampaignActionsId = null;
        public ArrayList<FormField> FormMeta = null;
        
        public Long getCampaignsId() { return CampaignsId; }
        public SetCampaignActionForm setCampaignsId(Long value) { this.CampaignsId = value; return this; }
        public Long getCampaignActionsId() { return CampaignActionsId; }
        public SetCampaignActionForm setCampaignActionsId(Long value) { this.CampaignActionsId = value; return this; }
        public ArrayList<FormField> getFormMeta() { return FormMeta; }
        public SetCampaignActionForm setFormMeta(ArrayList<FormField> value) { this.FormMeta = 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 SetCampaignActionFormResponse
    {
        public Boolean Status = null;
        public ResponseStatus ResponseStatus = null;
        
        public Boolean isStatus() { return Status; }
        public SetCampaignActionFormResponse setStatus(Boolean value) { this.Status = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public SetCampaignActionFormResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

}

Java SetCampaignActionForm DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /campaign/actionform HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CampaignsId: 0,
	CampaignActionsId: 0,
	FormMeta: 
	[
		{
			Id: 0,
			ControlType: String,
			Label: String,
			Placeholder: String,
			Help: String,
			Name: String,
			SortOrder: 0,
			Options: 
			[
				{
					Value: String,
					Label: String
				}
			],
			Validation: 
			[
				String
			]
		}
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Status: False,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}