Platform API

GetRolesForAutomationNotifications

Get eligible roles for automation notifications

The following routes are available for this service:
GET	/api/automation/notification/{ObjectId}/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 GroupedListItemModel implements JsonSerializable
{
    public function __construct(
        /** @var string */
        public string $ListItemId='',
        /** @var string|null */
        public ?string $Name=null,
        /** @var string */
        public string $GroupId='',
        /** @var string|null */
        public ?string $GroupName=null
    ) {
    }

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

// @ApiResponse(Description="A list of roles that are eligible to be assigned to a notification.")
class GetRolesForAutomationNotificationsResponse implements JsonSerializable
{
    public function __construct(
        /** @description List of all roles (grouped by suite) that can be assigned to a notification. */
        // @ApiMember(Description="List of all roles (grouped by suite) that can be assigned to a notification.")
        /** @var array<GroupedListItemModel>|null */
        public ?array $AllRoles=null,

        /** @description List of roles that are already assigned to an email notification for the object, these should be excluded from being selected again. */
        // @ApiMember(Description="List of roles that are already assigned to an email notification for the object, these should be excluded from being selected again.")
        /** @var array<string>|null */
        public ?array $RolesUsedEmail=null,

        /** @description List of roles that are already assigned to an sms notification for the object, these should be excluded from being selected again. */
        // @ApiMember(Description="List of roles that are already assigned to an sms notification for the object, these should be excluded from being selected again.")
        /** @var array<string>|null */
        public ?array $RolesUsedSMS=null,

        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['AllRoles'])) $this->AllRoles = JsonConverters::fromArray('GroupedListItemModel', $o['AllRoles']);
        if (isset($o['RolesUsedEmail'])) $this->RolesUsedEmail = JsonConverters::fromArray('Guid', $o['RolesUsedEmail']);
        if (isset($o['RolesUsedSMS'])) $this->RolesUsedSMS = JsonConverters::fromArray('Guid', $o['RolesUsedSMS']);
        if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->AllRoles)) $o['AllRoles'] = JsonConverters::toArray('GroupedListItemModel', $this->AllRoles);
        if (isset($this->RolesUsedEmail)) $o['RolesUsedEmail'] = JsonConverters::toArray('Guid', $this->RolesUsedEmail);
        if (isset($this->RolesUsedSMS)) $o['RolesUsedSMS'] = JsonConverters::toArray('Guid', $this->RolesUsedSMS);
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

/** @description Get eligible roles for automation notifications */
// @Api(Description="Get eligible roles for automation notifications")
// @ApiResponse(Description="A list of roles that are eligible to be assigned to a notification.")
class GetRolesForAutomationNotifications extends GetRolesForAutomationNotificationsResponse implements JsonSerializable
{
    /**
     * @param array<GroupedListItemModel>|null $AllRoles
     * @param array<string>|null $RolesUsedEmail
     * @param array<string>|null $RolesUsedSMS
     * @param ResponseStatus|null $ResponseStatus
     */
    public function __construct(
        ?array $AllRoles=null,
        ?array $RolesUsedEmail=null,
        ?array $RolesUsedSMS=null,
        ?ResponseStatus $ResponseStatus=null,
        /** @description Object the notification will be for. Used to exclude any currently assigned roles. */
        // @ApiMember(Description="Object the notification will be for. Used to exclude any currently assigned roles.", ParameterType="path")
        /** @var string */
        public string $ObjectId=''
    ) {
        parent::__construct($AllRoles,$RolesUsedEmail,$RolesUsedSMS,$ResponseStatus);
    }

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

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

GET /api/automation/notification/{ObjectId}/roles HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"AllRoles":[{"ListItemId":"00000000-0000-0000-0000-000000000000","Name":"String","GroupId":"00000000-0000-0000-0000-000000000000","GroupName":"String"}],"RolesUsedEmail":["00000000-0000-0000-0000-000000000000"],"RolesUsedSMS":["00000000-0000-0000-0000-000000000000"],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}