<back to all web services

DataItemMessage

The following routes are available for this service:
GET/RestApi/sitefinity/generic-data/data-items
DELETE/RestApi/sitefinity/generic-data/temp-items
<?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};


enum ContentLifecycleStatus : int
{
    case Master = 0;
    case Temp = 1;
    case Live = 2;
    case Deleted = 4;
    case PartialTemp = 8;
}

class DataItemMessage implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $ItemId=null,
        /** @var string|null */
        public ?string $ItemType=null,
        /** @var string|null */
        public ?string $ItemProvider=null,
        /** @var string|null */
        public ?string $RelatedItemId=null,
        /** @var string|null */
        public ?string $RelatedItemType=null,
        /** @var string|null */
        public ?string $RelatedItemProvider=null,
        /** @var ContentLifecycleStatus|null */
        public ?ContentLifecycleStatus $RelationStatus=null,
        /** @var string|null */
        public ?string $FieldName=null,
        /** @var string|null */
        public ?string $Filter=null,
        /** @var string|null */
        public ?string $Order=null,
        /** @var int */
        public int $Skip=0,
        /** @var int */
        public int $Take=0
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ItemId'])) $this->ItemId = $o['ItemId'];
        if (isset($o['ItemType'])) $this->ItemType = $o['ItemType'];
        if (isset($o['ItemProvider'])) $this->ItemProvider = $o['ItemProvider'];
        if (isset($o['RelatedItemId'])) $this->RelatedItemId = $o['RelatedItemId'];
        if (isset($o['RelatedItemType'])) $this->RelatedItemType = $o['RelatedItemType'];
        if (isset($o['RelatedItemProvider'])) $this->RelatedItemProvider = $o['RelatedItemProvider'];
        if (isset($o['RelationStatus'])) $this->RelationStatus = JsonConverters::from('ContentLifecycleStatus', $o['RelationStatus']);
        if (isset($o['FieldName'])) $this->FieldName = $o['FieldName'];
        if (isset($o['Filter'])) $this->Filter = $o['Filter'];
        if (isset($o['Order'])) $this->Order = $o['Order'];
        if (isset($o['Skip'])) $this->Skip = $o['Skip'];
        if (isset($o['Take'])) $this->Take = $o['Take'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ItemId)) $o['ItemId'] = $this->ItemId;
        if (isset($this->ItemType)) $o['ItemType'] = $this->ItemType;
        if (isset($this->ItemProvider)) $o['ItemProvider'] = $this->ItemProvider;
        if (isset($this->RelatedItemId)) $o['RelatedItemId'] = $this->RelatedItemId;
        if (isset($this->RelatedItemType)) $o['RelatedItemType'] = $this->RelatedItemType;
        if (isset($this->RelatedItemProvider)) $o['RelatedItemProvider'] = $this->RelatedItemProvider;
        if (isset($this->RelationStatus)) $o['RelationStatus'] = JsonConverters::to('ContentLifecycleStatus', $this->RelationStatus);
        if (isset($this->FieldName)) $o['FieldName'] = $this->FieldName;
        if (isset($this->Filter)) $o['Filter'] = $this->Filter;
        if (isset($this->Order)) $o['Order'] = $this->Order;
        if (isset($this->Skip)) $o['Skip'] = $this->Skip;
        if (isset($this->Take)) $o['Take'] = $this->Take;
        return empty($o) ? new class(){} : $o;
    }
}

PHP DataItemMessage DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /RestApi/sitefinity/generic-data/data-items HTTP/1.1 
Host: www.asg.com.au 
Accept: text/jsv