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

<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


class CampaignActionInboxResponsesView implements JsonSerializable
{
    public function __construct(
        // @DataMember(Order=1)
        /** @var int|null */
        public ?int $Id=null,

        // @DataMember(Order=2)
        /** @var string|null */
        public ?string $PublicAccessGuid=null,

        // @DataMember(Order=3)
        /** @var int */
        public int $CampaignActionsId=0,

        // @DataMember(Order=4)
        /** @var string|null */
        public ?string $CampaignActionDescription=null,

        // @DataMember(Order=5)
        /** @var string|null */
        public ?string $ActionType=null,

        // @DataMember(Order=6)
        /** @var int|null */
        public ?int $TotalCampaignActionRequests=null,

        // @DataMember(Order=7)
        /** @var int|null */
        public ?int $TotalInboxResponses=null,

        // @DataMember(Order=8)
        /** @var int|null */
        public ?int $TotalUniqueResponses=null,

        // @DataMember(Order=9)
        /** @var float|null */
        public ?float $ResponsePercent=null,

        // @DataMember(Order=10)
        /** @var string */
        public string $CaPublicAccessGuid=''
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Id'])) $this->Id = $o['Id'];
        if (isset($o['PublicAccessGuid'])) $this->PublicAccessGuid = $o['PublicAccessGuid'];
        if (isset($o['CampaignActionsId'])) $this->CampaignActionsId = $o['CampaignActionsId'];
        if (isset($o['CampaignActionDescription'])) $this->CampaignActionDescription = $o['CampaignActionDescription'];
        if (isset($o['ActionType'])) $this->ActionType = $o['ActionType'];
        if (isset($o['TotalCampaignActionRequests'])) $this->TotalCampaignActionRequests = $o['TotalCampaignActionRequests'];
        if (isset($o['TotalInboxResponses'])) $this->TotalInboxResponses = $o['TotalInboxResponses'];
        if (isset($o['TotalUniqueResponses'])) $this->TotalUniqueResponses = $o['TotalUniqueResponses'];
        if (isset($o['ResponsePercent'])) $this->ResponsePercent = $o['ResponsePercent'];
        if (isset($o['CaPublicAccessGuid'])) $this->CaPublicAccessGuid = $o['CaPublicAccessGuid'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Id)) $o['Id'] = $this->Id;
        if (isset($this->PublicAccessGuid)) $o['PublicAccessGuid'] = $this->PublicAccessGuid;
        if (isset($this->CampaignActionsId)) $o['CampaignActionsId'] = $this->CampaignActionsId;
        if (isset($this->CampaignActionDescription)) $o['CampaignActionDescription'] = $this->CampaignActionDescription;
        if (isset($this->ActionType)) $o['ActionType'] = $this->ActionType;
        if (isset($this->TotalCampaignActionRequests)) $o['TotalCampaignActionRequests'] = $this->TotalCampaignActionRequests;
        if (isset($this->TotalInboxResponses)) $o['TotalInboxResponses'] = $this->TotalInboxResponses;
        if (isset($this->TotalUniqueResponses)) $o['TotalUniqueResponses'] = $this->TotalUniqueResponses;
        if (isset($this->ResponsePercent)) $o['ResponsePercent'] = $this->ResponsePercent;
        if (isset($this->CaPublicAccessGuid)) $o['CaPublicAccessGuid'] = $this->CaPublicAccessGuid;
        return empty($o) ? new class(){} : $o;
    }
}

class CampaignActionPaymentResponsesView implements JsonSerializable
{
    public function __construct(
        // @DataMember(Order=1)
        /** @var int|null */
        public ?int $Id=null,

        // @DataMember(Order=2)
        /** @var string|null */
        public ?string $PublicAccessGuid=null,

        // @DataMember(Order=4)
        /** @var int */
        public int $CampaignActionsId=0,

        // @DataMember(Order=5)
        /** @var string|null */
        public ?string $CampaignActionDescription=null,

        // @DataMember(Order=6)
        /** @var string|null */
        public ?string $ActionType=null,

        // @DataMember(Order=7)
        /** @var int|null */
        public ?int $TotalCampaignActionRequests=null,

        // @DataMember(Order=8)
        /** @var int|null */
        public ?int $TotalPaymentResponses=null,

        // @DataMember(Order=9)
        /** @var float|null */
        public ?float $TotalPaid=null,

        // @DataMember(Order=10)
        /** @var float|null */
        public ?float $TotalOutstanding=null,

        // @DataMember(Order=11)
        /** @var string */
        public string $CaPublicAccessGuid=''
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Id'])) $this->Id = $o['Id'];
        if (isset($o['PublicAccessGuid'])) $this->PublicAccessGuid = $o['PublicAccessGuid'];
        if (isset($o['CampaignActionsId'])) $this->CampaignActionsId = $o['CampaignActionsId'];
        if (isset($o['CampaignActionDescription'])) $this->CampaignActionDescription = $o['CampaignActionDescription'];
        if (isset($o['ActionType'])) $this->ActionType = $o['ActionType'];
        if (isset($o['TotalCampaignActionRequests'])) $this->TotalCampaignActionRequests = $o['TotalCampaignActionRequests'];
        if (isset($o['TotalPaymentResponses'])) $this->TotalPaymentResponses = $o['TotalPaymentResponses'];
        if (isset($o['TotalPaid'])) $this->TotalPaid = $o['TotalPaid'];
        if (isset($o['TotalOutstanding'])) $this->TotalOutstanding = $o['TotalOutstanding'];
        if (isset($o['CaPublicAccessGuid'])) $this->CaPublicAccessGuid = $o['CaPublicAccessGuid'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Id)) $o['Id'] = $this->Id;
        if (isset($this->PublicAccessGuid)) $o['PublicAccessGuid'] = $this->PublicAccessGuid;
        if (isset($this->CampaignActionsId)) $o['CampaignActionsId'] = $this->CampaignActionsId;
        if (isset($this->CampaignActionDescription)) $o['CampaignActionDescription'] = $this->CampaignActionDescription;
        if (isset($this->ActionType)) $o['ActionType'] = $this->ActionType;
        if (isset($this->TotalCampaignActionRequests)) $o['TotalCampaignActionRequests'] = $this->TotalCampaignActionRequests;
        if (isset($this->TotalPaymentResponses)) $o['TotalPaymentResponses'] = $this->TotalPaymentResponses;
        if (isset($this->TotalPaid)) $o['TotalPaid'] = $this->TotalPaid;
        if (isset($this->TotalOutstanding)) $o['TotalOutstanding'] = $this->TotalOutstanding;
        if (isset($this->CaPublicAccessGuid)) $o['CaPublicAccessGuid'] = $this->CaPublicAccessGuid;
        return empty($o) ? new class(){} : $o;
    }
}

class CampaignCustomerVerificationsView implements JsonSerializable
{
    public function __construct(
        // @DataMember(Order=1)
        /** @var int|null */
        public ?int $Id=null,

        // @DataMember(Order=2)
        /** @var string|null */
        public ?string $PublicAccessGuid=null,

        // @DataMember(Order=3)
        /** @var string|null */
        public ?string $Description=null,

        // @DataMember(Order=4)
        /** @var int|null */
        public ?int $TotalVerifications=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Id'])) $this->Id = $o['Id'];
        if (isset($o['PublicAccessGuid'])) $this->PublicAccessGuid = $o['PublicAccessGuid'];
        if (isset($o['Description'])) $this->Description = $o['Description'];
        if (isset($o['TotalVerifications'])) $this->TotalVerifications = $o['TotalVerifications'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Id)) $o['Id'] = $this->Id;
        if (isset($this->PublicAccessGuid)) $o['PublicAccessGuid'] = $this->PublicAccessGuid;
        if (isset($this->Description)) $o['Description'] = $this->Description;
        if (isset($this->TotalVerifications)) $o['TotalVerifications'] = $this->TotalVerifications;
        return empty($o) ? new class(){} : $o;
    }
}

class CampaignActionSummaryResponses implements JsonSerializable
{
    public function __construct(
        /** @var array<CampaignActionInboxResponsesView>|null */
        public ?array $campaignActionInboxResponses=null,
        /** @var array<CampaignActionPaymentResponsesView>|null */
        public ?array $campaignActionPaymentResponses=null,
        /** @var array<CampaignCustomerVerificationsView>|null */
        public ?array $campaignCustomerVerificationResponses=null,
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['campaignActionInboxResponses'])) $this->campaignActionInboxResponses = JsonConverters::fromArray('CampaignActionInboxResponsesView', $o['campaignActionInboxResponses']);
        if (isset($o['campaignActionPaymentResponses'])) $this->campaignActionPaymentResponses = JsonConverters::fromArray('CampaignActionPaymentResponsesView', $o['campaignActionPaymentResponses']);
        if (isset($o['campaignCustomerVerificationResponses'])) $this->campaignCustomerVerificationResponses = JsonConverters::fromArray('CampaignCustomerVerificationsView', $o['campaignCustomerVerificationResponses']);
        if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->campaignActionInboxResponses)) $o['campaignActionInboxResponses'] = JsonConverters::toArray('CampaignActionInboxResponsesView', $this->campaignActionInboxResponses);
        if (isset($this->campaignActionPaymentResponses)) $o['campaignActionPaymentResponses'] = JsonConverters::toArray('CampaignActionPaymentResponsesView', $this->campaignActionPaymentResponses);
        if (isset($this->campaignCustomerVerificationResponses)) $o['campaignCustomerVerificationResponses'] = JsonConverters::toArray('CampaignCustomerVerificationsView', $this->campaignCustomerVerificationResponses);
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

class CampaignActionSummaryRequest implements JsonSerializable
{
    public function __construct(
        // @DataMember(Order=1)
        // @Validate(Validator="NotNull")
        /** @var string */
        public string $PublicAccessGuid=''
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['PublicAccessGuid'])) $this->PublicAccessGuid = $o['PublicAccessGuid'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->PublicAccessGuid)) $o['PublicAccessGuid'] = $this->PublicAccessGuid;
        return empty($o) ? new class(){} : $o;
    }
}

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