digitaluapi

<back to all web services

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:
NameParameterData TypeRequiredDescription
PublicAccessGuidpathGuidYes
CampaignActionSummaryResponses Parameters:
NameParameterData TypeRequiredDescription
campaignActionInboxResponsesformList<CampaignActionInboxResponsesView>No
campaignActionPaymentResponsesformList<CampaignActionPaymentResponsesView>No
campaignCustomerVerificationResponsesformList<CampaignCustomerVerificationsView>No
ResponseStatusformResponseStatusNo
CampaignActionInboxResponsesView Parameters:
NameParameterData TypeRequiredDescription
Idformlong?No
PublicAccessGuidformGuid?No
CampaignActionsIdformlongNo
CampaignActionDescriptionformstringNo
ActionTypeformstringNo
TotalCampaignActionRequestsformlong?No
TotalInboxResponsesformlong?No
TotalUniqueResponsesformlong?No
ResponsePercentformdecimal?No
CaPublicAccessGuidformGuidNo
CampaignActionPaymentResponsesView Parameters:
NameParameterData TypeRequiredDescription
Idformlong?No
PublicAccessGuidformGuid?No
CampaignActionsIdformlongNo
CampaignActionDescriptionformstringNo
ActionTypeformstringNo
TotalCampaignActionRequestsformlong?No
TotalPaymentResponsesformlong?No
TotalPaidformdouble?No
TotalOutstandingformdouble?No
CaPublicAccessGuidformGuidNo
CampaignCustomerVerificationsView Parameters:
NameParameterData TypeRequiredDescription
Idformlong?No
PublicAccessGuidformGuid?No
DescriptionformstringNo
TotalVerificationsformlong?No

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}