| PUT POST | /campaign/inbox/log |
|---|
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 CampaignActionFile
{
public Name: string;
public FileType: string;
public FileSize: string;
public Extension: string;
public UploadUrl: string;
public constructor(init?: Partial<CampaignActionFile>) { (Object as any).assign(this, init); }
}
export class CampaignActions
{
// @DataMember(Order=1)
// @Required()
public Id: number;
// @DataMember(Order=2)
// @Required()
// @References("typeof(digitaluapi.ServiceModel.Types.Campaigns)")
public CampaignsId: number;
// @DataMember(Order=3)
// @References("typeof(digitaluapi.ServiceModel.Types.Actions)")
public ActionsId?: number;
// @DataMember(Order=4)
public ButtonName: string;
// @DataMember(Order=5)
// @References("typeof(digitaluapi.ServiceModel.Types.ActionTypes)")
public ActionTypesId?: number;
// @DataMember(Order=6)
public Description: string;
// @DataMember(Order=7)
public OfferOrder?: number;
// @DataMember(Order=8)
public StandOut?: boolean;
// @DataMember(Order=9)
// @Required()
public PublicAccessGuid: string;
// @DataMember(Order=10)
public FormMeta: FormField[];
// @DataMember(Order=11)
public Files: CampaignActionFile[];
// @DataMember(Order=12)
public SentToEmailAddress: string;
// @DataMember(Order=13)
public CcEmailAddress: string;
public constructor(init?: Partial<CampaignActions>) { (Object as any).assign(this, init); }
}
export class InboxActionResponse
{
public campaignAction: CampaignActions;
public ResponseStatus: ResponseStatus;
public constructor(init?: Partial<InboxActionResponse>) { (Object as any).assign(this, init); }
}
export class InboxActionLog
{
public CommsGuid: string;
public CampaignActionsRequestsId: number;
public constructor(init?: Partial<InboxActionLog>) { (Object as any).assign(this, init); }
}
TypeScript InboxActionLog 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.
POST /campaign/inbox/log HTTP/1.1
Host: duengageapi.uat.scadsoftware.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
CommsGuid: 00000000000000000000000000000000,
CampaignActionsRequestsId: 0
}
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
}
}
}