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 Foundation
import ServiceStack

/**
* Get a list of grouped permissions for an appliance.
*/
// @Api(Description="Get a list of grouped permissions for an appliance.")
public class GetPermissionTree : Codable
{
    /**
    * 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")
    public var applianceId:String

    required public init(){}
}

// @ApiResponse(Description="Returns Permission information in its grouped structure.")
public class GetPermissionTreeResponse : Codable
{
    public var permissions:String
    public var responseStatus:ResponseStatus

    required public init(){}
}


Swift 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
		}
	}
}