<back to all web services

ControlMessage

The following routes are available for this service:
POST DELETE/RestApi/Sitefinity/personalizations/controls
GET/RestApi/Sitefinity/personalizations/controls/segments
<?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 ControlMessage implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $PageId=null,
        /** @var string|null */
        public ?string $ControlId=null,
        /** @var string|null */
        public ?string $SegmentId=null
    ) {
    }

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

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

<ControlMessage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Telerik.Sitefinity.Personalization.Impl.Web.Services.Dto.Request">
  <ControlId>String</ControlId>
  <PageId>String</PageId>
  <SegmentId>String</SegmentId>
</ControlMessage>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">00000000-0000-0000-0000-000000000000</guid>