digitaluapi

<back to all web services

SaveCampaignActionClientCustomForm

The following routes are available for this service:
PUT POST/campaign/inbox/customform
<?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 CampaignActionsFormResponses implements JsonSerializable
{
    public function __construct(
        // @DataMember(Order=1)
        // @Required()
        /** @var int */
        public int $Id=0,

        // @DataMember(Order=2)
        // @Required()
        // @References("typeof(digitaluapi.ServiceModel.Types.CampaignActions)")
        /** @var int */
        public int $CampaignActionsId=0,

        // @DataMember(Order=3)
        // @References("typeof(digitaluapi.ServiceModel.Types.Customers)")
        /** @var int|null */
        public ?int $CustomersId=null,

        // @DataMember(Order=4)
        // @Required()
        // @Computed()
        /** @var DateTime */
        public DateTime $ActionTimestamp=new DateTime(),

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

        // @DataMember(Order=6)
        /** @var array<string,string>|null */
        public ?array $FormMetaCustomResponses=null,

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

        // @DataMember(Order=8)
        /** @var array<CampaignActionFile>|null */
        public ?array $FormMetaFilesResponses=null,

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

        // @DataMember(Order=10)
        /** @var int */
        public int $StatusCodesId=0,

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

        // @DataMember(Order=12)
        /** @var int */
        public int $VersionNumber=0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Id'])) $this->Id = $o['Id'];
        if (isset($o['CampaignActionsId'])) $this->CampaignActionsId = $o['CampaignActionsId'];
        if (isset($o['CustomersId'])) $this->CustomersId = $o['CustomersId'];
        if (isset($o['ActionTimestamp'])) $this->ActionTimestamp = JsonConverters::from('DateTime', $o['ActionTimestamp']);
        if (isset($o['FormMetaResponses'])) $this->FormMetaResponses = JsonConverters::from('CampaignActionFormResults', $o['FormMetaResponses']);
        if (isset($o['FormMetaCustomResponses'])) $this->FormMetaCustomResponses = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['string','string']), $o['FormMetaCustomResponses']);
        if (isset($o['CampaignInstanceCommsId'])) $this->CampaignInstanceCommsId = $o['CampaignInstanceCommsId'];
        if (isset($o['FormMetaFilesResponses'])) $this->FormMetaFilesResponses = JsonConverters::fromArray('CampaignActionFile', $o['FormMetaFilesResponses']);
        if (isset($o['FormMetaComments'])) $this->FormMetaComments = $o['FormMetaComments'];
        if (isset($o['StatusCodesId'])) $this->StatusCodesId = $o['StatusCodesId'];
        if (isset($o['SentToEmailAddress'])) $this->SentToEmailAddress = $o['SentToEmailAddress'];
        if (isset($o['VersionNumber'])) $this->VersionNumber = $o['VersionNumber'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Id)) $o['Id'] = $this->Id;
        if (isset($this->CampaignActionsId)) $o['CampaignActionsId'] = $this->CampaignActionsId;
        if (isset($this->CustomersId)) $o['CustomersId'] = $this->CustomersId;
        if (isset($this->ActionTimestamp)) $o['ActionTimestamp'] = JsonConverters::to('DateTime', $this->ActionTimestamp);
        if (isset($this->FormMetaResponses)) $o['FormMetaResponses'] = JsonConverters::to('CampaignActionFormResults', $this->FormMetaResponses);
        if (isset($this->FormMetaCustomResponses)) $o['FormMetaCustomResponses'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['string','string']), $this->FormMetaCustomResponses);
        if (isset($this->CampaignInstanceCommsId)) $o['CampaignInstanceCommsId'] = $this->CampaignInstanceCommsId;
        if (isset($this->FormMetaFilesResponses)) $o['FormMetaFilesResponses'] = JsonConverters::toArray('CampaignActionFile', $this->FormMetaFilesResponses);
        if (isset($this->FormMetaComments)) $o['FormMetaComments'] = $this->FormMetaComments;
        if (isset($this->StatusCodesId)) $o['StatusCodesId'] = $this->StatusCodesId;
        if (isset($this->SentToEmailAddress)) $o['SentToEmailAddress'] = $this->SentToEmailAddress;
        if (isset($this->VersionNumber)) $o['VersionNumber'] = $this->VersionNumber;
        return empty($o) ? new class(){} : $o;
    }
}

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

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

class SaveCampaignActionClientCustomForm implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $CommsGuid='',
        /** @var int */
        public int $CampaignActionsRequestsId=0,
        /** @var array<string,string>|null */
        public ?array $CustomFormResults=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['CommsGuid'])) $this->CommsGuid = $o['CommsGuid'];
        if (isset($o['CampaignActionsRequestsId'])) $this->CampaignActionsRequestsId = $o['CampaignActionsRequestsId'];
        if (isset($o['CustomFormResults'])) $this->CustomFormResults = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['string','string']), $o['CustomFormResults']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->CommsGuid)) $o['CommsGuid'] = $this->CommsGuid;
        if (isset($this->CampaignActionsRequestsId)) $o['CampaignActionsRequestsId'] = $this->CampaignActionsRequestsId;
        if (isset($this->CustomFormResults)) $o['CustomFormResults'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['string','string']), $this->CustomFormResults);
        return empty($o) ? new class(){} : $o;
    }
}

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

POST /campaign/inbox/customform HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SaveCampaignActionClientCustomForm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <CampaignActionsRequestsId>0</CampaignActionsRequestsId>
  <CommsGuid>00000000-0000-0000-0000-000000000000</CommsGuid>
  <CustomFormResults xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </CustomFormResults>
</SaveCampaignActionClientCustomForm>

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

<SaveCampaignActionClientFormResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <CampaignActionsFormResponses xmlns:d2p1="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel.Types">
    <d2p1:ActionTimestamp xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>0001-01-01T00:00:00Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </d2p1:ActionTimestamp>
    <d2p1:CampaignActionsId>0</d2p1:CampaignActionsId>
    <d2p1:CampaignInstanceCommsId>0</d2p1:CampaignInstanceCommsId>
    <d2p1:CustomersId>0</d2p1:CustomersId>
    <d2p1:FormMetaComments>String</d2p1:FormMetaComments>
    <d2p1:FormMetaCustomResponses 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:FormMetaCustomResponses>
    <d2p1:FormMetaFilesResponses>
      <CampaignActionFile>
        <Extension>String</Extension>
        <FileSize>String</FileSize>
        <FileType>String</FileType>
        <Name>String</Name>
        <UploadUrl>String</UploadUrl>
      </CampaignActionFile>
    </d2p1:FormMetaFilesResponses>
    <d2p1: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>
    </d2p1:FormMetaResponses>
    <d2p1:Id>0</d2p1:Id>
    <d2p1:SentToEmailAddress>String</d2p1:SentToEmailAddress>
    <d2p1:StatusCodesId>0</d2p1:StatusCodesId>
    <d2p1:VersionNumber>0</d2p1:VersionNumber>
  </CampaignActionsFormResponses>
  <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>
</SaveCampaignActionClientFormResponse>