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 .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
		}
	}
}