digitaluapi

CampaignActionSummaryRequest

**Requires Authentication**
Requires any of the roles:	Client, Admin, Partner

The following routes are available for this service:
GET	/campaign/responses/summary/{PublicAccessGuid}	Campaign Action Summary Responses

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 CampaignActionSummaryRequest
            <DataMember(Order:=1)>
            <Validate(Validator:="NotNull")>
            Public Overridable Property PublicAccessGuid As Guid
        End Class

        Public Partial Class CampaignActionSummaryResponses
            Public Overridable Property campaignActionInboxResponses As List(Of CampaignActionInboxResponsesView)
            Public Overridable Property campaignActionPaymentResponses As List(Of CampaignActionPaymentResponsesView)
            Public Overridable Property campaignCustomerVerificationResponses As List(Of CampaignCustomerVerificationsView)
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace

    Namespace digitaluapi.ServiceModel.Types

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

            <DataMember(Order:=2)>
            Public Overridable Property PublicAccessGuid As Guid?

            <DataMember(Order:=3)>
            Public Overridable Property CampaignActionsId As Long

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

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

            <DataMember(Order:=6)>
            Public Overridable Property TotalCampaignActionRequests As Long?

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

            <DataMember(Order:=8)>
            Public Overridable Property TotalUniqueResponses As Long?

            <DataMember(Order:=9)>
            Public Overridable Property ResponsePercent As Decimal?

            <DataMember(Order:=10)>
            Public Overridable Property CaPublicAccessGuid As Guid
        End Class

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

            <DataMember(Order:=2)>
            Public Overridable Property PublicAccessGuid As Guid?

            <DataMember(Order:=4)>
            Public Overridable Property CampaignActionsId As Long

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

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

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

            <DataMember(Order:=8)>
            Public Overridable Property TotalPaymentResponses As Long?

            <DataMember(Order:=9)>
            Public Overridable Property TotalPaid As Double?

            <DataMember(Order:=10)>
            Public Overridable Property TotalOutstanding As Double?

            <DataMember(Order:=11)>
            Public Overridable Property CaPublicAccessGuid As Guid
        End Class

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

            <DataMember(Order:=2)>
            Public Overridable Property PublicAccessGuid As Guid?

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

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

VB.NET CampaignActionSummaryRequest 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/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
		}
	}
}