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

**CampaignActionSummaryRequest** Parameters:
Name	Parameter	Data Type	Required	Description
PublicAccessGuid	path	Guid	Yes

**CampaignActionSummaryResponses** Parameters:
Name	Parameter	Data Type	Required
campaignActionInboxResponses	form	List<CampaignActionInboxResponsesView>	No
campaignActionPaymentResponses	form	List<CampaignActionPaymentResponsesView>	No
campaignCustomerVerificationResponses	form	List<CampaignCustomerVerificationsView>	No
ResponseStatus	form	ResponseStatus	No

**CampaignActionInboxResponsesView** Parameters:
Name	Parameter	Data Type	Required
Id	form	long?	No
PublicAccessGuid	form	Guid?	No
CampaignActionsId	form	long	No
CampaignActionDescription	form	string	No
ActionType	form	string	No
TotalCampaignActionRequests	form	long?	No
TotalInboxResponses	form	long?	No
TotalUniqueResponses	form	long?	No
ResponsePercent	form	decimal?	No
CaPublicAccessGuid	form	Guid	No

**CampaignActionPaymentResponsesView** Parameters:
Name	Parameter	Data Type	Required
Id	form	long?	No
PublicAccessGuid	form	Guid?	No
CampaignActionsId	form	long	No
CampaignActionDescription	form	string	No
ActionType	form	string	No
TotalCampaignActionRequests	form	long?	No
TotalPaymentResponses	form	long?	No
TotalPaid	form	double?	No
TotalOutstanding	form	double?	No
CaPublicAccessGuid	form	Guid	No

**CampaignCustomerVerificationsView** Parameters:
Name	Parameter	Data Type	Required
Id	form	long?	No
PublicAccessGuid	form	Guid?	No
Description	form	string	No
TotalVerifications	form	long?	No

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