digitaluapi

<back to all web services

CampaignActionPaymentDetailsRequest

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
GET/campaign/responses/payment/{PublicAccessGuid}/Campaign Action Payment Detail Responses
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class CampaignActionPaymentDetailsRequest
    {
        @Validate(Validator="NotNull")
        public UUID PublicAccessGuid = null;

        @Validate(Validator="NotNull")
        public Long CampaignActionsId = null;

        public Integer PageNumber = null;
        public Integer PageSize = null;
        public String UniqueIdentifier = null;
        public String FirstName = null;
        public String LastName = null;
        public String ContactNumber = null;
        public String Email = null;
        public Long StatusCodesId = null;
        public String InvoiceNumber = null;
        
        public UUID getPublicAccessGuid() { return PublicAccessGuid; }
        public CampaignActionPaymentDetailsRequest setPublicAccessGuid(UUID value) { this.PublicAccessGuid = value; return this; }
        public Long getCampaignActionsId() { return CampaignActionsId; }
        public CampaignActionPaymentDetailsRequest setCampaignActionsId(Long value) { this.CampaignActionsId = value; return this; }
        public Integer getPageNumber() { return PageNumber; }
        public CampaignActionPaymentDetailsRequest setPageNumber(Integer value) { this.PageNumber = value; return this; }
        public Integer getPageSize() { return PageSize; }
        public CampaignActionPaymentDetailsRequest setPageSize(Integer value) { this.PageSize = value; return this; }
        public String getUniqueIdentifier() { return UniqueIdentifier; }
        public CampaignActionPaymentDetailsRequest setUniqueIdentifier(String value) { this.UniqueIdentifier = value; return this; }
        public String getFirstName() { return FirstName; }
        public CampaignActionPaymentDetailsRequest setFirstName(String value) { this.FirstName = value; return this; }
        public String getLastName() { return LastName; }
        public CampaignActionPaymentDetailsRequest setLastName(String value) { this.LastName = value; return this; }
        public String getContactNumber() { return ContactNumber; }
        public CampaignActionPaymentDetailsRequest setContactNumber(String value) { this.ContactNumber = value; return this; }
        public String getEmail() { return Email; }
        public CampaignActionPaymentDetailsRequest setEmail(String value) { this.Email = value; return this; }
        public Long getStatusCodesId() { return StatusCodesId; }
        public CampaignActionPaymentDetailsRequest setStatusCodesId(Long value) { this.StatusCodesId = value; return this; }
        public String getInvoiceNumber() { return InvoiceNumber; }
        public CampaignActionPaymentDetailsRequest setInvoiceNumber(String value) { this.InvoiceNumber = value; return this; }
    }

    public static class CampaignActionPaymentDetailsResponse
    {
        public ArrayList<CampaignActionPaymentResponsesDetailView> campaignActionInboxResponsesDetailViews = null;
        public ResponseStatus ResponseStatus = null;
        
        public ArrayList<CampaignActionPaymentResponsesDetailView> getCampaignActionInboxResponsesDetailViews() { return campaignActionInboxResponsesDetailViews; }
        public CampaignActionPaymentDetailsResponse setCampaignActionInboxResponsesDetailViews(ArrayList<CampaignActionPaymentResponsesDetailView> value) { this.campaignActionInboxResponsesDetailViews = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public CampaignActionPaymentDetailsResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

    public static class CampaignActionPaymentResponsesDetailView
    {
        @DataMember(Order=1)
        public Long Id = null;

        @DataMember(Order=2)
        public String UniqueIdentifier = null;

        @DataMember(Order=3)
        public String FirstName = null;

        @DataMember(Order=4)
        public String LastName = null;

        @DataMember(Order=5)
        public String ContactNumber = null;

        @DataMember(Order=6)
        public String Email = null;

        @DataMember(Order=7)
        public String InvoiceNumber = null;

        @DataMember(Order=8)
        public Double AmountOutstanding = null;

        @DataMember(Order=9)
        public Double AmountPaid = null;

        @DataMember(Order=10)
        public Date RequestDate = null;

        @DataMember(Order=11)
        public String StatusCodesDescription = null;

        @DataMember(Order=12)
        public Long StatusCodesId = null;

        @DataMember(Order=13)
        public Long CampaignActionsId = null;
        
        public Long getId() { return Id; }
        public CampaignActionPaymentResponsesDetailView setId(Long value) { this.Id = value; return this; }
        public String getUniqueIdentifier() { return UniqueIdentifier; }
        public CampaignActionPaymentResponsesDetailView setUniqueIdentifier(String value) { this.UniqueIdentifier = value; return this; }
        public String getFirstName() { return FirstName; }
        public CampaignActionPaymentResponsesDetailView setFirstName(String value) { this.FirstName = value; return this; }
        public String getLastName() { return LastName; }
        public CampaignActionPaymentResponsesDetailView setLastName(String value) { this.LastName = value; return this; }
        public String getContactNumber() { return ContactNumber; }
        public CampaignActionPaymentResponsesDetailView setContactNumber(String value) { this.ContactNumber = value; return this; }
        public String getEmail() { return Email; }
        public CampaignActionPaymentResponsesDetailView setEmail(String value) { this.Email = value; return this; }
        public String getInvoiceNumber() { return InvoiceNumber; }
        public CampaignActionPaymentResponsesDetailView setInvoiceNumber(String value) { this.InvoiceNumber = value; return this; }
        public Double getAmountOutstanding() { return AmountOutstanding; }
        public CampaignActionPaymentResponsesDetailView setAmountOutstanding(Double value) { this.AmountOutstanding = value; return this; }
        public Double getAmountPaid() { return AmountPaid; }
        public CampaignActionPaymentResponsesDetailView setAmountPaid(Double value) { this.AmountPaid = value; return this; }
        public Date getRequestDate() { return RequestDate; }
        public CampaignActionPaymentResponsesDetailView setRequestDate(Date value) { this.RequestDate = value; return this; }
        public String getStatusCodesDescription() { return StatusCodesDescription; }
        public CampaignActionPaymentResponsesDetailView setStatusCodesDescription(String value) { this.StatusCodesDescription = value; return this; }
        public Long getStatusCodesId() { return StatusCodesId; }
        public CampaignActionPaymentResponsesDetailView setStatusCodesId(Long value) { this.StatusCodesId = value; return this; }
        public Long getCampaignActionsId() { return CampaignActionsId; }
        public CampaignActionPaymentResponsesDetailView setCampaignActionsId(Long value) { this.CampaignActionsId = value; return this; }
    }

}

Java CampaignActionPaymentDetailsRequest DTOs

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

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /campaign/responses/payment/{PublicAccessGuid}/ HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CampaignActionPaymentDetailsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <campaignActionInboxResponsesDetailViews xmlns:d2p1="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel.Types">
    <d2p1:CampaignActionPaymentResponsesDetailView>
      <d2p1:AmountOutstanding>0</d2p1:AmountOutstanding>
      <d2p1:AmountPaid>0</d2p1:AmountPaid>
      <d2p1:CampaignActionsId>0</d2p1:CampaignActionsId>
      <d2p1:ContactNumber>String</d2p1:ContactNumber>
      <d2p1:Email>String</d2p1:Email>
      <d2p1:FirstName>String</d2p1:FirstName>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:InvoiceNumber>String</d2p1:InvoiceNumber>
      <d2p1:LastName>String</d2p1:LastName>
      <d2p1:RequestDate xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>0001-01-01T00:00:00Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </d2p1:RequestDate>
      <d2p1:StatusCodesDescription>String</d2p1:StatusCodesDescription>
      <d2p1:StatusCodesId>0</d2p1:StatusCodesId>
      <d2p1:UniqueIdentifier>String</d2p1:UniqueIdentifier>
    </d2p1:CampaignActionPaymentResponsesDetailView>
  </campaignActionInboxResponsesDetailViews>
</CampaignActionPaymentDetailsResponse>