| All Verbs | /api/permissions/{PermissionId}/matrix/ |
|---|
<?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 PermissionLevelModel implements JsonSerializable
{
public function __construct(
/** @var string|null */
public ?string $PermissionValueId=null,
/** @var string */
public string $ObjectId='',
/** @var string|null */
public ?string $ObjectName=null,
/** @var string|null */
public ?string $ObjectGroup=null,
/** @var int */
public int $ContactsAffected=0,
/** @var bool|null */
public ?bool $PermissionValue=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['PermissionValueId'])) $this->PermissionValueId = $o['PermissionValueId'];
if (isset($o['ObjectId'])) $this->ObjectId = $o['ObjectId'];
if (isset($o['ObjectName'])) $this->ObjectName = $o['ObjectName'];
if (isset($o['ObjectGroup'])) $this->ObjectGroup = $o['ObjectGroup'];
if (isset($o['ContactsAffected'])) $this->ContactsAffected = $o['ContactsAffected'];
if (isset($o['PermissionValue'])) $this->PermissionValue = $o['PermissionValue'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->PermissionValueId)) $o['PermissionValueId'] = $this->PermissionValueId;
if (isset($this->ObjectId)) $o['ObjectId'] = $this->ObjectId;
if (isset($this->ObjectName)) $o['ObjectName'] = $this->ObjectName;
if (isset($this->ObjectGroup)) $o['ObjectGroup'] = $this->ObjectGroup;
if (isset($this->ContactsAffected)) $o['ContactsAffected'] = $this->ContactsAffected;
if (isset($this->PermissionValue)) $o['PermissionValue'] = $this->PermissionValue;
return empty($o) ? new class(){} : $o;
}
}
// @ApiResponse(Description="Returns the Permission Value for an object and the permission levels that make up the determination of the permission.")
class GetPermissionMatrixResponse implements JsonSerializable
{
public function __construct(
/** @var bool|null */
public ?bool $PermissionLevelValue=null,
/** @var array<PermissionLevelModel>|null */
public ?array $PermissionsMatrix=null,
/** @var ResponseStatus|null */
public ?ResponseStatus $ResponseStatus=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['PermissionLevelValue'])) $this->PermissionLevelValue = $o['PermissionLevelValue'];
if (isset($o['PermissionsMatrix'])) $this->PermissionsMatrix = JsonConverters::fromArray('PermissionLevelModel', $o['PermissionsMatrix']);
if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->PermissionLevelValue)) $o['PermissionLevelValue'] = $this->PermissionLevelValue;
if (isset($this->PermissionsMatrix)) $o['PermissionsMatrix'] = JsonConverters::toArray('PermissionLevelModel', $this->PermissionsMatrix);
if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
return empty($o) ? new class(){} : $o;
}
}
/** @description Get a value for the current permission and object. Including the relevant data that affects the permission value outcome. */
// @Api(Description="Get a value for the current permission and object. Including the relevant data that affects the permission value outcome.")
class GetPermissionMatrix implements JsonSerializable
{
public function __construct(
/** @description Permission Id to retrieve matrix for. */
// @ApiMember(DataType="Guid", Description="Permission Id to retrieve matrix for.", IsRequired=true, Name="PermissionId")
/** @var string */
public string $PermissionId='',
/** @description Object Id to retrieve permissions for. This will be either a contact, role list item or licensee contact. */
// @ApiMember(DataType="Guid", Description="Object Id to retrieve permissions for. This will be either a contact, role list item or licensee contact.", IsRequired=true, Name="ObjectId")
/** @var string */
public string $ObjectId=''
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['PermissionId'])) $this->PermissionId = $o['PermissionId'];
if (isset($o['ObjectId'])) $this->ObjectId = $o['ObjectId'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->PermissionId)) $o['PermissionId'] = $this->PermissionId;
if (isset($this->ObjectId)) $o['ObjectId'] = $this->ObjectId;
return empty($o) ? new class(){} : $o;
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/permissions/{PermissionId}/matrix/ HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<GetPermissionMatrix xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<ObjectId>00000000-0000-0000-0000-000000000000</ObjectId>
<PermissionId>00000000-0000-0000-0000-000000000000</PermissionId>
</GetPermissionMatrix>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetPermissionMatrixResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<PermissionLevelValue>false</PermissionLevelValue>
<PermissionsMatrix xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.Models">
<d2p1:PermissionLevelModel>
<d2p1:ContactsAffected>0</d2p1:ContactsAffected>
<d2p1:ObjectGroup>String</d2p1:ObjectGroup>
<d2p1:ObjectId>00000000-0000-0000-0000-000000000000</d2p1:ObjectId>
<d2p1:ObjectName>String</d2p1:ObjectName>
<d2p1:PermissionValue>false</d2p1:PermissionValue>
<d2p1:PermissionValueId>00000000-0000-0000-0000-000000000000</d2p1:PermissionValueId>
</d2p1:PermissionLevelModel>
</PermissionsMatrix>
<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>
</GetPermissionMatrixResponse>