| PUT POST | /campaign/inbox/log |
|---|
"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 InboxActionResponse {
/** @param {{campaignAction?:CampaignActions,ResponseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {CampaignActions} */
campaignAction;
/** @type {ResponseStatus} */
ResponseStatus;
}
export class InboxActionLog {
/** @param {{CommsGuid?:string,CampaignActionsRequestsId?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
CommsGuid;
/** @type {number} */
CampaignActionsRequestsId;
}
JavaScript InboxActionLog DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<InboxActionLog xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
<CampaignActionsRequestsId>0</CampaignActionsRequestsId>
<CommsGuid>00000000-0000-0000-0000-000000000000</CommsGuid>
</InboxActionLog>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<InboxActionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
<campaignAction xmlns:d2p1="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel.Types">
<d2p1:ActionTypesId>0</d2p1:ActionTypesId>
<d2p1:ActionsId>0</d2p1:ActionsId>
<d2p1:ButtonName>String</d2p1:ButtonName>
<d2p1:CampaignsId>0</d2p1:CampaignsId>
<d2p1:CcEmailAddress>String</d2p1:CcEmailAddress>
<d2p1:Description>String</d2p1:Description>
<d2p1:Files>
<CampaignActionFile>
<Extension>String</Extension>
<FileSize>String</FileSize>
<FileType>String</FileType>
<Name>String</Name>
<UploadUrl>String</UploadUrl>
</CampaignActionFile>
</d2p1:Files>
<d2p1:FormMeta>
<FormField>
<ControlType>String</ControlType>
<Help>String</Help>
<Id>0</Id>
<Label>String</Label>
<Name>String</Name>
<Options>
<FormFieldOption>
<Label>String</Label>
<Value>String</Value>
</FormFieldOption>
</Options>
<Placeholder>String</Placeholder>
<SortOrder>0</SortOrder>
<Validation xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>String</d5p1:string>
</Validation>
</FormField>
</d2p1:FormMeta>
<d2p1:Id>0</d2p1:Id>
<d2p1:OfferOrder>0</d2p1:OfferOrder>
<d2p1:PublicAccessGuid>00000000-0000-0000-0000-000000000000</d2p1:PublicAccessGuid>
<d2p1:SentToEmailAddress>String</d2p1:SentToEmailAddress>
<d2p1:StandOut>false</d2p1:StandOut>
</campaignAction>
</InboxActionResponse>