<back to all web services

GetDashboardPermissionsForUserMessage

The following routes are available for this service:
All Verbs/RestApi/Sitefinity/Analytics/GetDashboardPermissionsForUser
All Verbs/RestApi/GetDashboardPermissionsForUser
<?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 GetDashboardPermissionsForUserMessage implements JsonSerializable
{
    public function __construct(
        /** @var string|null */
        public ?string $UserName=null,
        /** @var string */
        public string $UserId='',
        /** @var string */
        public string $SiteId=''
    ) {
    }

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

// @DataContract
class DashboardPermission implements JsonSerializable
{
    public function __construct(
        // @DataMember
        /** @var string */
        public string $DashboardId='',

        // @DataMember
        /** @var bool|null */
        public ?bool $CanView=null
    ) {
    }

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

class GetDashboardPermissionsForUserData implements JsonSerializable
{
    public function __construct(
        /** @var array<DashboardPermission>|null */
        public ?array $Permissions=null,
        /** @var bool|null */
        public ?bool $IsAdmin=null,
        /** @var bool|null */
        public ?bool $IsAdminRole=null
    ) {
    }

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

PHP GetDashboardPermissionsForUserMessage DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /RestApi/Sitefinity/Analytics/GetDashboardPermissionsForUser HTTP/1.1 
Host: www.asg.com.au 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"UserName":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Permissions":[{"CanView":false}],"IsAdmin":false,"IsAdminRole":false}