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 Foundation
import ServiceStack

public class CampaignActionSummaryRequest : Codable
{
    // @DataMember(Order=1)
    // @Validate(Validator="NotNull")
    public var publicAccessGuid:String

    required public init(){}
}

public class CampaignActionSummaryResponses : Codable
{
    public var campaignActionInboxResponses:[CampaignActionInboxResponsesView]
    public var campaignActionPaymentResponses:[CampaignActionPaymentResponsesView]
    public var campaignCustomerVerificationResponses:[CampaignCustomerVerificationsView]
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class CampaignActionInboxResponsesView : Codable
{
    // @DataMember(Order=1)
    public var id:Int?

    // @DataMember(Order=2)
    public var publicAccessGuid:String?

    // @DataMember(Order=3)
    public var campaignActionsId:Int

    // @DataMember(Order=4)
    public var campaignActionDescription:String

    // @DataMember(Order=5)
    public var actionType:String

    // @DataMember(Order=6)
    public var totalCampaignActionRequests:Int?

    // @DataMember(Order=7)
    public var totalInboxResponses:Int?

    // @DataMember(Order=8)
    public var totalUniqueResponses:Int?

    // @DataMember(Order=9)
    public var responsePercent:Double?

    // @DataMember(Order=10)
    public var caPublicAccessGuid:String

    required public init(){}
}

public class CampaignActionPaymentResponsesView : Codable
{
    // @DataMember(Order=1)
    public var id:Int?

    // @DataMember(Order=2)
    public var publicAccessGuid:String?

    // @DataMember(Order=4)
    public var campaignActionsId:Int

    // @DataMember(Order=5)
    public var campaignActionDescription:String

    // @DataMember(Order=6)
    public var actionType:String

    // @DataMember(Order=7)
    public var totalCampaignActionRequests:Int?

    // @DataMember(Order=8)
    public var totalPaymentResponses:Int?

    // @DataMember(Order=9)
    public var totalPaid:Double?

    // @DataMember(Order=10)
    public var totalOutstanding:Double?

    // @DataMember(Order=11)
    public var caPublicAccessGuid:String

    required public init(){}
}

public class CampaignCustomerVerificationsView : Codable
{
    // @DataMember(Order=1)
    public var id:Int?

    // @DataMember(Order=2)
    public var publicAccessGuid:String?

    // @DataMember(Order=3)
    public var Description:String

    // @DataMember(Order=4)
    public var totalVerifications:Int?

    required public init(){}
}

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