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
"use strict";
export class CampaignActionInboxResponsesView {
    /** @param {{Id?:number,PublicAccessGuid?:string,CampaignActionsId?:number,CampaignActionDescription?:string,ActionType?:string,TotalCampaignActionRequests?:number,TotalInboxResponses?:number,TotalUniqueResponses?:number,ResponsePercent?:number,CaPublicAccessGuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?number} */
    Id;
    /** @type {?string} */
    PublicAccessGuid;
    /** @type {number} */
    CampaignActionsId;
    /** @type {string} */
    CampaignActionDescription;
    /** @type {string} */
    ActionType;
    /** @type {?number} */
    TotalCampaignActionRequests;
    /** @type {?number} */
    TotalInboxResponses;
    /** @type {?number} */
    TotalUniqueResponses;
    /** @type {?number} */
    ResponsePercent;
    /** @type {string} */
    CaPublicAccessGuid;
}
export class CampaignActionPaymentResponsesView {
    /** @param {{Id?:number,PublicAccessGuid?:string,CampaignActionsId?:number,CampaignActionDescription?:string,ActionType?:string,TotalCampaignActionRequests?:number,TotalPaymentResponses?:number,TotalPaid?:number,TotalOutstanding?:number,CaPublicAccessGuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?number} */
    Id;
    /** @type {?string} */
    PublicAccessGuid;
    /** @type {number} */
    CampaignActionsId;
    /** @type {string} */
    CampaignActionDescription;
    /** @type {string} */
    ActionType;
    /** @type {?number} */
    TotalCampaignActionRequests;
    /** @type {?number} */
    TotalPaymentResponses;
    /** @type {?number} */
    TotalPaid;
    /** @type {?number} */
    TotalOutstanding;
    /** @type {string} */
    CaPublicAccessGuid;
}
export class CampaignCustomerVerificationsView {
    /** @param {{Id?:number,PublicAccessGuid?:string,Description?:string,TotalVerifications?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?number} */
    Id;
    /** @type {?string} */
    PublicAccessGuid;
    /** @type {string} */
    Description;
    /** @type {?number} */
    TotalVerifications;
}
export class CampaignActionSummaryResponses {
    /** @param {{campaignActionInboxResponses?:CampaignActionInboxResponsesView[],campaignActionPaymentResponses?:CampaignActionPaymentResponsesView[],campaignCustomerVerificationResponses?:CampaignCustomerVerificationsView[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {CampaignActionInboxResponsesView[]} */
    campaignActionInboxResponses;
    /** @type {CampaignActionPaymentResponsesView[]} */
    campaignActionPaymentResponses;
    /** @type {CampaignCustomerVerificationsView[]} */
    campaignCustomerVerificationResponses;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class CampaignActionSummaryRequest {
    /** @param {{PublicAccessGuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    PublicAccessGuid;
}

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