<back to all web services

ControlDataMessage

The following routes are available for this service:
GET/RestApi/personalizations/render
<?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 ControlDataMessage implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $PageNodeId='',
        /** @var string */
        public string $PageDataId='',
        /** @var array<string>|null */
        public ?array $Controls=null,
        /** @var string|null */
        public ?string $Url=null,
        /** @var string|null */
        public ?string $PageNodeKey=null,
        /** @var string|null */
        public ?string $CorrelationId=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['PageNodeId'])) $this->PageNodeId = $o['PageNodeId'];
        if (isset($o['PageDataId'])) $this->PageDataId = $o['PageDataId'];
        if (isset($o['Controls'])) $this->Controls = JsonConverters::fromArray('string', $o['Controls']);
        if (isset($o['Url'])) $this->Url = $o['Url'];
        if (isset($o['PageNodeKey'])) $this->PageNodeKey = $o['PageNodeKey'];
        if (isset($o['CorrelationId'])) $this->CorrelationId = $o['CorrelationId'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->PageNodeId)) $o['PageNodeId'] = $this->PageNodeId;
        if (isset($this->PageDataId)) $o['PageDataId'] = $this->PageDataId;
        if (isset($this->Controls)) $o['Controls'] = JsonConverters::toArray('string', $this->Controls);
        if (isset($this->Url)) $o['Url'] = $this->Url;
        if (isset($this->PageNodeKey)) $o['PageNodeKey'] = $this->PageNodeKey;
        if (isset($this->CorrelationId)) $o['CorrelationId'] = $this->CorrelationId;
        return empty($o) ? new class(){} : $o;
    }
}

PHP ControlDataMessage 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 /RestApi/personalizations/render HTTP/1.1 
Host: www.asg.com.au 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfControlDataResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Telerik.Sitefinity.Personalization.Impl.Web.Services.Dto.Response">
  <ControlDataResponse>
    <Content>String</Content>
    <ControlId>String</ControlId>
  </ControlDataResponse>
</ArrayOfControlDataResponse>