Platform API

GetRolesForAutomationNotifications

Get eligible roles for automation notifications

The following routes are available for this service:
GET	/api/automation/notification/{ObjectId}/roles

import 'package:servicestack/servicestack.dart';

class GroupedListItemModel implements IConvertible
{
    String? ListItemId;
    String? Name;
    String? GroupId;
    String? GroupName;

    GroupedListItemModel({this.ListItemId,this.Name,this.GroupId,this.GroupName});
    GroupedListItemModel.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ListItemId = json['ListItemId'];
        Name = json['Name'];
        GroupId = json['GroupId'];
        GroupName = json['GroupName'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ListItemId': ListItemId,
        'Name': Name,
        'GroupId': GroupId,
        'GroupName': GroupName
    };

    getTypeName() => "GroupedListItemModel";
    TypeContext? context = _ctx;
}

// @ApiResponse(Description="A list of roles that are eligible to be assigned to a notification.")
class GetRolesForAutomationNotificationsResponse implements IConvertible
{
    /**
    * 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.")
    List<GroupedListItemModel>? AllRoles;

    /**
    * 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.")
    List<String>? RolesUsedEmail;

    /**
    * 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.")
    List<String>? RolesUsedSMS;

    ResponseStatus? ResponseStatus;

    GetRolesForAutomationNotificationsResponse({this.AllRoles,this.RolesUsedEmail,this.RolesUsedSMS,this.ResponseStatus});
    GetRolesForAutomationNotificationsResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        AllRoles = JsonConverters.fromJson(json['AllRoles'],'List<GroupedListItemModel>',context!);
        RolesUsedEmail = JsonConverters.fromJson(json['RolesUsedEmail'],'List<String>',context!);
        RolesUsedSMS = JsonConverters.fromJson(json['RolesUsedSMS'],'List<String>',context!);
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'AllRoles': JsonConverters.toJson(AllRoles,'List<GroupedListItemModel>',context!),
        'RolesUsedEmail': JsonConverters.toJson(RolesUsedEmail,'List<String>',context!),
        'RolesUsedSMS': JsonConverters.toJson(RolesUsedSMS,'List<String>',context!),
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "GetRolesForAutomationNotificationsResponse";
    TypeContext? context = _ctx;
}

/**
* 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 IConvertible
{
    /**
    * 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")
    String? ObjectId;

    GetRolesForAutomationNotifications({this.ObjectId});
    GetRolesForAutomationNotifications.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        ObjectId = json['ObjectId'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'ObjectId': ObjectId
    });

    getTypeName() => "GetRolesForAutomationNotifications";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'pfapi.pstpf.com.au', types: <String, TypeInfo> {
    'GroupedListItemModel': TypeInfo(TypeOf.Class, create:() => GroupedListItemModel()),
    'GetRolesForAutomationNotificationsResponse': TypeInfo(TypeOf.Class, create:() => GetRolesForAutomationNotificationsResponse()),
    'List<GroupedListItemModel>': TypeInfo(TypeOf.Class, create:() => <GroupedListItemModel>[]),
    'GetRolesForAutomationNotifications': TypeInfo(TypeOf.Class, create:() => GetRolesForAutomationNotifications()),
});

Dart GetRolesForAutomationNotifications DTOs

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

HTTP + OTHER

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: text/jsonl

HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}}