digitaluapi

GetCampaignCustomerCertificateByCustomerId

The following routes are available for this service:
GET	/campaign/certbycustomerguid/{CampaignPublicAccessGuid}/{CustomerPublicAccessGuid}	Get Campaign Certificate By Campaign and Customer GUID

Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports digitaluapi.ServiceModel
Imports digitaluapi.ServiceModel.Types

Namespace Global

    Namespace digitaluapi.ServiceModel

        Public Partial Class CampaignInstanceCommsDetails
            Public Overridable Property CampaignInstanceComms As CampaignInstanceComms
            Public Overridable Property EmailEvents As List(Of EmailEventsView)
            Public Overridable Property SmsWatsappEvents As List(Of SmsWatsappEventsView)
            Public Overridable Property CampaignInstanceCommsStats As List(Of CampaignInstanceCommsStats)
        End Class

        Public Partial Class GetCampaignCustomerCertificateByCustomerId
            Public Overridable Property CampaignPublicAccessGuid As Guid
            Public Overridable Property CustomerPublicAccessGuid As Guid
        End Class

        Public Partial Class GetCampaignCustomerCertificateResponse
            Public Overridable Property Campaign As Campaigns
            Public Overridable Property Customer As Customers
            Public Overridable Property CampaignInstanceCommsDetails As List(Of CampaignInstanceCommsDetails)
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace

    Namespace digitaluapi.ServiceModel.Types

        Public Partial Class CampaignActionsView
            <DataMember(Order:=1)>
            <Required>
            Public Overridable Property Id As Long

            <DataMember(Order:=2)>
            <Required>
            <References(GetType(Campaigns))>
            Public Overridable Property CampaignsId As Long

            <DataMember(Order:=3)>
            <References(GetType(Actions))>
            Public Overridable Property ActionsId As Long?

            <DataMember(Order:=4)>
            Public Overridable Property ButtonName As String

            <DataMember(Order:=5)>
            <References(GetType(ActionTypes))>
            Public Overridable Property ActionTypesId As Integer?

            <DataMember(Order:=6)>
            Public Overridable Property Description As String

            <DataMember(Order:=7)>
            Public Overridable Property OfferOrder As Short?

            <DataMember(Order:=8)>
            Public Overridable Property StandOut As Boolean?

            <DataMember(Order:=9)>
            <Required>
            Public Overridable Property PublicAccessGuid As Guid

            <DataMember(Order:=10)>
            Public Overridable Property IsPayment As Boolean

            <DataMember(Order:=11)>
            Public Overridable Property IsPayOff As Boolean

            <DataMember(Order:=12)>
            Public Overridable Property IsEnabled As Boolean
        End Class

        Public Partial Class CampaignInstanceComms
            <DataMember(Order:=1)>
            <Required>
            Public Overridable Property Id As Long

            <DataMember(Order:=2)>
            <Required>
            <References(GetType(CampaignInstanceCustomers))>
            Public Overridable Property CampaignInstanceCustomersId As Long

            <DataMember(Order:=3)>
            <Required>
            <References(GetType(Channels))>
            Public Overridable Property ChannelsId As Integer

            <DataMember(Order:=4)>
            Public Overridable Property Email As String

            <DataMember(Order:=5)>
            Public Overridable Property MobileNumber As String

            <DataMember(Order:=6)>
            Public Overridable Property EmailAttachmentTemplate As String

            <DataMember(Order:=7)>
            Public Overridable Property EmailTemplate As String

            <DataMember(Order:=8)>
            Public Overridable Property EmailHtmlTemplate As String

            <DataMember(Order:=9)>
            Public Overridable Property SmsTemplate As String

            <DataMember(Order:=10)>
            <Required>
            Public Overridable Property PublicAccessGuid As Guid

            <DataMember(Order:=11)>
            <Required>
            <References(GetType(Campaigns))>
            Public Overridable Property CampaignsId As Long

            <DataMember(Order:=12)>
            Public Overridable Property DebtsId As Long?

            <DataMember(Order:=13)>
            <Required>
            Public Overridable Property IsPaymentCampaign As Boolean

            <DataMember(Order:=14)>
            <References(GetType(SchedulesInstances))>
            Public Overridable Property ScheduleInstancesId As Long?

            <DataMember(Order:=15)>
            Public Overridable Property StatusCodesId As Long?

            <DataMember(Order:=16)>
            Public Overridable Property EmailTemplatesId As Long?

            <DataMember(Order:=17)>
            Public Overridable Property AvatarTemplateText As String

            <DataMember(Order:=18)>
            Public Overridable Property HeadingTemplateText As String

            <DataMember(Order:=19)>
            Public Overridable Property SubheadingTemplateText As String

            <DataMember(Order:=20)>
            Public Overridable Property Sent As Boolean

            <DataMember(Order:=21)>
            Public Overridable Property Failed As Boolean

            <DataMember(Order:=22)>
            Public Overridable Property CommsUrl As String
        End Class

        Public Partial Class CampaignInstanceCommsStats
            <DataMember(Order:=1)>
            <Required>
            Public Overridable Property Id As Long

            <DataMember(Order:=2)>
            <Required>
            Public Overridable Property CampaignInstanceCommsId As Long

            <DataMember(Order:=3)>
            Public Overridable Property ViewedDate As DateTimeOffset?
        End Class

        Public Partial Class Campaigns
            <DataMember(Order:=1)>
            <Required>
            Public Overridable Property Id As Long

            <DataMember(Order:=2)>
            <Required>
            Public Overridable Property TenantsId As Integer

            <DataMember(Order:=3)>
            <Required>
            Public Overridable Property Name As String

            <DataMember(Order:=4)>
            <Required>
            Public Overridable Property Description As String

            <DataMember(Order:=5)>
            <References(GetType(Avatars))>
            Public Overridable Property AvatarsId As Long?

            <DataMember(Order:=6)>
            <References(GetType(Schedules))>
            Public Overridable Property SchedulesId As Long?

            <DataMember(Order:=7)>
            <References(GetType(MessageTones))>
            Public Overridable Property MessageTonesId As Integer?

            <DataMember(Order:=8)>
            <Required>
            <References(GetType(StatusCodes))>
            Public Overridable Property StatusCodesId As Long

            <DataMember(Order:=9)>
            <Required>
            Public Overridable Property PublicAccessGuid As Guid

            <DataMember(Order:=10)>
            Public Overridable Property ViewHeading As String

            <DataMember(Order:=11)>
            Public Overridable Property CampaignActions As List(Of CampaignActionsView)
        End Class

        Public Partial Class Customers
            <DataMember(Order:=1)>
            <Required>
            Public Overridable Property Id As Long

            <DataMember(Order:=2)>
            <Required>
            <References(GetType(Tenants))>
            Public Overridable Property TenantsId As Integer

            <DataMember(Order:=3)>
            <References(GetType(AppUser))>
            Public Overridable Property UserAuthId As Integer?

            <DataMember(Order:=4)>
            <Required>
            <References(GetType(Segments))>
            Public Overridable Property SegmentsId As Long

            <DataMember(Order:=5)>
            <References(GetType(Companies))>
            Public Overridable Property CompaniesId As Long?

            <DataMember(Order:=6)>
            Public Overridable Property CurrenciesId As Integer?

            <DataMember(Order:=7)>
            Public Overridable Property Address As String

            <DataMember(Order:=8)>
            Public Overridable Property Age As Integer?

            <DataMember(Order:=9)>
            Public Overridable Property City As String

            <DataMember(Order:=10)>
            Public Overridable Property ContactNumber As String

            <DataMember(Order:=11)>
            Public Overridable Property Email As String

            <DataMember(Order:=12)>
            Public Overridable Property EthnicGroup As String

            <DataMember(Order:=13)>
            Public Overridable Property FirstName As String

            <DataMember(Order:=14)>
            Public Overridable Property Gender As String

            <DataMember(Order:=15)>
            Public Overridable Property HomeLanguage As String

            <DataMember(Order:=16)>
            Public Overridable Property IdNumber As String

            <DataMember(Order:=17)>
            Public Overridable Property LastName As String

            <DataMember(Order:=18)>
            Public Overridable Property PostalCode As String

            <DataMember(Order:=19)>
            Public Overridable Property Region As String

            <DataMember(Order:=20)>
            Public Overridable Property Suburb As String

            <DataMember(Order:=21)>
            Public Overridable Property UniqueIdentifier As String

            <DataMember(Order:=22)>
            Public Overridable Property BirthDate As Date?

            <DataMember(Order:=23)>
            Public Overridable Property Classifications As Dictionary(Of String, String)

            <DataMember(Order:=24)>
            Public Overridable Property Country As String

            <DataMember(Order:=25)>
            Public Overridable Property PassportNumber As String

            <DataMember(Order:=26)>
            <Required>
            <References(GetType(StatusCodes))>
            Public Overridable Property StatusCodesId As Long

            <DataMember(Order:=27)>
            Public Overridable Property Reason As String

            <DataMember(Order:=28)>
            Public Overridable Property VulnerabilityFlag As Boolean?

            <DataMember(Order:=29)>
            Public Overridable Property Meta As Dictionary(Of String, String)

            <DataMember(Order:=31)>
            <Computed>
            Public Overridable Property PublicAccessGuid As Guid

            <DataMember(Order:=32)>
            Public Overridable Property CustomField1 As String

            <DataMember(Order:=33)>
            Public Overridable Property CustomField2 As String

            <DataMember(Order:=34)>
            Public Overridable Property CustomField3 As String

            <DataMember(Order:=35)>
            Public Overridable Property CustomField4 As String

            <DataMember(Order:=36)>
            Public Overridable Property CustomField5 As String

            <DataMember(Order:=37)>
            Public Overridable Property CustomField6 As String

            <DataMember(Order:=38)>
            Public Overridable Property CustomField7 As String

            <DataMember(Order:=39)>
            Public Overridable Property CustomField8 As String

            <DataMember(Order:=40)>
            Public Overridable Property CustomField9 As String

            <DataMember(Order:=41)>
            Public Overridable Property CustomField10 As String
        End Class

        Public Partial Class EmailEventsView
            <DataMember(Order:=1)>
            Public Overridable Property Id As Long?

            <DataMember(Order:=2)>
            Public Overridable Property Email As String

            <DataMember(Order:=3)>
            Public Overridable Property TimestampDate As DateTimeOffset?

            <DataMember(Order:=4)>
            Public Overridable Property [Event] As String

            <DataMember(Order:=5)>
            Public Overridable Property Category As String

            <DataMember(Order:=6)>
            Public Overridable Property SgEventId As String

            <DataMember(Order:=7)>
            Public Overridable Property SgMessageId As String

            <DataMember(Order:=8)>
            Public Overridable Property UserAgent As String

            <DataMember(Order:=9)>
            Public Overridable Property Ipaddress As String

            <DataMember(Order:=10)>
            Public Overridable Property Url As String

            <DataMember(Order:=11)>
            Public Overridable Property CampaignInstanceCommsId As Long?

            <DataMember(Order:=12)>
            Public Overridable Property TenantsId As Integer?

            <DataMember(Order:=13)>
            Public Overridable Property SegmentsId As Long?

            <DataMember(Order:=14)>
            Public Overridable Property Address As String

            <DataMember(Order:=15)>
            Public Overridable Property Age As Integer?

            <DataMember(Order:=16)>
            Public Overridable Property City As String

            <DataMember(Order:=17)>
            Public Overridable Property ContactNumber As String

            <DataMember(Order:=18)>
            Public Overridable Property EthnicGroup As String

            <DataMember(Order:=19)>
            Public Overridable Property FirstName As String

            <DataMember(Order:=20)>
            Public Overridable Property Gender As String

            <DataMember(Order:=21)>
            Public Overridable Property HomeLanguage As String

            <DataMember(Order:=22)>
            Public Overridable Property IdNumber As String

            <DataMember(Order:=23)>
            Public Overridable Property LastName As String

            <DataMember(Order:=24)>
            Public Overridable Property PostalCode As String

            <DataMember(Order:=25)>
            Public Overridable Property Region As String

            <DataMember(Order:=26)>
            Public Overridable Property Suburb As String

            <DataMember(Order:=27)>
            Public Overridable Property BirthDate As Date?

            <DataMember(Order:=28)>
            Public Overridable Property Classifications As Dictionary(Of String, String)

            <DataMember(Order:=29)>
            Public Overridable Property Country As String

            <DataMember(Order:=30)>
            Public Overridable Property PassportNumber As String

            <DataMember(Order:=31)>
            Public Overridable Property StatusCodesId As Long?

            <DataMember(Order:=32)>
            Public Overridable Property Reason As String

            <DataMember(Order:=33)>
            Public Overridable Property VulnerabilityFlag As Boolean?

            <DataMember(Order:=34)>
            Public Overridable Property CompaniesName As String

            <DataMember(Order:=35)>
            Public Overridable Property SegmentsName As String

            <DataMember(Order:=36)>
            Public Overridable Property SegmentsIsCustom As Boolean?

            <DataMember(Order:=37)>
            Public Overridable Property StatusCodesDescription As String

            <DataMember(Order:=38)>
            Public Overridable Property CampaignsId As Long?
        End Class

        Public Partial Class SmsWatsappEventsView
            <DataMember(Order:=1)>
            Public Overridable Property Id As Long?

            <DataMember(Order:=2)>
            Public Overridable Property CampaignInstancesCommsId As Long?

            <DataMember(Order:=3)>
            Public Overridable Property RawJson As Dictionary(Of String, String)

            <DataMember(Order:=4)>
            Public Overridable Property IntegrationId As String

            <DataMember(Order:=5)>
            Public Overridable Property IntegrationName As String

            <DataMember(Order:=6)>
            Public Overridable Property Channel As String

            <DataMember(Order:=7)>
            Public Overridable Property Timestamp As Long?

            <DataMember(Order:=8)>
            Public Overridable Property TimestampDate As DateTimeOffset?

            <DataMember(Order:=9)>
            Public Overridable Property StatusCode As Integer?

            <DataMember(Order:=10)>
            Public Overridable Property Status As String

            <DataMember(Order:=11)>
            Public Overridable Property MessageId As String

            <DataMember(Order:=12)>
            Public Overridable Property ClientMessageId As String

            <DataMember(Order:=13)>
            Public Overridable Property TenantsId As Integer?

            <DataMember(Order:=14)>
            Public Overridable Property SegmentsId As Long?

            <DataMember(Order:=15)>
            Public Overridable Property Address As String

            <DataMember(Order:=16)>
            Public Overridable Property Age As Integer?

            <DataMember(Order:=17)>
            Public Overridable Property City As String

            <DataMember(Order:=18)>
            Public Overridable Property ContactNumber As String

            <DataMember(Order:=19)>
            Public Overridable Property EthnicGroup As String

            <DataMember(Order:=20)>
            Public Overridable Property FirstName As String

            <DataMember(Order:=21)>
            Public Overridable Property Gender As String

            <DataMember(Order:=22)>
            Public Overridable Property HomeLanguage As String

            <DataMember(Order:=23)>
            Public Overridable Property IdNumber As String

            <DataMember(Order:=24)>
            Public Overridable Property LastName As String

            <DataMember(Order:=25)>
            Public Overridable Property PostalCode As String

            <DataMember(Order:=26)>
            Public Overridable Property Region As String

            <DataMember(Order:=27)>
            Public Overridable Property Suburb As String

            <DataMember(Order:=28)>
            Public Overridable Property BirthDate As Date?

            <DataMember(Order:=29)>
            Public Overridable Property Classifications As Dictionary(Of String, String)

            <DataMember(Order:=30)>
            Public Overridable Property Country As String

            <DataMember(Order:=31)>
            Public Overridable Property PassportNumber As String

            <DataMember(Order:=32)>
            Public Overridable Property StatusCodesId As Long?

            <DataMember(Order:=33)>
            Public Overridable Property Reason As String

            <DataMember(Order:=34)>
            Public Overridable Property VulnerabilityFlag As Boolean?

            <DataMember(Order:=35)>
            Public Overridable Property CompaniesName As String

            <DataMember(Order:=36)>
            Public Overridable Property SegmentsName As String

            <DataMember(Order:=37)>
            Public Overridable Property SegmentsIsCustom As Boolean?

            <DataMember(Order:=38)>
            Public Overridable Property StatusCodesDescription As String

            <DataMember(Order:=39)>
            Public Overridable Property CampaignsId As Long?

            <DataMember(Order:=40)>
            Public Overridable Property CustomersId As Long?
        End Class
    End Namespace
End Namespace

VB.NET GetCampaignCustomerCertificateByCustomerId DTOs

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