| GET | /campaign/certbycustomerguid/{CampaignPublicAccessGuid}/{CustomerPublicAccessGuid} | Get Campaign Certificate By Campaign and Customer GUID |
|---|
"use strict";
export class CampaignActionsView {
/** @param {{Id?:number,CampaignsId?:number,ActionsId?:number,ButtonName?:string,ActionTypesId?:number,Description?:string,OfferOrder?:number,StandOut?:boolean,PublicAccessGuid?:string,IsPayment?:boolean,IsPayOff?:boolean,IsEnabled?:boolean}} [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 {boolean} */
IsPayment;
/** @type {boolean} */
IsPayOff;
/** @type {boolean} */
IsEnabled;
}
export class Campaigns {
/** @param {{Id?:number,TenantsId?:number,Name?:string,Description?:string,AvatarsId?:number,SchedulesId?:number,MessageTonesId?:number,StatusCodesId?:number,PublicAccessGuid?:string,ViewHeading?:string,CampaignActions?:CampaignActionsView[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Id;
/** @type {number} */
TenantsId;
/** @type {string} */
Name;
/** @type {string} */
Description;
/** @type {?number} */
AvatarsId;
/** @type {?number} */
SchedulesId;
/** @type {?number} */
MessageTonesId;
/** @type {number} */
StatusCodesId;
/** @type {string} */
PublicAccessGuid;
/** @type {string} */
ViewHeading;
/** @type {CampaignActionsView[]} */
CampaignActions;
}
export class Customers {
/** @param {{Id?:number,TenantsId?:number,UserAuthId?:number,SegmentsId?:number,CompaniesId?:number,CurrenciesId?:number,Address?:string,Age?:number,City?:string,ContactNumber?:string,Email?:string,EthnicGroup?:string,FirstName?:string,Gender?:string,HomeLanguage?:string,IdNumber?:string,LastName?:string,PostalCode?:string,Region?:string,Suburb?:string,UniqueIdentifier?:string,BirthDate?:string,Classifications?:{ [index:string]: string; },Country?:string,PassportNumber?:string,StatusCodesId?:number,Reason?:string,VulnerabilityFlag?:boolean,Meta?:{ [index:string]: string; },PublicAccessGuid?:string,CustomField1?:string,CustomField2?:string,CustomField3?:string,CustomField4?:string,CustomField5?:string,CustomField6?:string,CustomField7?:string,CustomField8?:string,CustomField9?:string,CustomField10?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Id;
/** @type {number} */
TenantsId;
/** @type {?number} */
UserAuthId;
/** @type {number} */
SegmentsId;
/** @type {?number} */
CompaniesId;
/** @type {?number} */
CurrenciesId;
/** @type {string} */
Address;
/** @type {?number} */
Age;
/** @type {string} */
City;
/** @type {string} */
ContactNumber;
/** @type {string} */
Email;
/** @type {string} */
EthnicGroup;
/** @type {string} */
FirstName;
/** @type {string} */
Gender;
/** @type {string} */
HomeLanguage;
/** @type {string} */
IdNumber;
/** @type {string} */
LastName;
/** @type {string} */
PostalCode;
/** @type {string} */
Region;
/** @type {string} */
Suburb;
/** @type {string} */
UniqueIdentifier;
/** @type {?string} */
BirthDate;
/** @type {{ [index:string]: string; }} */
Classifications;
/** @type {string} */
Country;
/** @type {string} */
PassportNumber;
/** @type {number} */
StatusCodesId;
/** @type {string} */
Reason;
/** @type {?boolean} */
VulnerabilityFlag;
/** @type {{ [index:string]: string; }} */
Meta;
/** @type {string} */
PublicAccessGuid;
/** @type {string} */
CustomField1;
/** @type {string} */
CustomField2;
/** @type {string} */
CustomField3;
/** @type {string} */
CustomField4;
/** @type {string} */
CustomField5;
/** @type {string} */
CustomField6;
/** @type {string} */
CustomField7;
/** @type {string} */
CustomField8;
/** @type {string} */
CustomField9;
/** @type {string} */
CustomField10;
}
export class CampaignInstanceComms {
/** @param {{Id?:number,CampaignInstanceCustomersId?:number,ChannelsId?:number,Email?:string,MobileNumber?:string,EmailAttachmentTemplate?:string,EmailTemplate?:string,EmailHtmlTemplate?:string,SmsTemplate?:string,PublicAccessGuid?:string,CampaignsId?:number,DebtsId?:number,IsPaymentCampaign?:boolean,ScheduleInstancesId?:number,StatusCodesId?:number,EmailTemplatesId?:number,AvatarTemplateText?:string,HeadingTemplateText?:string,SubheadingTemplateText?:string,Sent?:boolean,Failed?:boolean,CommsUrl?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Id;
/** @type {number} */
CampaignInstanceCustomersId;
/** @type {number} */
ChannelsId;
/** @type {string} */
Email;
/** @type {string} */
MobileNumber;
/** @type {string} */
EmailAttachmentTemplate;
/** @type {string} */
EmailTemplate;
/** @type {string} */
EmailHtmlTemplate;
/** @type {string} */
SmsTemplate;
/** @type {string} */
PublicAccessGuid;
/** @type {number} */
CampaignsId;
/** @type {?number} */
DebtsId;
/** @type {boolean} */
IsPaymentCampaign;
/** @type {?number} */
ScheduleInstancesId;
/** @type {?number} */
StatusCodesId;
/** @type {?number} */
EmailTemplatesId;
/** @type {string} */
AvatarTemplateText;
/** @type {string} */
HeadingTemplateText;
/** @type {string} */
SubheadingTemplateText;
/** @type {boolean} */
Sent;
/** @type {boolean} */
Failed;
/** @type {string} */
CommsUrl;
}
export class EmailEventsView {
/** @param {{Id?:number,Email?:string,TimestampDate?:string,Event?:string,Category?:string,SgEventId?:string,SgMessageId?:string,UserAgent?:string,Ipaddress?:string,Url?:string,CampaignInstanceCommsId?:number,TenantsId?:number,SegmentsId?:number,Address?:string,Age?:number,City?:string,ContactNumber?:string,EthnicGroup?:string,FirstName?:string,Gender?:string,HomeLanguage?:string,IdNumber?:string,LastName?:string,PostalCode?:string,Region?:string,Suburb?:string,BirthDate?:string,Classifications?:{ [index:string]: string; },Country?:string,PassportNumber?:string,StatusCodesId?:number,Reason?:string,VulnerabilityFlag?:boolean,CompaniesName?:string,SegmentsName?:string,SegmentsIsCustom?:boolean,StatusCodesDescription?:string,CampaignsId?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?number} */
Id;
/** @type {string} */
Email;
/** @type {?string} */
TimestampDate;
/** @type {string} */
Event;
/** @type {string} */
Category;
/** @type {string} */
SgEventId;
/** @type {string} */
SgMessageId;
/** @type {string} */
UserAgent;
/** @type {string} */
Ipaddress;
/** @type {string} */
Url;
/** @type {?number} */
CampaignInstanceCommsId;
/** @type {?number} */
TenantsId;
/** @type {?number} */
SegmentsId;
/** @type {string} */
Address;
/** @type {?number} */
Age;
/** @type {string} */
City;
/** @type {string} */
ContactNumber;
/** @type {string} */
EthnicGroup;
/** @type {string} */
FirstName;
/** @type {string} */
Gender;
/** @type {string} */
HomeLanguage;
/** @type {string} */
IdNumber;
/** @type {string} */
LastName;
/** @type {string} */
PostalCode;
/** @type {string} */
Region;
/** @type {string} */
Suburb;
/** @type {?string} */
BirthDate;
/** @type {{ [index:string]: string; }} */
Classifications;
/** @type {string} */
Country;
/** @type {string} */
PassportNumber;
/** @type {?number} */
StatusCodesId;
/** @type {string} */
Reason;
/** @type {?boolean} */
VulnerabilityFlag;
/** @type {string} */
CompaniesName;
/** @type {string} */
SegmentsName;
/** @type {?boolean} */
SegmentsIsCustom;
/** @type {string} */
StatusCodesDescription;
/** @type {?number} */
CampaignsId;
}
export class SmsWatsappEventsView {
/** @param {{Id?:number,CampaignInstancesCommsId?:number,RawJson?:{ [index:string]: string; },IntegrationId?:string,IntegrationName?:string,Channel?:string,Timestamp?:number,TimestampDate?:string,StatusCode?:number,Status?:string,MessageId?:string,ClientMessageId?:string,TenantsId?:number,SegmentsId?:number,Address?:string,Age?:number,City?:string,ContactNumber?:string,EthnicGroup?:string,FirstName?:string,Gender?:string,HomeLanguage?:string,IdNumber?:string,LastName?:string,PostalCode?:string,Region?:string,Suburb?:string,BirthDate?:string,Classifications?:{ [index:string]: string; },Country?:string,PassportNumber?:string,StatusCodesId?:number,Reason?:string,VulnerabilityFlag?:boolean,CompaniesName?:string,SegmentsName?:string,SegmentsIsCustom?:boolean,StatusCodesDescription?:string,CampaignsId?:number,CustomersId?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?number} */
Id;
/** @type {?number} */
CampaignInstancesCommsId;
/** @type {{ [index:string]: string; }} */
RawJson;
/** @type {string} */
IntegrationId;
/** @type {string} */
IntegrationName;
/** @type {string} */
Channel;
/** @type {?number} */
Timestamp;
/** @type {?string} */
TimestampDate;
/** @type {?number} */
StatusCode;
/** @type {string} */
Status;
/** @type {string} */
MessageId;
/** @type {string} */
ClientMessageId;
/** @type {?number} */
TenantsId;
/** @type {?number} */
SegmentsId;
/** @type {string} */
Address;
/** @type {?number} */
Age;
/** @type {string} */
City;
/** @type {string} */
ContactNumber;
/** @type {string} */
EthnicGroup;
/** @type {string} */
FirstName;
/** @type {string} */
Gender;
/** @type {string} */
HomeLanguage;
/** @type {string} */
IdNumber;
/** @type {string} */
LastName;
/** @type {string} */
PostalCode;
/** @type {string} */
Region;
/** @type {string} */
Suburb;
/** @type {?string} */
BirthDate;
/** @type {{ [index:string]: string; }} */
Classifications;
/** @type {string} */
Country;
/** @type {string} */
PassportNumber;
/** @type {?number} */
StatusCodesId;
/** @type {string} */
Reason;
/** @type {?boolean} */
VulnerabilityFlag;
/** @type {string} */
CompaniesName;
/** @type {string} */
SegmentsName;
/** @type {?boolean} */
SegmentsIsCustom;
/** @type {string} */
StatusCodesDescription;
/** @type {?number} */
CampaignsId;
/** @type {?number} */
CustomersId;
}
export class CampaignInstanceCommsStats {
/** @param {{Id?:number,CampaignInstanceCommsId?:number,ViewedDate?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Id;
/** @type {number} */
CampaignInstanceCommsId;
/** @type {?string} */
ViewedDate;
}
export class CampaignInstanceCommsDetails {
/** @param {{CampaignInstanceComms?:CampaignInstanceComms,EmailEvents?:EmailEventsView[],SmsWatsappEvents?:SmsWatsappEventsView[],CampaignInstanceCommsStats?:CampaignInstanceCommsStats[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {CampaignInstanceComms} */
CampaignInstanceComms;
/** @type {EmailEventsView[]} */
EmailEvents;
/** @type {SmsWatsappEventsView[]} */
SmsWatsappEvents;
/** @type {CampaignInstanceCommsStats[]} */
CampaignInstanceCommsStats;
}
export class GetCampaignCustomerCertificateResponse {
/** @param {{Campaign?:Campaigns,Customer?:Customers,CampaignInstanceCommsDetails?:CampaignInstanceCommsDetails[],ResponseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {Campaigns} */
Campaign;
/** @type {Customers} */
Customer;
/** @type {CampaignInstanceCommsDetails[]} */
CampaignInstanceCommsDetails;
/** @type {ResponseStatus} */
ResponseStatus;
}
export class GetCampaignCustomerCertificateByCustomerId {
/** @param {{CampaignPublicAccessGuid?:string,CustomerPublicAccessGuid?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
CampaignPublicAccessGuid;
/** @type {string} */
CustomerPublicAccessGuid;
}
JavaScript GetCampaignCustomerCertificateByCustomerId 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/certbycustomerguid/{CampaignPublicAccessGuid}/{CustomerPublicAccessGuid} HTTP/1.1
Host: duengageapi.uat.scadsoftware.com
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Campaign:
{
Id: 0,
TenantsId: 0,
Name: String,
Description: String,
AvatarsId: 0,
SchedulesId: 0,
MessageTonesId: 0,
StatusCodesId: 0,
PublicAccessGuid: 00000000000000000000000000000000,
ViewHeading: String,
CampaignActions:
[
{
Id: 0,
CampaignsId: 0,
ActionsId: 0,
ButtonName: String,
ActionTypesId: 0,
Description: String,
OfferOrder: 0,
StandOut: False,
PublicAccessGuid: 00000000000000000000000000000000,
IsPayment: False,
IsPayOff: False,
IsEnabled: False
}
]
},
Customer:
{
Id: 0,
TenantsId: 0,
UserAuthId: 0,
SegmentsId: 0,
CompaniesId: 0,
CurrenciesId: 0,
Address: String,
Age: 0,
City: String,
ContactNumber: String,
Email: String,
EthnicGroup: String,
FirstName: String,
Gender: String,
HomeLanguage: String,
IdNumber: String,
LastName: String,
PostalCode: String,
Region: String,
Suburb: String,
UniqueIdentifier: String,
BirthDate: 0001-01-01,
Classifications:
{
String: String
},
Country: String,
PassportNumber: String,
StatusCodesId: 0,
Reason: String,
VulnerabilityFlag: False,
Meta:
{
String: String
},
PublicAccessGuid: 00000000000000000000000000000000,
CustomField1: String,
CustomField2: String,
CustomField3: String,
CustomField4: String,
CustomField5: String,
CustomField6: String,
CustomField7: String,
CustomField8: String,
CustomField9: String,
CustomField10: String
},
CampaignInstanceCommsDetails:
[
{
CampaignInstanceComms:
{
Id: 0,
CampaignInstanceCustomersId: 0,
ChannelsId: 0,
Email: String,
MobileNumber: String,
EmailAttachmentTemplate: String,
EmailTemplate: String,
EmailHtmlTemplate: String,
SmsTemplate: String,
PublicAccessGuid: 00000000000000000000000000000000,
CampaignsId: 0,
DebtsId: 0,
IsPaymentCampaign: False,
ScheduleInstancesId: 0,
StatusCodesId: 0,
EmailTemplatesId: 0,
AvatarTemplateText: String,
HeadingTemplateText: String,
SubheadingTemplateText: String,
Sent: False,
Failed: False,
CommsUrl: String
},
EmailEvents:
[
{
Id: 0,
Email: String,
TimestampDate: 0001-01-01T00:00:00.0000000+00:00,
Event: String,
Category: String,
SgEventId: String,
SgMessageId: String,
UserAgent: String,
Ipaddress: String,
Url: String,
CampaignInstanceCommsId: 0,
TenantsId: 0,
SegmentsId: 0,
Address: String,
Age: 0,
City: String,
ContactNumber: String,
EthnicGroup: String,
FirstName: String,
Gender: String,
HomeLanguage: String,
IdNumber: String,
LastName: String,
PostalCode: String,
Region: String,
Suburb: String,
BirthDate: 0001-01-01,
Classifications:
{
String: String
},
Country: String,
PassportNumber: String,
StatusCodesId: 0,
Reason: String,
VulnerabilityFlag: False,
CompaniesName: String,
SegmentsName: String,
SegmentsIsCustom: False,
StatusCodesDescription: String,
CampaignsId: 0
}
],
SmsWatsappEvents:
[
{
Id: 0,
CampaignInstancesCommsId: 0,
RawJson:
{
String: String
},
IntegrationId: String,
IntegrationName: String,
Channel: String,
Timestamp: 0,
TimestampDate: 0001-01-01T00:00:00.0000000+00:00,
StatusCode: 0,
Status: String,
MessageId: String,
ClientMessageId: String,
TenantsId: 0,
SegmentsId: 0,
Address: String,
Age: 0,
City: String,
ContactNumber: String,
EthnicGroup: String,
FirstName: String,
Gender: String,
HomeLanguage: String,
IdNumber: String,
LastName: String,
PostalCode: String,
Region: String,
Suburb: String,
BirthDate: 0001-01-01,
Classifications:
{
String: String
},
Country: String,
PassportNumber: String,
StatusCodesId: 0,
Reason: String,
VulnerabilityFlag: False,
CompaniesName: String,
SegmentsName: String,
SegmentsIsCustom: False,
StatusCodesDescription: String,
CampaignsId: 0,
CustomersId: 0
}
],
CampaignInstanceCommsStats:
[
{
Id: 0,
CampaignInstanceCommsId: 0,
ViewedDate: 0001-01-01T00:00:00.0000000+00:00
}
]
}
],
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}