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 Foundation
import ServiceStack

public class SetCampaignActionForm : Codable
{
    // @DataMember(Order=1)
    // @Validate(Validator="NotNull")
    public var campaignsId:Int

    public var campaignActionsId:Int
    public var formMeta:[FormField]

    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 SetCampaignActionFormResponse : Codable
{
    public var status:Bool
    public var responseStatus:ResponseStatus

    required public init(){}
}


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