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

export class SetCampaignActionFormResponse
{
    public Status: boolean;
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<SetCampaignActionFormResponse>) { (Object as any).assign(this, init); }
}

export class FormFieldOption
{
    public Value: string;
    public Label: string;

    public constructor(init?: Partial<FormFieldOption>) { (Object as any).assign(this, init); }
}

export class FormField
{
    public Id: number;
    public ControlType: string;
    public Label: string;
    public Placeholder: string;
    public Help: string;
    public Name: string;
    public SortOrder: number;
    public Options: FormFieldOption[];
    public Validation: string[];

    public constructor(init?: Partial<FormField>) { (Object as any).assign(this, init); }
}

export class SetCampaignActionForm
{
    // @DataMember(Order=1)
    // @Validate(Validator="NotNull")
    public CampaignsId: number;

    public CampaignActionsId: number;
    public FormMeta: FormField[];

    public constructor(init?: Partial<SetCampaignActionForm>) { (Object as any).assign(this, init); }
}

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