| Requires any of the roles: | Client, Admin, Partner |
| GET | /campaign/responses/summary/{PublicAccessGuid} | Campaign Action Summary Responses |
|---|
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;
public class dtos
{
public static class CampaignActionSummaryRequest
{
@DataMember(Order=1)
@Validate(Validator="NotNull")
public UUID PublicAccessGuid = null;
public UUID getPublicAccessGuid() { return PublicAccessGuid; }
public CampaignActionSummaryRequest setPublicAccessGuid(UUID value) { this.PublicAccessGuid = value; return this; }
}
public static class CampaignActionSummaryResponses
{
public ArrayList<CampaignActionInboxResponsesView> campaignActionInboxResponses = null;
public ArrayList<CampaignActionPaymentResponsesView> campaignActionPaymentResponses = null;
public ArrayList<CampaignCustomerVerificationsView> campaignCustomerVerificationResponses = null;
public ResponseStatus ResponseStatus = null;
public ArrayList<CampaignActionInboxResponsesView> getCampaignActionInboxResponses() { return campaignActionInboxResponses; }
public CampaignActionSummaryResponses setCampaignActionInboxResponses(ArrayList<CampaignActionInboxResponsesView> value) { this.campaignActionInboxResponses = value; return this; }
public ArrayList<CampaignActionPaymentResponsesView> getCampaignActionPaymentResponses() { return campaignActionPaymentResponses; }
public CampaignActionSummaryResponses setCampaignActionPaymentResponses(ArrayList<CampaignActionPaymentResponsesView> value) { this.campaignActionPaymentResponses = value; return this; }
public ArrayList<CampaignCustomerVerificationsView> getCampaignCustomerVerificationResponses() { return campaignCustomerVerificationResponses; }
public CampaignActionSummaryResponses setCampaignCustomerVerificationResponses(ArrayList<CampaignCustomerVerificationsView> value) { this.campaignCustomerVerificationResponses = value; return this; }
public ResponseStatus getResponseStatus() { return ResponseStatus; }
public CampaignActionSummaryResponses setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
}
public static class CampaignActionInboxResponsesView
{
@DataMember(Order=1)
public Long Id = null;
@DataMember(Order=2)
public UUID PublicAccessGuid = null;
@DataMember(Order=3)
public Long CampaignActionsId = null;
@DataMember(Order=4)
public String CampaignActionDescription = null;
@DataMember(Order=5)
public String ActionType = null;
@DataMember(Order=6)
public Long TotalCampaignActionRequests = null;
@DataMember(Order=7)
public Long TotalInboxResponses = null;
@DataMember(Order=8)
public Long TotalUniqueResponses = null;
@DataMember(Order=9)
public BigDecimal ResponsePercent = null;
@DataMember(Order=10)
public UUID CaPublicAccessGuid = null;
public Long getId() { return Id; }
public CampaignActionInboxResponsesView setId(Long value) { this.Id = value; return this; }
public UUID getPublicAccessGuid() { return PublicAccessGuid; }
public CampaignActionInboxResponsesView setPublicAccessGuid(UUID value) { this.PublicAccessGuid = value; return this; }
public Long getCampaignActionsId() { return CampaignActionsId; }
public CampaignActionInboxResponsesView setCampaignActionsId(Long value) { this.CampaignActionsId = value; return this; }
public String getCampaignActionDescription() { return CampaignActionDescription; }
public CampaignActionInboxResponsesView setCampaignActionDescription(String value) { this.CampaignActionDescription = value; return this; }
public String getActionType() { return ActionType; }
public CampaignActionInboxResponsesView setActionType(String value) { this.ActionType = value; return this; }
public Long getTotalCampaignActionRequests() { return TotalCampaignActionRequests; }
public CampaignActionInboxResponsesView setTotalCampaignActionRequests(Long value) { this.TotalCampaignActionRequests = value; return this; }
public Long getTotalInboxResponses() { return TotalInboxResponses; }
public CampaignActionInboxResponsesView setTotalInboxResponses(Long value) { this.TotalInboxResponses = value; return this; }
public Long getTotalUniqueResponses() { return TotalUniqueResponses; }
public CampaignActionInboxResponsesView setTotalUniqueResponses(Long value) { this.TotalUniqueResponses = value; return this; }
public BigDecimal getResponsePercent() { return ResponsePercent; }
public CampaignActionInboxResponsesView setResponsePercent(BigDecimal value) { this.ResponsePercent = value; return this; }
public UUID getCaPublicAccessGuid() { return CaPublicAccessGuid; }
public CampaignActionInboxResponsesView setCaPublicAccessGuid(UUID value) { this.CaPublicAccessGuid = value; return this; }
}
public static class CampaignActionPaymentResponsesView
{
@DataMember(Order=1)
public Long Id = null;
@DataMember(Order=2)
public UUID PublicAccessGuid = null;
@DataMember(Order=4)
public Long CampaignActionsId = null;
@DataMember(Order=5)
public String CampaignActionDescription = null;
@DataMember(Order=6)
public String ActionType = null;
@DataMember(Order=7)
public Long TotalCampaignActionRequests = null;
@DataMember(Order=8)
public Long TotalPaymentResponses = null;
@DataMember(Order=9)
public Double TotalPaid = null;
@DataMember(Order=10)
public Double TotalOutstanding = null;
@DataMember(Order=11)
public UUID CaPublicAccessGuid = null;
public Long getId() { return Id; }
public CampaignActionPaymentResponsesView setId(Long value) { this.Id = value; return this; }
public UUID getPublicAccessGuid() { return PublicAccessGuid; }
public CampaignActionPaymentResponsesView setPublicAccessGuid(UUID value) { this.PublicAccessGuid = value; return this; }
public Long getCampaignActionsId() { return CampaignActionsId; }
public CampaignActionPaymentResponsesView setCampaignActionsId(Long value) { this.CampaignActionsId = value; return this; }
public String getCampaignActionDescription() { return CampaignActionDescription; }
public CampaignActionPaymentResponsesView setCampaignActionDescription(String value) { this.CampaignActionDescription = value; return this; }
public String getActionType() { return ActionType; }
public CampaignActionPaymentResponsesView setActionType(String value) { this.ActionType = value; return this; }
public Long getTotalCampaignActionRequests() { return TotalCampaignActionRequests; }
public CampaignActionPaymentResponsesView setTotalCampaignActionRequests(Long value) { this.TotalCampaignActionRequests = value; return this; }
public Long getTotalPaymentResponses() { return TotalPaymentResponses; }
public CampaignActionPaymentResponsesView setTotalPaymentResponses(Long value) { this.TotalPaymentResponses = value; return this; }
public Double getTotalPaid() { return TotalPaid; }
public CampaignActionPaymentResponsesView setTotalPaid(Double value) { this.TotalPaid = value; return this; }
public Double getTotalOutstanding() { return TotalOutstanding; }
public CampaignActionPaymentResponsesView setTotalOutstanding(Double value) { this.TotalOutstanding = value; return this; }
public UUID getCaPublicAccessGuid() { return CaPublicAccessGuid; }
public CampaignActionPaymentResponsesView setCaPublicAccessGuid(UUID value) { this.CaPublicAccessGuid = value; return this; }
}
public static class CampaignCustomerVerificationsView
{
@DataMember(Order=1)
public Long Id = null;
@DataMember(Order=2)
public UUID PublicAccessGuid = null;
@DataMember(Order=3)
public String Description = null;
@DataMember(Order=4)
public Long TotalVerifications = null;
public Long getId() { return Id; }
public CampaignCustomerVerificationsView setId(Long value) { this.Id = value; return this; }
public UUID getPublicAccessGuid() { return PublicAccessGuid; }
public CampaignCustomerVerificationsView setPublicAccessGuid(UUID value) { this.PublicAccessGuid = value; return this; }
public String getDescription() { return Description; }
public CampaignCustomerVerificationsView setDescription(String value) { this.Description = value; return this; }
public Long getTotalVerifications() { return TotalVerifications; }
public CampaignCustomerVerificationsView setTotalVerifications(Long value) { this.TotalVerifications = value; return this; }
}
}
Java CampaignActionSummaryRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
}
}
}