| GET | /campaign/certbycustomerguid/{CampaignPublicAccessGuid}/{CustomerPublicAccessGuid} | Get Campaign Certificate By Campaign and Customer GUID |
|---|
namespace digitaluapi.ServiceModel
open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type CampaignActionsView() =
[<DataMember(Order=1)>]
[<Required>]
member val Id:Int64 = new Int64() with get,set
[<DataMember(Order=2)>]
[<Required>]
[<References(typeof<Campaigns>)>]
member val CampaignsId:Int64 = new Int64() with get,set
[<DataMember(Order=3)>]
[<References(typeof<Actions>)>]
member val ActionsId:Nullable<Int64> = new Nullable<Int64>() with get,set
[<DataMember(Order=4)>]
member val ButtonName:String = null with get,set
[<DataMember(Order=5)>]
[<References(typeof<ActionTypes>)>]
member val ActionTypesId:Nullable<Int32> = new Nullable<Int32>() with get,set
[<DataMember(Order=6)>]
member val Description:String = null with get,set
[<DataMember(Order=7)>]
member val OfferOrder:Nullable<Int16> = new Nullable<Int16>() with get,set
[<DataMember(Order=8)>]
member val StandOut:Nullable<Boolean> = new Nullable<Boolean>() with get,set
[<DataMember(Order=9)>]
[<Required>]
member val PublicAccessGuid:Guid = new Guid() with get,set
[<DataMember(Order=10)>]
member val IsPayment:Boolean = new Boolean() with get,set
[<DataMember(Order=11)>]
member val IsPayOff:Boolean = new Boolean() with get,set
[<DataMember(Order=12)>]
member val IsEnabled:Boolean = new Boolean() with get,set
[<AllowNullLiteral>]
type Campaigns() =
[<DataMember(Order=1)>]
[<Required>]
member val Id:Int64 = new Int64() with get,set
[<DataMember(Order=2)>]
[<Required>]
member val TenantsId:Int32 = new Int32() with get,set
[<DataMember(Order=3)>]
[<Required>]
member val Name:String = null with get,set
[<DataMember(Order=4)>]
[<Required>]
member val Description:String = null with get,set
[<DataMember(Order=5)>]
[<References(typeof<Avatars>)>]
member val AvatarsId:Nullable<Int64> = new Nullable<Int64>() with get,set
[<DataMember(Order=6)>]
[<References(typeof<Schedules>)>]
member val SchedulesId:Nullable<Int64> = new Nullable<Int64>() with get,set
[<DataMember(Order=7)>]
[<References(typeof<MessageTones>)>]
member val MessageTonesId:Nullable<Int32> = new Nullable<Int32>() with get,set
[<DataMember(Order=8)>]
[<Required>]
[<References(typeof<StatusCodes>)>]
member val StatusCodesId:Int64 = new Int64() with get,set
[<DataMember(Order=9)>]
[<Required>]
member val PublicAccessGuid:Guid = new Guid() with get,set
[<DataMember(Order=10)>]
member val ViewHeading:String = null with get,set
[<DataMember(Order=11)>]
member val CampaignActions:ResizeArray<CampaignActionsView> = null with get,set
[<AllowNullLiteral>]
type Customers() =
[<DataMember(Order=1)>]
[<Required>]
member val Id:Int64 = new Int64() with get,set
[<DataMember(Order=2)>]
[<Required>]
[<References(typeof<Tenants>)>]
member val TenantsId:Int32 = new Int32() with get,set
[<DataMember(Order=3)>]
[<References(typeof<AppUser>)>]
member val UserAuthId:Nullable<Int32> = new Nullable<Int32>() with get,set
[<DataMember(Order=4)>]
[<Required>]
[<References(typeof<Segments>)>]
member val SegmentsId:Int64 = new Int64() with get,set
[<DataMember(Order=5)>]
[<References(typeof<Companies>)>]
member val CompaniesId:Nullable<Int64> = new Nullable<Int64>() with get,set
[<DataMember(Order=6)>]
member val CurrenciesId:Nullable<Int32> = new Nullable<Int32>() with get,set
[<DataMember(Order=7)>]
member val Address:String = null with get,set
[<DataMember(Order=8)>]
member val Age:Nullable<Int32> = new Nullable<Int32>() with get,set
[<DataMember(Order=9)>]
member val City:String = null with get,set
[<DataMember(Order=10)>]
member val ContactNumber:String = null with get,set
[<DataMember(Order=11)>]
member val Email:String = null with get,set
[<DataMember(Order=12)>]
member val EthnicGroup:String = null with get,set
[<DataMember(Order=13)>]
member val FirstName:String = null with get,set
[<DataMember(Order=14)>]
member val Gender:String = null with get,set
[<DataMember(Order=15)>]
member val HomeLanguage:String = null with get,set
[<DataMember(Order=16)>]
member val IdNumber:String = null with get,set
[<DataMember(Order=17)>]
member val LastName:String = null with get,set
[<DataMember(Order=18)>]
member val PostalCode:String = null with get,set
[<DataMember(Order=19)>]
member val Region:String = null with get,set
[<DataMember(Order=20)>]
member val Suburb:String = null with get,set
[<DataMember(Order=21)>]
member val UniqueIdentifier:String = null with get,set
[<DataMember(Order=22)>]
member val BirthDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
[<DataMember(Order=23)>]
member val Classifications:Dictionary<String, String> = null with get,set
[<DataMember(Order=24)>]
member val Country:String = null with get,set
[<DataMember(Order=25)>]
member val PassportNumber:String = null with get,set
[<DataMember(Order=26)>]
[<Required>]
[<References(typeof<StatusCodes>)>]
member val StatusCodesId:Int64 = new Int64() with get,set
[<DataMember(Order=27)>]
member val Reason:String = null with get,set
[<DataMember(Order=28)>]
member val VulnerabilityFlag:Nullable<Boolean> = new Nullable<Boolean>() with get,set
[<DataMember(Order=29)>]
member val Meta:Dictionary<String, String> = null with get,set
[<DataMember(Order=31)>]
[<Computed>]
member val PublicAccessGuid:Guid = new Guid() with get,set
[<DataMember(Order=32)>]
member val CustomField1:String = null with get,set
[<DataMember(Order=33)>]
member val CustomField2:String = null with get,set
[<DataMember(Order=34)>]
member val CustomField3:String = null with get,set
[<DataMember(Order=35)>]
member val CustomField4:String = null with get,set
[<DataMember(Order=36)>]
member val CustomField5:String = null with get,set
[<DataMember(Order=37)>]
member val CustomField6:String = null with get,set
[<DataMember(Order=38)>]
member val CustomField7:String = null with get,set
[<DataMember(Order=39)>]
member val CustomField8:String = null with get,set
[<DataMember(Order=40)>]
member val CustomField9:String = null with get,set
[<DataMember(Order=41)>]
member val CustomField10:String = null with get,set
[<AllowNullLiteral>]
type CampaignInstanceComms() =
[<DataMember(Order=1)>]
[<Required>]
member val Id:Int64 = new Int64() with get,set
[<DataMember(Order=2)>]
[<Required>]
[<References(typeof<CampaignInstanceCustomers>)>]
member val CampaignInstanceCustomersId:Int64 = new Int64() with get,set
[<DataMember(Order=3)>]
[<Required>]
[<References(typeof<Channels>)>]
member val ChannelsId:Int32 = new Int32() with get,set
[<DataMember(Order=4)>]
member val Email:String = null with get,set
[<DataMember(Order=5)>]
member val MobileNumber:String = null with get,set
[<DataMember(Order=6)>]
member val EmailAttachmentTemplate:String = null with get,set
[<DataMember(Order=7)>]
member val EmailTemplate:String = null with get,set
[<DataMember(Order=8)>]
member val EmailHtmlTemplate:String = null with get,set
[<DataMember(Order=9)>]
member val SmsTemplate:String = null with get,set
[<DataMember(Order=10)>]
[<Required>]
member val PublicAccessGuid:Guid = new Guid() with get,set
[<DataMember(Order=11)>]
[<Required>]
[<References(typeof<Campaigns>)>]
member val CampaignsId:Int64 = new Int64() with get,set
[<DataMember(Order=12)>]
member val DebtsId:Nullable<Int64> = new Nullable<Int64>() with get,set
[<DataMember(Order=13)>]
[<Required>]
member val IsPaymentCampaign:Boolean = new Boolean() with get,set
[<DataMember(Order=14)>]
[<References(typeof<SchedulesInstances>)>]
member val ScheduleInstancesId:Nullable<Int64> = new Nullable<Int64>() with get,set
[<DataMember(Order=15)>]
member val StatusCodesId:Nullable<Int64> = new Nullable<Int64>() with get,set
[<DataMember(Order=16)>]
member val EmailTemplatesId:Nullable<Int64> = new Nullable<Int64>() with get,set
[<DataMember(Order=17)>]
member val AvatarTemplateText:String = null with get,set
[<DataMember(Order=18)>]
member val HeadingTemplateText:String = null with get,set
[<DataMember(Order=19)>]
member val SubheadingTemplateText:String = null with get,set
[<DataMember(Order=20)>]
member val Sent:Boolean = new Boolean() with get,set
[<DataMember(Order=21)>]
member val Failed:Boolean = new Boolean() with get,set
[<DataMember(Order=22)>]
member val CommsUrl:String = null with get,set
[<AllowNullLiteral>]
type EmailEventsView() =
[<DataMember(Order=1)>]
member val Id:Nullable<Int64> = new Nullable<Int64>() with get,set
[<DataMember(Order=2)>]
member val Email:String = null with get,set
[<DataMember(Order=3)>]
member val TimestampDate:Nullable<DateTimeOffset> = new Nullable<DateTimeOffset>() with get,set
[<DataMember(Order=4)>]
member val Event:String = null with get,set
[<DataMember(Order=5)>]
member val Category:String = null with get,set
[<DataMember(Order=6)>]
member val SgEventId:String = null with get,set
[<DataMember(Order=7)>]
member val SgMessageId:String = null with get,set
[<DataMember(Order=8)>]
member val UserAgent:String = null with get,set
[<DataMember(Order=9)>]
member val Ipaddress:String = null with get,set
[<DataMember(Order=10)>]
member val Url:String = null with get,set
[<DataMember(Order=11)>]
member val CampaignInstanceCommsId:Nullable<Int64> = new Nullable<Int64>() with get,set
[<DataMember(Order=12)>]
member val TenantsId:Nullable<Int32> = new Nullable<Int32>() with get,set
[<DataMember(Order=13)>]
member val SegmentsId:Nullable<Int64> = new Nullable<Int64>() with get,set
[<DataMember(Order=14)>]
member val Address:String = null with get,set
[<DataMember(Order=15)>]
member val Age:Nullable<Int32> = new Nullable<Int32>() with get,set
[<DataMember(Order=16)>]
member val City:String = null with get,set
[<DataMember(Order=17)>]
member val ContactNumber:String = null with get,set
[<DataMember(Order=18)>]
member val EthnicGroup:String = null with get,set
[<DataMember(Order=19)>]
member val FirstName:String = null with get,set
[<DataMember(Order=20)>]
member val Gender:String = null with get,set
[<DataMember(Order=21)>]
member val HomeLanguage:String = null with get,set
[<DataMember(Order=22)>]
member val IdNumber:String = null with get,set
[<DataMember(Order=23)>]
member val LastName:String = null with get,set
[<DataMember(Order=24)>]
member val PostalCode:String = null with get,set
[<DataMember(Order=25)>]
member val Region:String = null with get,set
[<DataMember(Order=26)>]
member val Suburb:String = null with get,set
[<DataMember(Order=27)>]
member val BirthDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
[<DataMember(Order=28)>]
member val Classifications:Dictionary<String, String> = null with get,set
[<DataMember(Order=29)>]
member val Country:String = null with get,set
[<DataMember(Order=30)>]
member val PassportNumber:String = null with get,set
[<DataMember(Order=31)>]
member val StatusCodesId:Nullable<Int64> = new Nullable<Int64>() with get,set
[<DataMember(Order=32)>]
member val Reason:String = null with get,set
[<DataMember(Order=33)>]
member val VulnerabilityFlag:Nullable<Boolean> = new Nullable<Boolean>() with get,set
[<DataMember(Order=34)>]
member val CompaniesName:String = null with get,set
[<DataMember(Order=35)>]
member val SegmentsName:String = null with get,set
[<DataMember(Order=36)>]
member val SegmentsIsCustom:Nullable<Boolean> = new Nullable<Boolean>() with get,set
[<DataMember(Order=37)>]
member val StatusCodesDescription:String = null with get,set
[<DataMember(Order=38)>]
member val CampaignsId:Nullable<Int64> = new Nullable<Int64>() with get,set
[<AllowNullLiteral>]
type SmsWatsappEventsView() =
[<DataMember(Order=1)>]
member val Id:Nullable<Int64> = new Nullable<Int64>() with get,set
[<DataMember(Order=2)>]
member val CampaignInstancesCommsId:Nullable<Int64> = new Nullable<Int64>() with get,set
[<DataMember(Order=3)>]
member val RawJson:Dictionary<String, String> = null with get,set
[<DataMember(Order=4)>]
member val IntegrationId:String = null with get,set
[<DataMember(Order=5)>]
member val IntegrationName:String = null with get,set
[<DataMember(Order=6)>]
member val Channel:String = null with get,set
[<DataMember(Order=7)>]
member val Timestamp:Nullable<Int64> = new Nullable<Int64>() with get,set
[<DataMember(Order=8)>]
member val TimestampDate:Nullable<DateTimeOffset> = new Nullable<DateTimeOffset>() with get,set
[<DataMember(Order=9)>]
member val StatusCode:Nullable<Int32> = new Nullable<Int32>() with get,set
[<DataMember(Order=10)>]
member val Status:String = null with get,set
[<DataMember(Order=11)>]
member val MessageId:String = null with get,set
[<DataMember(Order=12)>]
member val ClientMessageId:String = null with get,set
[<DataMember(Order=13)>]
member val TenantsId:Nullable<Int32> = new Nullable<Int32>() with get,set
[<DataMember(Order=14)>]
member val SegmentsId:Nullable<Int64> = new Nullable<Int64>() with get,set
[<DataMember(Order=15)>]
member val Address:String = null with get,set
[<DataMember(Order=16)>]
member val Age:Nullable<Int32> = new Nullable<Int32>() with get,set
[<DataMember(Order=17)>]
member val City:String = null with get,set
[<DataMember(Order=18)>]
member val ContactNumber:String = null with get,set
[<DataMember(Order=19)>]
member val EthnicGroup:String = null with get,set
[<DataMember(Order=20)>]
member val FirstName:String = null with get,set
[<DataMember(Order=21)>]
member val Gender:String = null with get,set
[<DataMember(Order=22)>]
member val HomeLanguage:String = null with get,set
[<DataMember(Order=23)>]
member val IdNumber:String = null with get,set
[<DataMember(Order=24)>]
member val LastName:String = null with get,set
[<DataMember(Order=25)>]
member val PostalCode:String = null with get,set
[<DataMember(Order=26)>]
member val Region:String = null with get,set
[<DataMember(Order=27)>]
member val Suburb:String = null with get,set
[<DataMember(Order=28)>]
member val BirthDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
[<DataMember(Order=29)>]
member val Classifications:Dictionary<String, String> = null with get,set
[<DataMember(Order=30)>]
member val Country:String = null with get,set
[<DataMember(Order=31)>]
member val PassportNumber:String = null with get,set
[<DataMember(Order=32)>]
member val StatusCodesId:Nullable<Int64> = new Nullable<Int64>() with get,set
[<DataMember(Order=33)>]
member val Reason:String = null with get,set
[<DataMember(Order=34)>]
member val VulnerabilityFlag:Nullable<Boolean> = new Nullable<Boolean>() with get,set
[<DataMember(Order=35)>]
member val CompaniesName:String = null with get,set
[<DataMember(Order=36)>]
member val SegmentsName:String = null with get,set
[<DataMember(Order=37)>]
member val SegmentsIsCustom:Nullable<Boolean> = new Nullable<Boolean>() with get,set
[<DataMember(Order=38)>]
member val StatusCodesDescription:String = null with get,set
[<DataMember(Order=39)>]
member val CampaignsId:Nullable<Int64> = new Nullable<Int64>() with get,set
[<DataMember(Order=40)>]
member val CustomersId:Nullable<Int64> = new Nullable<Int64>() with get,set
[<AllowNullLiteral>]
type CampaignInstanceCommsStats() =
[<DataMember(Order=1)>]
[<Required>]
member val Id:Int64 = new Int64() with get,set
[<DataMember(Order=2)>]
[<Required>]
member val CampaignInstanceCommsId:Int64 = new Int64() with get,set
[<DataMember(Order=3)>]
member val ViewedDate:Nullable<DateTimeOffset> = new Nullable<DateTimeOffset>() with get,set
[<AllowNullLiteral>]
type CampaignInstanceCommsDetails() =
member val CampaignInstanceComms:CampaignInstanceComms = null with get,set
member val EmailEvents:ResizeArray<EmailEventsView> = null with get,set
member val SmsWatsappEvents:ResizeArray<SmsWatsappEventsView> = null with get,set
member val CampaignInstanceCommsStats:ResizeArray<CampaignInstanceCommsStats> = null with get,set
[<AllowNullLiteral>]
type GetCampaignCustomerCertificateResponse() =
member val Campaign:Campaigns = null with get,set
member val Customer:Customers = null with get,set
member val CampaignInstanceCommsDetails:ResizeArray<CampaignInstanceCommsDetails> = null with get,set
member val ResponseStatus:ResponseStatus = null with get,set
[<AllowNullLiteral>]
type GetCampaignCustomerCertificateByCustomerId() =
member val CampaignPublicAccessGuid:Guid = new Guid() with get,set
member val CustomerPublicAccessGuid:Guid = new Guid() with get,set
F# 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
}
}
}