Platform API

GetPermissionMatrix

Get a value for the current permission and object. Including the relevant data that affects the permission value outcome.

The following routes are available for this service:
All Verbs	/api/permissions/{PermissionId}/matrix/

import 'package:servicestack/servicestack.dart';

class PermissionLevelModel implements IConvertible
{
    String? PermissionValueId;
    String? ObjectId;
    String? ObjectName;
    String? ObjectGroup;
    int? ContactsAffected;
    bool? PermissionValue;

    PermissionLevelModel({this.PermissionValueId,this.ObjectId,this.ObjectName,this.ObjectGroup,this.ContactsAffected,this.PermissionValue});
    PermissionLevelModel.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        PermissionValueId = json['PermissionValueId'];
        ObjectId = json['ObjectId'];
        ObjectName = json['ObjectName'];
        ObjectGroup = json['ObjectGroup'];
        ContactsAffected = json['ContactsAffected'];
        PermissionValue = json['PermissionValue'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'PermissionValueId': PermissionValueId,
        'ObjectId': ObjectId,
        'ObjectName': ObjectName,
        'ObjectGroup': ObjectGroup,
        'ContactsAffected': ContactsAffected,
        'PermissionValue': PermissionValue
    };

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

// @ApiResponse(Description="Returns the Permission Value for an object and the permission levels that make up the determination of the permission.")
class GetPermissionMatrixResponse implements IConvertible
{
    bool? PermissionLevelValue;
    List<PermissionLevelModel>? PermissionsMatrix;
    ResponseStatus? ResponseStatus;

    GetPermissionMatrixResponse({this.PermissionLevelValue,this.PermissionsMatrix,this.ResponseStatus});
    GetPermissionMatrixResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        PermissionLevelValue = json['PermissionLevelValue'];
        PermissionsMatrix = JsonConverters.fromJson(json['PermissionsMatrix'],'List<PermissionLevelModel>',context!);
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'PermissionLevelValue': PermissionLevelValue,
        'PermissionsMatrix': JsonConverters.toJson(PermissionsMatrix,'List<PermissionLevelModel>',context!),
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

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

/**
* 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 IConvertible
{
    /**
    * Permission Id to retrieve matrix for.
    */
    // @ApiMember(DataType="Guid", Description="Permission Id to retrieve matrix for.", IsRequired=true, Name="PermissionId")
    String? PermissionId;

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

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

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

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

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

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

Dart GetPermissionMatrix 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.

POST /api/permissions/{PermissionId}/matrix/ HTTP/1.1 
Host: pfapi.pstpf.com.au 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"PermissionId":"00000000-0000-0000-0000-000000000000","ObjectId":"00000000-0000-0000-0000-000000000000"}

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

{"PermissionLevelValue":false,"PermissionsMatrix":[{"PermissionValueId":"00000000000000000000000000000000","ObjectId":"00000000-0000-0000-0000-000000000000","ObjectName":"String","ObjectGroup":"String","ContactsAffected":0,"PermissionValue":false}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}