digitaluapi

GetCampaignActionClientFormData

The following routes are available for this service:
GET	/campaign/inbox/form

<?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 CampaignActionFile implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $Name=null,
        /** @var string|null */
        public ?string $FileType=null,
        /** @var string|null */
        public ?string $FileSize=null,
        /** @var string|null */
        public ?string $Extension=null,
        /** @var string|null */
        public ?string $UploadUrl=null
    ) {
    }

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

class CampaignActionFormResults implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $CustomFormResults=null,
        /** @var string|null */
        public ?string $Comments=null,
        /** @var array<CampaignActionFile>|null */
        public ?array $CampaignActionFiles=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['CustomFormResults'])) $this->CustomFormResults = $o['CustomFormResults'];
        if (isset($o['Comments'])) $this->Comments = $o['Comments'];
        if (isset($o['CampaignActionFiles'])) $this->CampaignActionFiles = JsonConverters::fromArray('CampaignActionFile', $o['CampaignActionFiles']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->CustomFormResults)) $o['CustomFormResults'] = $this->CustomFormResults;
        if (isset($this->Comments)) $o['Comments'] = $this->Comments;
        if (isset($this->CampaignActionFiles)) $o['CampaignActionFiles'] = JsonConverters::toArray('CampaignActionFile', $this->CampaignActionFiles);
        return empty($o) ? new class(){} : $o;
    }
}

class GetCampaignActionClientFormDataResponse implements JsonSerializable
{
    public function __construct(
        /** @var CampaignActionFormResults|null */
        public ?CampaignActionFormResults $FormMetaResponses=null,
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null
    ) {
    }

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

class GetCampaignActionClientFormData implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $Id=0,
        /** @var string */
        public string $CommsGuid='',
        /** @var int */
        public int $CampaignActionsRequestsId=0
    ) {
    }

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

PHP GetCampaignActionClientFormData 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/inbox/form HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetCampaignActionClientFormDataResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <FormMetaResponses>
    <CampaignActionFiles>
      <CampaignActionFile>
        <Extension>String</Extension>
        <FileSize>String</FileSize>
        <FileType>String</FileType>
        <Name>String</Name>
        <UploadUrl>String</UploadUrl>
      </CampaignActionFile>
    </CampaignActionFiles>
    <Comments>String</Comments>
    <CustomFormResults>String</CustomFormResults>
  </FormMetaResponses>
  <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>
</GetCampaignActionClientFormDataResponse>