| GET | /campaign/actionform | Get Campaign Action Form |
|---|
"use strict";
export class FormFieldOption {
/** @param {{Value?:string,Label?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Value;
/** @type {string} */
Label;
}
export class FormField {
/** @param {{Id?:number,ControlType?:string,Label?:string,Placeholder?:string,Help?:string,Name?:string,SortOrder?:number,Options?:FormFieldOption[],Validation?:string[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Id;
/** @type {string} */
ControlType;
/** @type {string} */
Label;
/** @type {string} */
Placeholder;
/** @type {string} */
Help;
/** @type {string} */
Name;
/** @type {number} */
SortOrder;
/** @type {FormFieldOption[]} */
Options;
/** @type {string[]} */
Validation;
}
export class CampaignActionFile {
/** @param {{Name?:string,FileType?:string,FileSize?:string,Extension?:string,UploadUrl?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Name;
/** @type {string} */
FileType;
/** @type {string} */
FileSize;
/** @type {string} */
Extension;
/** @type {string} */
UploadUrl;
}
export class CampaignActions {
/** @param {{Id?:number,CampaignsId?:number,ActionsId?:number,ButtonName?:string,ActionTypesId?:number,Description?:string,OfferOrder?:number,StandOut?:boolean,PublicAccessGuid?:string,FormMeta?:FormField[],Files?:CampaignActionFile[],SentToEmailAddress?:string,CcEmailAddress?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Id;
/** @type {number} */
CampaignsId;
/** @type {?number} */
ActionsId;
/** @type {string} */
ButtonName;
/** @type {?number} */
ActionTypesId;
/** @type {string} */
Description;
/** @type {?number} */
OfferOrder;
/** @type {?boolean} */
StandOut;
/** @type {string} */
PublicAccessGuid;
/** @type {FormField[]} */
FormMeta;
/** @type {CampaignActionFile[]} */
Files;
/** @type {string} */
SentToEmailAddress;
/** @type {string} */
CcEmailAddress;
}
export class GetCampaignActionFormResponse {
/** @param {{campaignAction?:CampaignActions,ResponseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {CampaignActions} */
campaignAction;
/** @type {ResponseStatus} */
ResponseStatus;
}
export class GetCampaignActionForm {
/** @param {{CampaignsId?:number,CampaignActionsId?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
CampaignsId;
/** @type {number} */
CampaignActionsId;
}
JavaScript GetCampaignActionForm DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
campaignAction:
{
Id: 0,
CampaignsId: 0,
ActionsId: 0,
ButtonName: String,
ActionTypesId: 0,
Description: String,
OfferOrder: 0,
StandOut: False,
PublicAccessGuid: 00000000000000000000000000000000,
FormMeta:
[
{
Id: 0,
ControlType: String,
Label: String,
Placeholder: String,
Help: String,
Name: String,
SortOrder: 0,
Options:
[
{
Value: String,
Label: String
}
],
Validation:
[
String
]
}
],
Files:
[
{
Name: String,
FileType: String,
FileSize: String,
Extension: String,
UploadUrl: String
}
],
SentToEmailAddress: String,
CcEmailAddress: String
},
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}