digitaluapi

<back to all web services

GetCampaignCustomerCertificateByCustomerId

The following routes are available for this service:
GET/campaign/certbycustomerguid/{CampaignPublicAccessGuid}/{CustomerPublicAccessGuid}Get Campaign Certificate By Campaign and Customer GUID
GetCampaignCustomerCertificateByCustomerId Parameters:
NameParameterData TypeRequiredDescription
CampaignPublicAccessGuidpathGuidNo
CustomerPublicAccessGuidpathGuidNo
GetCampaignCustomerCertificateResponse Parameters:
NameParameterData TypeRequiredDescription
CampaignformCampaignsNo
CustomerformCustomersNo
CampaignInstanceCommsDetailsformList<CampaignInstanceCommsDetails>No
ResponseStatusformResponseStatusNo
Campaigns Parameters:
NameParameterData TypeRequiredDescription
IdformlongYes
TenantsIdformintYes
NameformstringYes
DescriptionformstringYes
AvatarsIdformlong?No
SchedulesIdformlong?No
MessageTonesIdformint?No
StatusCodesIdformlongYes
PublicAccessGuidformGuidYes
ViewHeadingformstringNo
CampaignActionsformList<CampaignActionsView>No
CampaignActionsView Parameters:
NameParameterData TypeRequiredDescription
IdformlongYes
CampaignsIdformlongYes
ActionsIdformlong?No
ButtonNameformstringNo
ActionTypesIdformint?No
DescriptionformstringNo
OfferOrderformshort?No
StandOutformbool?No
PublicAccessGuidformGuidYes
IsPaymentformboolNo
IsPayOffformboolNo
IsEnabledformboolNo
Customers Parameters:
NameParameterData TypeRequiredDescription
IdformlongYes
TenantsIdformintYes
UserAuthIdformint?No
SegmentsIdformlongYes
CompaniesIdformlong?No
CurrenciesIdformint?No
AddressformstringNo
Ageformint?No
CityformstringNo
ContactNumberformstringNo
EmailformstringNo
EthnicGroupformstringNo
FirstNameformstringNo
GenderformstringNo
HomeLanguageformstringNo
IdNumberformstringNo
LastNameformstringNo
PostalCodeformstringNo
RegionformstringNo
SuburbformstringNo
UniqueIdentifierformstringNo
BirthDateformDateTime?No
ClassificationsformDictionary<string, string>No
CountryformstringNo
PassportNumberformstringNo
StatusCodesIdformlongYes
ReasonformstringNo
VulnerabilityFlagformbool?No
MetaformDictionary<string, string>No
PublicAccessGuidformGuidNo
CustomField1formstringNo
CustomField2formstringNo
CustomField3formstringNo
CustomField4formstringNo
CustomField5formstringNo
CustomField6formstringNo
CustomField7formstringNo
CustomField8formstringNo
CustomField9formstringNo
CustomField10formstringNo
CampaignInstanceCommsDetails Parameters:
NameParameterData TypeRequiredDescription
CampaignInstanceCommsformCampaignInstanceCommsNo
EmailEventsformList<EmailEventsView>No
SmsWatsappEventsformList<SmsWatsappEventsView>No
CampaignInstanceCommsStatsformList<CampaignInstanceCommsStats>No
CampaignInstanceComms Parameters:
NameParameterData TypeRequiredDescription
IdformlongYes
CampaignInstanceCustomersIdformlongYes
ChannelsIdformintYes
EmailformstringNo
MobileNumberformstringNo
EmailAttachmentTemplateformstringNo
EmailTemplateformstringNo
EmailHtmlTemplateformstringNo
SmsTemplateformstringNo
PublicAccessGuidformGuidYes
CampaignsIdformlongYes
DebtsIdformlong?No
IsPaymentCampaignformboolYes
ScheduleInstancesIdformlong?No
StatusCodesIdformlong?No
EmailTemplatesIdformlong?No
AvatarTemplateTextformstringNo
HeadingTemplateTextformstringNo
SubheadingTemplateTextformstringNo
SentformboolNo
FailedformboolNo
CommsUrlformstringNo
EmailEventsView Parameters:
NameParameterData TypeRequiredDescription
Idformlong?No
EmailformstringNo
TimestampDateformDateTimeOffset?No
EventformstringNo
CategoryformstringNo
SgEventIdformstringNo
SgMessageIdformstringNo
UserAgentformstringNo
IpaddressformstringNo
UrlformstringNo
CampaignInstanceCommsIdformlong?No
TenantsIdformint?No
SegmentsIdformlong?No
AddressformstringNo
Ageformint?No
CityformstringNo
ContactNumberformstringNo
EthnicGroupformstringNo
FirstNameformstringNo
GenderformstringNo
HomeLanguageformstringNo
IdNumberformstringNo
LastNameformstringNo
PostalCodeformstringNo
RegionformstringNo
SuburbformstringNo
BirthDateformDateTime?No
ClassificationsformDictionary<string, string>No
CountryformstringNo
PassportNumberformstringNo
StatusCodesIdformlong?No
ReasonformstringNo
VulnerabilityFlagformbool?No
CompaniesNameformstringNo
SegmentsNameformstringNo
SegmentsIsCustomformbool?No
StatusCodesDescriptionformstringNo
CampaignsIdformlong?No
SmsWatsappEventsView Parameters:
NameParameterData TypeRequiredDescription
Idformlong?No
CampaignInstancesCommsIdformlong?No
RawJsonformDictionary<string, string>No
IntegrationIdformstringNo
IntegrationNameformstringNo
ChannelformstringNo
Timestampformlong?No
TimestampDateformDateTimeOffset?No
StatusCodeformint?No
StatusformstringNo
MessageIdformstringNo
ClientMessageIdformstringNo
TenantsIdformint?No
SegmentsIdformlong?No
AddressformstringNo
Ageformint?No
CityformstringNo
ContactNumberformstringNo
EthnicGroupformstringNo
FirstNameformstringNo
GenderformstringNo
HomeLanguageformstringNo
IdNumberformstringNo
LastNameformstringNo
PostalCodeformstringNo
RegionformstringNo
SuburbformstringNo
BirthDateformDateTime?No
ClassificationsformDictionary<string, string>No
CountryformstringNo
PassportNumberformstringNo
StatusCodesIdformlong?No
ReasonformstringNo
VulnerabilityFlagformbool?No
CompaniesNameformstringNo
SegmentsNameformstringNo
SegmentsIsCustomformbool?No
StatusCodesDescriptionformstringNo
CampaignsIdformlong?No
CustomersIdformlong?No
CampaignInstanceCommsStats Parameters:
NameParameterData TypeRequiredDescription
IdformlongYes
CampaignInstanceCommsIdformlongYes
ViewedDateformDateTimeOffset?No

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

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/jsonl

HTTP/1.1 200 OK
Content-Type: text/jsonl
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-01T00:00:00.0000000","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-01T00:00:00.0000000","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-01T00:00:00.0000000","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"}}}