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

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class CampaignActionSummaryRequest
{
    @DataMember(Order=1)
    @Validate(Validator="NotNull")
    open var PublicAccessGuid:UUID? = null
}

open class CampaignActionSummaryResponses
{
    open var campaignActionInboxResponses:ArrayList<CampaignActionInboxResponsesView>? = null
    open var campaignActionPaymentResponses:ArrayList<CampaignActionPaymentResponsesView>? = null
    open var campaignCustomerVerificationResponses:ArrayList<CampaignCustomerVerificationsView>? = null
    open var ResponseStatus:ResponseStatus? = null
}

open class CampaignActionInboxResponsesView
{
    @DataMember(Order=1)
    open var Id:Long? = null

    @DataMember(Order=2)
    open var PublicAccessGuid:UUID? = null

    @DataMember(Order=3)
    open var CampaignActionsId:Long? = null

    @DataMember(Order=4)
    open var CampaignActionDescription:String? = null

    @DataMember(Order=5)
    open var ActionType:String? = null

    @DataMember(Order=6)
    open var TotalCampaignActionRequests:Long? = null

    @DataMember(Order=7)
    open var TotalInboxResponses:Long? = null

    @DataMember(Order=8)
    open var TotalUniqueResponses:Long? = null

    @DataMember(Order=9)
    open var ResponsePercent:BigDecimal? = null

    @DataMember(Order=10)
    open var CaPublicAccessGuid:UUID? = null
}

open class CampaignActionPaymentResponsesView
{
    @DataMember(Order=1)
    open var Id:Long? = null

    @DataMember(Order=2)
    open var PublicAccessGuid:UUID? = null

    @DataMember(Order=4)
    open var CampaignActionsId:Long? = null

    @DataMember(Order=5)
    open var CampaignActionDescription:String? = null

    @DataMember(Order=6)
    open var ActionType:String? = null

    @DataMember(Order=7)
    open var TotalCampaignActionRequests:Long? = null

    @DataMember(Order=8)
    open var TotalPaymentResponses:Long? = null

    @DataMember(Order=9)
    open var TotalPaid:Double? = null

    @DataMember(Order=10)
    open var TotalOutstanding:Double? = null

    @DataMember(Order=11)
    open var CaPublicAccessGuid:UUID? = null
}

open class CampaignCustomerVerificationsView
{
    @DataMember(Order=1)
    open var Id:Long? = null

    @DataMember(Order=2)
    open var PublicAccessGuid:UUID? = null

    @DataMember(Order=3)
    open var Description:String? = null

    @DataMember(Order=4)
    open var TotalVerifications:Long? = null
}

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