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

"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 .jsv suffix or ?format=jsv

HTTP + 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
		}
	}
}