digitaluapi

GetCampaignCustomerCertificateByCommsGuid

The following routes are available for this service:
GET	/campaign/certbycommsguid/{CampaignInstanceCommsPublicAccessGuid}	Get Campaign Certificate By Comms Guid

**GetCampaignCustomerCertificateByCommsGuid** Parameters:
Name	Parameter	Data Type	Required	Description
CampaignInstanceCommsPublicAccessGuid	path	Guid	No

**GetCampaignCustomerCertificateResponse** Parameters:
Name	Parameter	Data Type	Required
Campaign	form	Campaigns	No
Customer	form	Customers	No
CampaignInstanceCommsDetails	form	List<CampaignInstanceCommsDetails>	No
ResponseStatus	form	ResponseStatus	No

**Campaigns** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	Yes
TenantsId	form	int	Yes
Name	form	string	Yes
Description	form	string	Yes
AvatarsId	form	long?	No
SchedulesId	form	long?	No
MessageTonesId	form	int?	No
StatusCodesId	form	long	Yes
PublicAccessGuid	form	Guid	Yes
ViewHeading	form	string	No
CampaignActions	form	List<CampaignActionsView>	No

**CampaignActionsView** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	Yes
CampaignsId	form	long	Yes
ActionsId	form	long?	No
ButtonName	form	string	No
ActionTypesId	form	int?	No
Description	form	string	No
OfferOrder	form	short?	No
StandOut	form	bool?	No
PublicAccessGuid	form	Guid	Yes
IsPayment	form	bool	No
IsPayOff	form	bool	No
IsEnabled	form	bool	No

**Customers** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	Yes
TenantsId	form	int	Yes
UserAuthId	form	int?	No
SegmentsId	form	long	Yes
CompaniesId	form	long?	No
CurrenciesId	form	int?	No
Address	form	string	No
Age	form	int?	No
City	form	string	No
ContactNumber	form	string	No
Email	form	string	No
EthnicGroup	form	string	No
FirstName	form	string	No
Gender	form	string	No
HomeLanguage	form	string	No
IdNumber	form	string	No
LastName	form	string	No
PostalCode	form	string	No
Region	form	string	No
Suburb	form	string	No
UniqueIdentifier	form	string	No
BirthDate	form	DateTime?	No
Classifications	form	Dictionary<string, string>	No
Country	form	string	No
PassportNumber	form	string	No
StatusCodesId	form	long	Yes
Reason	form	string	No
VulnerabilityFlag	form	bool?	No
Meta	form	Dictionary<string, string>	No
PublicAccessGuid	form	Guid	No
CustomField1	form	string	No
CustomField2	form	string	No
CustomField3	form	string	No
CustomField4	form	string	No
CustomField5	form	string	No
CustomField6	form	string	No
CustomField7	form	string	No
CustomField8	form	string	No
CustomField9	form	string	No
CustomField10	form	string	No

**CampaignInstanceCommsDetails** Parameters:
Name	Parameter	Data Type	Required
CampaignInstanceComms	form	CampaignInstanceComms	No
EmailEvents	form	List<EmailEventsView>	No
SmsWatsappEvents	form	List<SmsWatsappEventsView>	No
CampaignInstanceCommsStats	form	List<CampaignInstanceCommsStats>	No

**CampaignInstanceComms** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	Yes
CampaignInstanceCustomersId	form	long	Yes
ChannelsId	form	int	Yes
Email	form	string	No
MobileNumber	form	string	No
EmailAttachmentTemplate	form	string	No
EmailTemplate	form	string	No
EmailHtmlTemplate	form	string	No
SmsTemplate	form	string	No
PublicAccessGuid	form	Guid	Yes
CampaignsId	form	long	Yes
DebtsId	form	long?	No
IsPaymentCampaign	form	bool	Yes
ScheduleInstancesId	form	long?	No
StatusCodesId	form	long?	No
EmailTemplatesId	form	long?	No
AvatarTemplateText	form	string	No
HeadingTemplateText	form	string	No
SubheadingTemplateText	form	string	No
Sent	form	bool	No
Failed	form	bool	No
CommsUrl	form	string	No

**EmailEventsView** Parameters:
Name	Parameter	Data Type	Required
Id	form	long?	No
Email	form	string	No
TimestampDate	form	DateTimeOffset?	No
Event	form	string	No
Category	form	string	No
SgEventId	form	string	No
SgMessageId	form	string	No
UserAgent	form	string	No
Ipaddress	form	string	No
Url	form	string	No
CampaignInstanceCommsId	form	long?	No
TenantsId	form	int?	No
SegmentsId	form	long?	No
Address	form	string	No
Age	form	int?	No
City	form	string	No
ContactNumber	form	string	No
EthnicGroup	form	string	No
FirstName	form	string	No
Gender	form	string	No
HomeLanguage	form	string	No
IdNumber	form	string	No
LastName	form	string	No
PostalCode	form	string	No
Region	form	string	No
Suburb	form	string	No
BirthDate	form	DateTime?	No
Classifications	form	Dictionary<string, string>	No
Country	form	string	No
PassportNumber	form	string	No
StatusCodesId	form	long?	No
Reason	form	string	No
VulnerabilityFlag	form	bool?	No
CompaniesName	form	string	No
SegmentsName	form	string	No
SegmentsIsCustom	form	bool?	No
StatusCodesDescription	form	string	No
CampaignsId	form	long?	No

**SmsWatsappEventsView** Parameters:
Name	Parameter	Data Type	Required
Id	form	long?	No
CampaignInstancesCommsId	form	long?	No
RawJson	form	Dictionary<string, string>	No
IntegrationId	form	string	No
IntegrationName	form	string	No
Channel	form	string	No
Timestamp	form	long?	No
TimestampDate	form	DateTimeOffset?	No
StatusCode	form	int?	No
Status	form	string	No
MessageId	form	string	No
ClientMessageId	form	string	No
TenantsId	form	int?	No
SegmentsId	form	long?	No
Address	form	string	No
Age	form	int?	No
City	form	string	No
ContactNumber	form	string	No
EthnicGroup	form	string	No
FirstName	form	string	No
Gender	form	string	No
HomeLanguage	form	string	No
IdNumber	form	string	No
LastName	form	string	No
PostalCode	form	string	No
Region	form	string	No
Suburb	form	string	No
BirthDate	form	DateTime?	No
Classifications	form	Dictionary<string, string>	No
Country	form	string	No
PassportNumber	form	string	No
StatusCodesId	form	long?	No
Reason	form	string	No
VulnerabilityFlag	form	bool?	No
CompaniesName	form	string	No
SegmentsName	form	string	No
SegmentsIsCustom	form	bool?	No
StatusCodesDescription	form	string	No
CampaignsId	form	long?	No
CustomersId	form	long?	No

**CampaignInstanceCommsStats** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	Yes
CampaignInstanceCommsId	form	long	Yes
ViewedDate	form	DateTimeOffset?	No

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

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /campaign/certbycommsguid/{CampaignInstanceCommsPublicAccessGuid} 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
		}
	}
}