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


export class CampaignActionInboxResponsesView
{
    // @DataMember(Order=1)
    public Id?: number;

    // @DataMember(Order=2)
    public PublicAccessGuid?: string;

    // @DataMember(Order=3)
    public CampaignActionsId: number;

    // @DataMember(Order=4)
    public CampaignActionDescription: string;

    // @DataMember(Order=5)
    public ActionType: string;

    // @DataMember(Order=6)
    public TotalCampaignActionRequests?: number;

    // @DataMember(Order=7)
    public TotalInboxResponses?: number;

    // @DataMember(Order=8)
    public TotalUniqueResponses?: number;

    // @DataMember(Order=9)
    public ResponsePercent?: number;

    // @DataMember(Order=10)
    public CaPublicAccessGuid: string;

    public constructor(init?: Partial<CampaignActionInboxResponsesView>) { (Object as any).assign(this, init); }
}

export class CampaignActionPaymentResponsesView
{
    // @DataMember(Order=1)
    public Id?: number;

    // @DataMember(Order=2)
    public PublicAccessGuid?: string;

    // @DataMember(Order=4)
    public CampaignActionsId: number;

    // @DataMember(Order=5)
    public CampaignActionDescription: string;

    // @DataMember(Order=6)
    public ActionType: string;

    // @DataMember(Order=7)
    public TotalCampaignActionRequests?: number;

    // @DataMember(Order=8)
    public TotalPaymentResponses?: number;

    // @DataMember(Order=9)
    public TotalPaid?: number;

    // @DataMember(Order=10)
    public TotalOutstanding?: number;

    // @DataMember(Order=11)
    public CaPublicAccessGuid: string;

    public constructor(init?: Partial<CampaignActionPaymentResponsesView>) { (Object as any).assign(this, init); }
}

export class CampaignCustomerVerificationsView
{
    // @DataMember(Order=1)
    public Id?: number;

    // @DataMember(Order=2)
    public PublicAccessGuid?: string;

    // @DataMember(Order=3)
    public Description: string;

    // @DataMember(Order=4)
    public TotalVerifications?: number;

    public constructor(init?: Partial<CampaignCustomerVerificationsView>) { (Object as any).assign(this, init); }
}

export class CampaignActionSummaryResponses
{
    public campaignActionInboxResponses: CampaignActionInboxResponsesView[];
    public campaignActionPaymentResponses: CampaignActionPaymentResponsesView[];
    public campaignCustomerVerificationResponses: CampaignCustomerVerificationsView[];
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<CampaignActionSummaryResponses>) { (Object as any).assign(this, init); }
}

export class CampaignActionSummaryRequest
{
    // @DataMember(Order=1)
    // @Validate(Validator="NotNull")
    public PublicAccessGuid: string;

    public constructor(init?: Partial<CampaignActionSummaryRequest>) { (Object as any).assign(this, init); }
}

TypeScript CampaignActionSummaryRequest 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/summary/{PublicAccessGuid} HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CampaignActionSummaryResponses 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>
  <campaignActionInboxResponses xmlns:d2p1="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel.Types">
    <d2p1:CampaignActionInboxResponsesView>
      <d2p1:ActionType>String</d2p1:ActionType>
      <d2p1:CaPublicAccessGuid>00000000-0000-0000-0000-000000000000</d2p1:CaPublicAccessGuid>
      <d2p1:CampaignActionDescription>String</d2p1:CampaignActionDescription>
      <d2p1:CampaignActionsId>0</d2p1:CampaignActionsId>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:PublicAccessGuid>00000000-0000-0000-0000-000000000000</d2p1:PublicAccessGuid>
      <d2p1:ResponsePercent>0</d2p1:ResponsePercent>
      <d2p1:TotalCampaignActionRequests>0</d2p1:TotalCampaignActionRequests>
      <d2p1:TotalInboxResponses>0</d2p1:TotalInboxResponses>
      <d2p1:TotalUniqueResponses>0</d2p1:TotalUniqueResponses>
    </d2p1:CampaignActionInboxResponsesView>
  </campaignActionInboxResponses>
  <campaignActionPaymentResponses xmlns:d2p1="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel.Types">
    <d2p1:CampaignActionPaymentResponsesView>
      <d2p1:ActionType>String</d2p1:ActionType>
      <d2p1:CaPublicAccessGuid>00000000-0000-0000-0000-000000000000</d2p1:CaPublicAccessGuid>
      <d2p1:CampaignActionDescription>String</d2p1:CampaignActionDescription>
      <d2p1:CampaignActionsId>0</d2p1:CampaignActionsId>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:PublicAccessGuid>00000000-0000-0000-0000-000000000000</d2p1:PublicAccessGuid>
      <d2p1:TotalCampaignActionRequests>0</d2p1:TotalCampaignActionRequests>
      <d2p1:TotalOutstanding>0</d2p1:TotalOutstanding>
      <d2p1:TotalPaid>0</d2p1:TotalPaid>
      <d2p1:TotalPaymentResponses>0</d2p1:TotalPaymentResponses>
    </d2p1:CampaignActionPaymentResponsesView>
  </campaignActionPaymentResponses>
  <campaignCustomerVerificationResponses xmlns:d2p1="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel.Types">
    <d2p1:CampaignCustomerVerificationsView>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:PublicAccessGuid>00000000-0000-0000-0000-000000000000</d2p1:PublicAccessGuid>
      <d2p1:TotalVerifications>0</d2p1:TotalVerifications>
    </d2p1:CampaignCustomerVerificationsView>
  </campaignCustomerVerificationResponses>
</CampaignActionSummaryResponses>