| Requires any of the roles: | Client, Admin, Partner |
| GET | /campaign/responses/summary/{PublicAccessGuid} | Campaign Action Summary Responses |
|---|
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 CampaignActionInboxResponsesView() =
[<DataMember(Order=1)>]
member val Id:Nullable<Int64> = new Nullable<Int64>() with get,set
[<DataMember(Order=2)>]
member val PublicAccessGuid:Nullable<Guid> = new Nullable<Guid>() with get,set
[<DataMember(Order=3)>]
member val CampaignActionsId:Int64 = new Int64() with get,set
[<DataMember(Order=4)>]
member val CampaignActionDescription:String = null with get,set
[<DataMember(Order=5)>]
member val ActionType:String = null with get,set
[<DataMember(Order=6)>]
member val TotalCampaignActionRequests:Nullable<Int64> = new Nullable<Int64>() with get,set
[<DataMember(Order=7)>]
member val TotalInboxResponses:Nullable<Int64> = new Nullable<Int64>() with get,set
[<DataMember(Order=8)>]
member val TotalUniqueResponses:Nullable<Int64> = new Nullable<Int64>() with get,set
[<DataMember(Order=9)>]
member val ResponsePercent:Nullable<Decimal> = new Nullable<Decimal>() with get,set
[<DataMember(Order=10)>]
member val CaPublicAccessGuid:Guid = new Guid() with get,set
[<AllowNullLiteral>]
type CampaignActionPaymentResponsesView() =
[<DataMember(Order=1)>]
member val Id:Nullable<Int64> = new Nullable<Int64>() with get,set
[<DataMember(Order=2)>]
member val PublicAccessGuid:Nullable<Guid> = new Nullable<Guid>() with get,set
[<DataMember(Order=4)>]
member val CampaignActionsId:Int64 = new Int64() with get,set
[<DataMember(Order=5)>]
member val CampaignActionDescription:String = null with get,set
[<DataMember(Order=6)>]
member val ActionType:String = null with get,set
[<DataMember(Order=7)>]
member val TotalCampaignActionRequests:Nullable<Int64> = new Nullable<Int64>() with get,set
[<DataMember(Order=8)>]
member val TotalPaymentResponses:Nullable<Int64> = new Nullable<Int64>() with get,set
[<DataMember(Order=9)>]
member val TotalPaid:Nullable<Double> = new Nullable<Double>() with get,set
[<DataMember(Order=10)>]
member val TotalOutstanding:Nullable<Double> = new Nullable<Double>() with get,set
[<DataMember(Order=11)>]
member val CaPublicAccessGuid:Guid = new Guid() with get,set
[<AllowNullLiteral>]
type CampaignCustomerVerificationsView() =
[<DataMember(Order=1)>]
member val Id:Nullable<Int64> = new Nullable<Int64>() with get,set
[<DataMember(Order=2)>]
member val PublicAccessGuid:Nullable<Guid> = new Nullable<Guid>() with get,set
[<DataMember(Order=3)>]
member val Description:String = null with get,set
[<DataMember(Order=4)>]
member val TotalVerifications:Nullable<Int64> = new Nullable<Int64>() with get,set
[<AllowNullLiteral>]
type CampaignActionSummaryResponses() =
member val campaignActionInboxResponses:ResizeArray<CampaignActionInboxResponsesView> = null with get,set
member val campaignActionPaymentResponses:ResizeArray<CampaignActionPaymentResponsesView> = null with get,set
member val campaignCustomerVerificationResponses:ResizeArray<CampaignCustomerVerificationsView> = null with get,set
member val ResponseStatus:ResponseStatus = null with get,set
[<AllowNullLiteral>]
type CampaignActionSummaryRequest() =
[<DataMember(Order=1)>]
[<Validate(Validator="NotNull")>]
member val PublicAccessGuid:Guid = new Guid() with get,set
F# CampaignActionSummaryRequest 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/responses/summary/{PublicAccessGuid} HTTP/1.1
Host: duengageapi.uat.scadsoftware.com
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
campaignActionInboxResponses:
[
{
Id: 0,
PublicAccessGuid: 00000000000000000000000000000000,
CampaignActionsId: 0,
CampaignActionDescription: String,
ActionType: String,
TotalCampaignActionRequests: 0,
TotalInboxResponses: 0,
TotalUniqueResponses: 0,
ResponsePercent: 0,
CaPublicAccessGuid: 00000000000000000000000000000000
}
],
campaignActionPaymentResponses:
[
{
Id: 0,
PublicAccessGuid: 00000000000000000000000000000000,
CampaignActionsId: 0,
CampaignActionDescription: String,
ActionType: String,
TotalCampaignActionRequests: 0,
TotalPaymentResponses: 0,
TotalPaid: 0,
TotalOutstanding: 0,
CaPublicAccessGuid: 00000000000000000000000000000000
}
],
campaignCustomerVerificationResponses:
[
{
Id: 0,
PublicAccessGuid: 00000000000000000000000000000000,
Description: String,
TotalVerifications: 0
}
],
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}