Platform API

<back to all web services

UpdateRoleWithSharing

Updates a Role record, and updates Sharing.

Requires Authentication
The following routes are available for this service:
PUT/api/roles
<?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 ListItemFilterModel implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $ListItemFilterId='',
        /** @var string|null */
        public ?string $FilterName=null,
        /** @var string */
        public string $ListId='',
        /** @var string */
        public string $ListItemId='',
        /** @var bool|null */
        public ?bool $ListItemIsInFilter=null
    ) {
    }

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

class RoleDetailsModel implements JsonSerializable
{
    public function __construct(
        /** @description Role Id */
        // @ApiMember(DataType="Guid", Description="Role Id", Name="RoleId")
        /** @var string */
        public string $RoleId='',

        /** @description Role Name */
        // @ApiMember(DataType="string", Description="Role Name", Name="RoleName")
        /** @var string|null */
        public ?string $RoleName=null,

        /** @description Role Connection Definition Id */
        // @ApiMember(DataType="Guid", Description="Role Connection Definition Id", Name="RoleConnectionDefinitionId")
        /** @var string */
        public string $RoleConnectionDefinitionId='',

        /** @description Contact Types the Role applies to */
        // @ApiMember(DataType="List", Description="Contact Types the Role applies to", Name="ContactTypes")
        /** @var array<string>|null */
        public ?array $ContactTypes=null,

        /** @description Does the role require contacts to accept it? */
        // @ApiMember(DataType="bool", Description="Does the role require contacts to accept it?", Name="RequireContactsToAccept")
        /** @var bool|null */
        public ?bool $RequireContactsToAccept=null,

        /** @description Filters linked to the custom role. */
        // @ApiMember(DataType="List", Description="Filters linked to the custom role.", Name="ListItemFilters")
        /** @var array<ListItemFilterModel>|null */
        public ?array $ListItemFilters=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['RoleId'])) $this->RoleId = $o['RoleId'];
        if (isset($o['RoleName'])) $this->RoleName = $o['RoleName'];
        if (isset($o['RoleConnectionDefinitionId'])) $this->RoleConnectionDefinitionId = $o['RoleConnectionDefinitionId'];
        if (isset($o['ContactTypes'])) $this->ContactTypes = JsonConverters::fromArray('Guid', $o['ContactTypes']);
        if (isset($o['RequireContactsToAccept'])) $this->RequireContactsToAccept = $o['RequireContactsToAccept'];
        if (isset($o['ListItemFilters'])) $this->ListItemFilters = JsonConverters::fromArray('ListItemFilterModel', $o['ListItemFilters']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->RoleId)) $o['RoleId'] = $this->RoleId;
        if (isset($this->RoleName)) $o['RoleName'] = $this->RoleName;
        if (isset($this->RoleConnectionDefinitionId)) $o['RoleConnectionDefinitionId'] = $this->RoleConnectionDefinitionId;
        if (isset($this->ContactTypes)) $o['ContactTypes'] = JsonConverters::toArray('Guid', $this->ContactTypes);
        if (isset($this->RequireContactsToAccept)) $o['RequireContactsToAccept'] = $this->RequireContactsToAccept;
        if (isset($this->ListItemFilters)) $o['ListItemFilters'] = JsonConverters::toArray('ListItemFilterModel', $this->ListItemFilters);
        return empty($o) ? new class(){} : $o;
    }
}

class ObjectShareModel implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $ObjectShareId='',
        /** @var string */
        public string $ObjectId='',
        /** @var string|null */
        public ?string $ObjectName=null,
        /** @var string|null */
        public ?string $Name=null,
        /** @var string|null */
        public ?string $Description=null,
        /** @var string|null */
        public ?string $Reference=null,
        /** @var string */
        public string $ContactId='',
        /** @var string|null */
        public ?string $ContactName=null,
        /** @var string|null */
        public ?string $ContactType=null,
        /** @var string|null */
        public ?string $ContactImageUrlPrimary=null,
        /** @var string|null */
        public ?string $ContactImageUrlPrimaryThmbnail=null,
        /** @var string */
        public string $ShareStatusId='',
        /** @var string|null */
        public ?string $ShareStatusName=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['ObjectShareId'])) $this->ObjectShareId = $o['ObjectShareId'];
        if (isset($o['ObjectId'])) $this->ObjectId = $o['ObjectId'];
        if (isset($o['ObjectName'])) $this->ObjectName = $o['ObjectName'];
        if (isset($o['Name'])) $this->Name = $o['Name'];
        if (isset($o['Description'])) $this->Description = $o['Description'];
        if (isset($o['Reference'])) $this->Reference = $o['Reference'];
        if (isset($o['ContactId'])) $this->ContactId = $o['ContactId'];
        if (isset($o['ContactName'])) $this->ContactName = $o['ContactName'];
        if (isset($o['ContactType'])) $this->ContactType = $o['ContactType'];
        if (isset($o['ContactImageUrlPrimary'])) $this->ContactImageUrlPrimary = $o['ContactImageUrlPrimary'];
        if (isset($o['ContactImageUrlPrimaryThmbnail'])) $this->ContactImageUrlPrimaryThmbnail = $o['ContactImageUrlPrimaryThmbnail'];
        if (isset($o['ShareStatusId'])) $this->ShareStatusId = $o['ShareStatusId'];
        if (isset($o['ShareStatusName'])) $this->ShareStatusName = $o['ShareStatusName'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->ObjectShareId)) $o['ObjectShareId'] = $this->ObjectShareId;
        if (isset($this->ObjectId)) $o['ObjectId'] = $this->ObjectId;
        if (isset($this->ObjectName)) $o['ObjectName'] = $this->ObjectName;
        if (isset($this->Name)) $o['Name'] = $this->Name;
        if (isset($this->Description)) $o['Description'] = $this->Description;
        if (isset($this->Reference)) $o['Reference'] = $this->Reference;
        if (isset($this->ContactId)) $o['ContactId'] = $this->ContactId;
        if (isset($this->ContactName)) $o['ContactName'] = $this->ContactName;
        if (isset($this->ContactType)) $o['ContactType'] = $this->ContactType;
        if (isset($this->ContactImageUrlPrimary)) $o['ContactImageUrlPrimary'] = $this->ContactImageUrlPrimary;
        if (isset($this->ContactImageUrlPrimaryThmbnail)) $o['ContactImageUrlPrimaryThmbnail'] = $this->ContactImageUrlPrimaryThmbnail;
        if (isset($this->ShareStatusId)) $o['ShareStatusId'] = $this->ShareStatusId;
        if (isset($this->ShareStatusName)) $o['ShareStatusName'] = $this->ShareStatusName;
        return empty($o) ? new class(){} : $o;
    }
}

/** @description Updates a Role record, and updates Sharing. */
// @Api(Description="Updates a Role record, and updates Sharing.")
class UpdateRoleWithSharing implements JsonSerializable
{
    public function __construct(
        /** @description Details of the Contact Role to be Updated. */
        // @ApiMember(DataType="RoleDetailsModel", Description="Details of the Contact Role to be Updated.", IsRequired=true, Name="RoleDetails", ParameterType="query")
        /** @var RoleDetailsModel|null */
        public ?RoleDetailsModel $RoleDetails=null,

        /** @description  */
        // @ApiMember(DataType="FormCollection", Description="", Name="Form", ParameterType="query")
        /** @var FormCollection|null */
        public ?FormCollection $Form=null,

        /** @description List of Object Share details. */
        // @ApiMember(DataType="List<ObjectShareModel>", Description="List of Object Share details.", Name="ShareList", ParameterType="query")
        /** @var array<ObjectShareModel>|null */
        public ?array $ShareList=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['RoleDetails'])) $this->RoleDetails = JsonConverters::from('RoleDetailsModel', $o['RoleDetails']);
        if (isset($o['Form'])) $this->Form = JsonConverters::from('FormCollection', $o['Form']);
        if (isset($o['ShareList'])) $this->ShareList = JsonConverters::fromArray('ObjectShareModel', $o['ShareList']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->RoleDetails)) $o['RoleDetails'] = JsonConverters::to('RoleDetailsModel', $this->RoleDetails);
        if (isset($this->Form)) $o['Form'] = JsonConverters::to('FormCollection', $this->Form);
        if (isset($this->ShareList)) $o['ShareList'] = JsonConverters::toArray('ObjectShareModel', $this->ShareList);
        return empty($o) ? new class(){} : $o;
    }
}

PHP UpdateRoleWithSharing 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.

PUT /api/roles HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	RoleDetails: 
	{
		RoleName: String,
		ContactTypes: 
		[
			00000000-0000-0000-0000-000000000000
		],
		RequireContactsToAccept: False,
		ListItemFilters: 
		[
			{
				FilterName: String,
				ListItemIsInFilter: False
			}
		]
	},
	Form: [],
	ShareList: 
	[
		{
			ObjectName: String,
			Name: String,
			Description: String,
			Reference: String,
			ContactName: String,
			ContactType: String,
			ContactImageUrlPrimary: String,
			ContactImageUrlPrimaryThmbnail: String,
			ShareStatusName: String
		}
	]
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ErrorCode: String,
	Message: String,
	StackTrace: String,
	Errors: 
	[
		{
			ErrorCode: String,
			FieldName: String,
			Message: String,
			Meta: 
			{
				String: String
			}
		}
	],
	Meta: 
	{
		String: String
	}
}