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/

// @ApiResponse(Description="Returns Permission information in its grouped structure.")
export class GetPermissionTreeResponse
{
    public Permissions: string;
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<GetPermissionTreeResponse>) { (Object as any).assign(this, init); }
}

/** @description Get a list of grouped permissions for an appliance. */
// @Api(Description="Get a list of grouped permissions for an appliance.")
export class GetPermissionTree
{
    /** @description 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 ApplianceId: string;

    public constructor(init?: Partial<GetPermissionTree>) { (Object as any).assign(this, init); }
}

TypeScript GetPermissionTree DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

{"ApplianceId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: application/json
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"}}}