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
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using digitaluapi.ServiceModel;
using digitaluapi.ServiceModel.Types;

namespace digitaluapi.ServiceModel
{
    public partial class CampaignInstanceCommsDetails
    {
        public virtual CampaignInstanceComms CampaignInstanceComms { get; set; }
        public virtual List<EmailEventsView> EmailEvents { get; set; }
        public virtual List<SmsWatsappEventsView> SmsWatsappEvents { get; set; }
        public virtual List<CampaignInstanceCommsStats> CampaignInstanceCommsStats { get; set; }
    }

    public partial class GetCampaignCustomerCertificateByCustomerId
    {
        public virtual Guid CampaignPublicAccessGuid { get; set; }
        public virtual Guid CustomerPublicAccessGuid { get; set; }
    }

    public partial class GetCampaignCustomerCertificateResponse
    {
        public virtual Campaigns Campaign { get; set; }
        public virtual Customers Customer { get; set; }
        public virtual List<CampaignInstanceCommsDetails> CampaignInstanceCommsDetails { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

namespace digitaluapi.ServiceModel.Types
{
    public partial class CampaignActionsView
    {
        [DataMember(Order=1)]
        [Required]
        public virtual long Id { get; set; }

        [DataMember(Order=2)]
        [Required]
        [References(typeof(digitaluapi.ServiceModel.Types.Campaigns))]
        public virtual long CampaignsId { get; set; }

        [DataMember(Order=3)]
        [References(typeof(digitaluapi.ServiceModel.Types.Actions))]
        public virtual long? ActionsId { get; set; }

        [DataMember(Order=4)]
        public virtual string ButtonName { get; set; }

        [DataMember(Order=5)]
        [References(typeof(digitaluapi.ServiceModel.Types.ActionTypes))]
        public virtual int? ActionTypesId { get; set; }

        [DataMember(Order=6)]
        public virtual string Description { get; set; }

        [DataMember(Order=7)]
        public virtual short? OfferOrder { get; set; }

        [DataMember(Order=8)]
        public virtual bool? StandOut { get; set; }

        [DataMember(Order=9)]
        [Required]
        public virtual Guid PublicAccessGuid { get; set; }

        [DataMember(Order=10)]
        public virtual bool IsPayment { get; set; }

        [DataMember(Order=11)]
        public virtual bool IsPayOff { get; set; }

        [DataMember(Order=12)]
        public virtual bool IsEnabled { get; set; }
    }

    public partial class CampaignInstanceComms
    {
        [DataMember(Order=1)]
        [Required]
        public virtual long Id { get; set; }

        [DataMember(Order=2)]
        [Required]
        [References(typeof(digitaluapi.ServiceModel.Types.CampaignInstanceCustomers))]
        public virtual long CampaignInstanceCustomersId { get; set; }

        [DataMember(Order=3)]
        [Required]
        [References(typeof(digitaluapi.ServiceModel.Types.Channels))]
        public virtual int ChannelsId { get; set; }

        [DataMember(Order=4)]
        public virtual string Email { get; set; }

        [DataMember(Order=5)]
        public virtual string MobileNumber { get; set; }

        [DataMember(Order=6)]
        public virtual string EmailAttachmentTemplate { get; set; }

        [DataMember(Order=7)]
        public virtual string EmailTemplate { get; set; }

        [DataMember(Order=8)]
        public virtual string EmailHtmlTemplate { get; set; }

        [DataMember(Order=9)]
        public virtual string SmsTemplate { get; set; }

        [DataMember(Order=10)]
        [Required]
        public virtual Guid PublicAccessGuid { get; set; }

        [DataMember(Order=11)]
        [Required]
        [References(typeof(digitaluapi.ServiceModel.Types.Campaigns))]
        public virtual long CampaignsId { get; set; }

        [DataMember(Order=12)]
        public virtual long? DebtsId { get; set; }

        [DataMember(Order=13)]
        [Required]
        public virtual bool IsPaymentCampaign { get; set; }

        [DataMember(Order=14)]
        [References(typeof(digitaluapi.ServiceModel.Types.SchedulesInstances))]
        public virtual long? ScheduleInstancesId { get; set; }

        [DataMember(Order=15)]
        public virtual long? StatusCodesId { get; set; }

        [DataMember(Order=16)]
        public virtual long? EmailTemplatesId { get; set; }

        [DataMember(Order=17)]
        public virtual string AvatarTemplateText { get; set; }

        [DataMember(Order=18)]
        public virtual string HeadingTemplateText { get; set; }

        [DataMember(Order=19)]
        public virtual string SubheadingTemplateText { get; set; }

        [DataMember(Order=20)]
        public virtual bool Sent { get; set; }

        [DataMember(Order=21)]
        public virtual bool Failed { get; set; }

        [DataMember(Order=22)]
        public virtual string CommsUrl { get; set; }
    }

    public partial class CampaignInstanceCommsStats
    {
        [DataMember(Order=1)]
        [Required]
        public virtual long Id { get; set; }

        [DataMember(Order=2)]
        [Required]
        public virtual long CampaignInstanceCommsId { get; set; }

        [DataMember(Order=3)]
        public virtual DateTimeOffset? ViewedDate { get; set; }
    }

    public partial class Campaigns
    {
        [DataMember(Order=1)]
        [Required]
        public virtual long Id { get; set; }

        [DataMember(Order=2)]
        [Required]
        public virtual int TenantsId { get; set; }

        [DataMember(Order=3)]
        [Required]
        public virtual string Name { get; set; }

        [DataMember(Order=4)]
        [Required]
        public virtual string Description { get; set; }

        [DataMember(Order=5)]
        [References(typeof(digitaluapi.ServiceModel.Types.Avatars))]
        public virtual long? AvatarsId { get; set; }

        [DataMember(Order=6)]
        [References(typeof(digitaluapi.ServiceModel.Types.Schedules))]
        public virtual long? SchedulesId { get; set; }

        [DataMember(Order=7)]
        [References(typeof(digitaluapi.ServiceModel.Types.MessageTones))]
        public virtual int? MessageTonesId { get; set; }

        [DataMember(Order=8)]
        [Required]
        [References(typeof(digitaluapi.ServiceModel.Types.StatusCodes))]
        public virtual long StatusCodesId { get; set; }

        [DataMember(Order=9)]
        [Required]
        public virtual Guid PublicAccessGuid { get; set; }

        [DataMember(Order=10)]
        public virtual string ViewHeading { get; set; }

        [DataMember(Order=11)]
        public virtual List<CampaignActionsView> CampaignActions { get; set; }
    }

    public partial class Customers
    {
        [DataMember(Order=1)]
        [Required]
        public virtual long Id { get; set; }

        [DataMember(Order=2)]
        [Required]
        [References(typeof(digitaluapi.ServiceModel.Types.Tenants))]
        public virtual int TenantsId { get; set; }

        [DataMember(Order=3)]
        [References(typeof(digitaluapi.ServiceModel.Types.AppUser))]
        public virtual int? UserAuthId { get; set; }

        [DataMember(Order=4)]
        [Required]
        [References(typeof(digitaluapi.ServiceModel.Types.Segments))]
        public virtual long SegmentsId { get; set; }

        [DataMember(Order=5)]
        [References(typeof(digitaluapi.ServiceModel.Types.Companies))]
        public virtual long? CompaniesId { get; set; }

        [DataMember(Order=6)]
        public virtual int? CurrenciesId { get; set; }

        [DataMember(Order=7)]
        public virtual string Address { get; set; }

        [DataMember(Order=8)]
        public virtual int? Age { get; set; }

        [DataMember(Order=9)]
        public virtual string City { get; set; }

        [DataMember(Order=10)]
        public virtual string ContactNumber { get; set; }

        [DataMember(Order=11)]
        public virtual string Email { get; set; }

        [DataMember(Order=12)]
        public virtual string EthnicGroup { get; set; }

        [DataMember(Order=13)]
        public virtual string FirstName { get; set; }

        [DataMember(Order=14)]
        public virtual string Gender { get; set; }

        [DataMember(Order=15)]
        public virtual string HomeLanguage { get; set; }

        [DataMember(Order=16)]
        public virtual string IdNumber { get; set; }

        [DataMember(Order=17)]
        public virtual string LastName { get; set; }

        [DataMember(Order=18)]
        public virtual string PostalCode { get; set; }

        [DataMember(Order=19)]
        public virtual string Region { get; set; }

        [DataMember(Order=20)]
        public virtual string Suburb { get; set; }

        [DataMember(Order=21)]
        public virtual string UniqueIdentifier { get; set; }

        [DataMember(Order=22)]
        public virtual DateTime? BirthDate { get; set; }

        [DataMember(Order=23)]
        public virtual Dictionary<string, string> Classifications { get; set; }

        [DataMember(Order=24)]
        public virtual string Country { get; set; }

        [DataMember(Order=25)]
        public virtual string PassportNumber { get; set; }

        [DataMember(Order=26)]
        [Required]
        [References(typeof(digitaluapi.ServiceModel.Types.StatusCodes))]
        public virtual long StatusCodesId { get; set; }

        [DataMember(Order=27)]
        public virtual string Reason { get; set; }

        [DataMember(Order=28)]
        public virtual bool? VulnerabilityFlag { get; set; }

        [DataMember(Order=29)]
        public virtual Dictionary<string, string> Meta { get; set; }

        [DataMember(Order=31)]
        [Computed]
        public virtual Guid PublicAccessGuid { get; set; }

        [DataMember(Order=32)]
        public virtual string CustomField1 { get; set; }

        [DataMember(Order=33)]
        public virtual string CustomField2 { get; set; }

        [DataMember(Order=34)]
        public virtual string CustomField3 { get; set; }

        [DataMember(Order=35)]
        public virtual string CustomField4 { get; set; }

        [DataMember(Order=36)]
        public virtual string CustomField5 { get; set; }

        [DataMember(Order=37)]
        public virtual string CustomField6 { get; set; }

        [DataMember(Order=38)]
        public virtual string CustomField7 { get; set; }

        [DataMember(Order=39)]
        public virtual string CustomField8 { get; set; }

        [DataMember(Order=40)]
        public virtual string CustomField9 { get; set; }

        [DataMember(Order=41)]
        public virtual string CustomField10 { get; set; }
    }

    public partial class EmailEventsView
    {
        [DataMember(Order=1)]
        public virtual long? Id { get; set; }

        [DataMember(Order=2)]
        public virtual string Email { get; set; }

        [DataMember(Order=3)]
        public virtual DateTimeOffset? TimestampDate { get; set; }

        [DataMember(Order=4)]
        public virtual string Event { get; set; }

        [DataMember(Order=5)]
        public virtual string Category { get; set; }

        [DataMember(Order=6)]
        public virtual string SgEventId { get; set; }

        [DataMember(Order=7)]
        public virtual string SgMessageId { get; set; }

        [DataMember(Order=8)]
        public virtual string UserAgent { get; set; }

        [DataMember(Order=9)]
        public virtual string Ipaddress { get; set; }

        [DataMember(Order=10)]
        public virtual string Url { get; set; }

        [DataMember(Order=11)]
        public virtual long? CampaignInstanceCommsId { get; set; }

        [DataMember(Order=12)]
        public virtual int? TenantsId { get; set; }

        [DataMember(Order=13)]
        public virtual long? SegmentsId { get; set; }

        [DataMember(Order=14)]
        public virtual string Address { get; set; }

        [DataMember(Order=15)]
        public virtual int? Age { get; set; }

        [DataMember(Order=16)]
        public virtual string City { get; set; }

        [DataMember(Order=17)]
        public virtual string ContactNumber { get; set; }

        [DataMember(Order=18)]
        public virtual string EthnicGroup { get; set; }

        [DataMember(Order=19)]
        public virtual string FirstName { get; set; }

        [DataMember(Order=20)]
        public virtual string Gender { get; set; }

        [DataMember(Order=21)]
        public virtual string HomeLanguage { get; set; }

        [DataMember(Order=22)]
        public virtual string IdNumber { get; set; }

        [DataMember(Order=23)]
        public virtual string LastName { get; set; }

        [DataMember(Order=24)]
        public virtual string PostalCode { get; set; }

        [DataMember(Order=25)]
        public virtual string Region { get; set; }

        [DataMember(Order=26)]
        public virtual string Suburb { get; set; }

        [DataMember(Order=27)]
        public virtual DateTime? BirthDate { get; set; }

        [DataMember(Order=28)]
        public virtual Dictionary<string, string> Classifications { get; set; }

        [DataMember(Order=29)]
        public virtual string Country { get; set; }

        [DataMember(Order=30)]
        public virtual string PassportNumber { get; set; }

        [DataMember(Order=31)]
        public virtual long? StatusCodesId { get; set; }

        [DataMember(Order=32)]
        public virtual string Reason { get; set; }

        [DataMember(Order=33)]
        public virtual bool? VulnerabilityFlag { get; set; }

        [DataMember(Order=34)]
        public virtual string CompaniesName { get; set; }

        [DataMember(Order=35)]
        public virtual string SegmentsName { get; set; }

        [DataMember(Order=36)]
        public virtual bool? SegmentsIsCustom { get; set; }

        [DataMember(Order=37)]
        public virtual string StatusCodesDescription { get; set; }

        [DataMember(Order=38)]
        public virtual long? CampaignsId { get; set; }
    }

    public partial class SmsWatsappEventsView
    {
        [DataMember(Order=1)]
        public virtual long? Id { get; set; }

        [DataMember(Order=2)]
        public virtual long? CampaignInstancesCommsId { get; set; }

        [DataMember(Order=3)]
        public virtual Dictionary<string, string> RawJson { get; set; }

        [DataMember(Order=4)]
        public virtual string IntegrationId { get; set; }

        [DataMember(Order=5)]
        public virtual string IntegrationName { get; set; }

        [DataMember(Order=6)]
        public virtual string Channel { get; set; }

        [DataMember(Order=7)]
        public virtual long? Timestamp { get; set; }

        [DataMember(Order=8)]
        public virtual DateTimeOffset? TimestampDate { get; set; }

        [DataMember(Order=9)]
        public virtual int? StatusCode { get; set; }

        [DataMember(Order=10)]
        public virtual string Status { get; set; }

        [DataMember(Order=11)]
        public virtual string MessageId { get; set; }

        [DataMember(Order=12)]
        public virtual string ClientMessageId { get; set; }

        [DataMember(Order=13)]
        public virtual int? TenantsId { get; set; }

        [DataMember(Order=14)]
        public virtual long? SegmentsId { get; set; }

        [DataMember(Order=15)]
        public virtual string Address { get; set; }

        [DataMember(Order=16)]
        public virtual int? Age { get; set; }

        [DataMember(Order=17)]
        public virtual string City { get; set; }

        [DataMember(Order=18)]
        public virtual string ContactNumber { get; set; }

        [DataMember(Order=19)]
        public virtual string EthnicGroup { get; set; }

        [DataMember(Order=20)]
        public virtual string FirstName { get; set; }

        [DataMember(Order=21)]
        public virtual string Gender { get; set; }

        [DataMember(Order=22)]
        public virtual string HomeLanguage { get; set; }

        [DataMember(Order=23)]
        public virtual string IdNumber { get; set; }

        [DataMember(Order=24)]
        public virtual string LastName { get; set; }

        [DataMember(Order=25)]
        public virtual string PostalCode { get; set; }

        [DataMember(Order=26)]
        public virtual string Region { get; set; }

        [DataMember(Order=27)]
        public virtual string Suburb { get; set; }

        [DataMember(Order=28)]
        public virtual DateTime? BirthDate { get; set; }

        [DataMember(Order=29)]
        public virtual Dictionary<string, string> Classifications { get; set; }

        [DataMember(Order=30)]
        public virtual string Country { get; set; }

        [DataMember(Order=31)]
        public virtual string PassportNumber { get; set; }

        [DataMember(Order=32)]
        public virtual long? StatusCodesId { get; set; }

        [DataMember(Order=33)]
        public virtual string Reason { get; set; }

        [DataMember(Order=34)]
        public virtual bool? VulnerabilityFlag { get; set; }

        [DataMember(Order=35)]
        public virtual string CompaniesName { get; set; }

        [DataMember(Order=36)]
        public virtual string SegmentsName { get; set; }

        [DataMember(Order=37)]
        public virtual bool? SegmentsIsCustom { get; set; }

        [DataMember(Order=38)]
        public virtual string StatusCodesDescription { get; set; }

        [DataMember(Order=39)]
        public virtual long? CampaignsId { get; set; }

        [DataMember(Order=40)]
        public virtual long? CustomersId { get; set; }
    }

}

C# GetCampaignCustomerCertificateByCustomerId DTOs

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