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/
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Eros.Subtle.Canvara.WebAPIModel.ServiceModel;

namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel
{
    ///<summary>
    ///Get a list of grouped permissions for an appliance.
    ///</summary>
    [Api(Description="Get a list of grouped permissions for an appliance.")]
    public partial class GetPermissionTree
    {
        ///<summary>
        ///Appliance Id to retrieve permissions for. If not supplied the current appliance id will be used.
        ///</summary>
        [ApiMember(DataType="Guid", Description="Appliance Id to retrieve permissions for. If not supplied the current appliance id will be used.", Name="ApplianceId")]
        public virtual Guid ApplianceId { get; set; }
    }

    [ApiResponse(Description="Returns Permission information in its grouped structure.")]
    public partial class GetPermissionTreeResponse
    {
        public virtual string Permissions { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# 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
		}
	}
}