Platform API

<back to all web services

GetPermissionTree

Get a list of grouped permissions for an appliance.

Requires Authentication
The following routes are available for this service:
All Verbs/api/permissions/
import 'package:servicestack/servicestack.dart';

// @ApiResponse(Description="Returns Permission information in its grouped structure.")
class GetPermissionTreeResponse implements IConvertible
{
    String? Permissions;
    ResponseStatus? ResponseStatus;

    GetPermissionTreeResponse({this.Permissions,this.ResponseStatus});
    GetPermissionTreeResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

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

/**
* Get a list of grouped permissions for an appliance.
*/
// @Api(Description="Get a list of grouped permissions for an appliance.")
class GetPermissionTree implements IConvertible
{
    /**
    * Appliance Id to retrieve permissions for. If not supplied the current appliance id will be used.
    */
    // @ApiMember(DataType="Guid", Description="Appliance Id to retrieve permissions for. If not supplied the current appliance id will be used.", Name="ApplianceId")
    String? ApplianceId;

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

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

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

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

TypeContext _ctx = TypeContext(library: 'pfapi.pstpf.com.au', types: <String, TypeInfo> {
    'GetPermissionTreeResponse': TypeInfo(TypeOf.Class, create:() => GetPermissionTreeResponse()),
    'GetPermissionTree': TypeInfo(TypeOf.Class, create:() => GetPermissionTree()),
});

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

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

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

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