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
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using digitaluapi.ServiceModel;
using digitaluapi.ServiceModel.Types;

namespace digitaluapi.ServiceModel
{
    public partial class CampaignActionSummaryRequest
    {
        [DataMember(Order=1)]
        [Validate("NotNull")]
        public virtual Guid PublicAccessGuid { get; set; }
    }

    public partial class CampaignActionSummaryResponses
    {
        public virtual List<CampaignActionInboxResponsesView> campaignActionInboxResponses { get; set; }
        public virtual List<CampaignActionPaymentResponsesView> campaignActionPaymentResponses { get; set; }
        public virtual List<CampaignCustomerVerificationsView> campaignCustomerVerificationResponses { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

namespace digitaluapi.ServiceModel.Types
{
    public partial class CampaignActionInboxResponsesView
    {
        [DataMember(Order=1)]
        public virtual long? Id { get; set; }

        [DataMember(Order=2)]
        public virtual Guid? PublicAccessGuid { get; set; }

        [DataMember(Order=3)]
        public virtual long CampaignActionsId { get; set; }

        [DataMember(Order=4)]
        public virtual string CampaignActionDescription { get; set; }

        [DataMember(Order=5)]
        public virtual string ActionType { get; set; }

        [DataMember(Order=6)]
        public virtual long? TotalCampaignActionRequests { get; set; }

        [DataMember(Order=7)]
        public virtual long? TotalInboxResponses { get; set; }

        [DataMember(Order=8)]
        public virtual long? TotalUniqueResponses { get; set; }

        [DataMember(Order=9)]
        public virtual decimal? ResponsePercent { get; set; }

        [DataMember(Order=10)]
        public virtual Guid CaPublicAccessGuid { get; set; }
    }

    public partial class CampaignActionPaymentResponsesView
    {
        [DataMember(Order=1)]
        public virtual long? Id { get; set; }

        [DataMember(Order=2)]
        public virtual Guid? PublicAccessGuid { get; set; }

        [DataMember(Order=4)]
        public virtual long CampaignActionsId { get; set; }

        [DataMember(Order=5)]
        public virtual string CampaignActionDescription { get; set; }

        [DataMember(Order=6)]
        public virtual string ActionType { get; set; }

        [DataMember(Order=7)]
        public virtual long? TotalCampaignActionRequests { get; set; }

        [DataMember(Order=8)]
        public virtual long? TotalPaymentResponses { get; set; }

        [DataMember(Order=9)]
        public virtual double? TotalPaid { get; set; }

        [DataMember(Order=10)]
        public virtual double? TotalOutstanding { get; set; }

        [DataMember(Order=11)]
        public virtual Guid CaPublicAccessGuid { get; set; }
    }

    public partial class CampaignCustomerVerificationsView
    {
        [DataMember(Order=1)]
        public virtual long? Id { get; set; }

        [DataMember(Order=2)]
        public virtual Guid? PublicAccessGuid { get; set; }

        [DataMember(Order=3)]
        public virtual string Description { get; set; }

        [DataMember(Order=4)]
        public virtual long? TotalVerifications { get; set; }
    }

}

C# CampaignActionSummaryRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
HTTP/1.1 200 OK
Content-Type: application/json
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"}}}