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/
namespace Eros.Subtle.Canvara.WebAPIModel.ServiceModel

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<ApiResponse(Description="Returns Permission information in its grouped structure.")>]
    [<AllowNullLiteral>]
    type GetPermissionTreeResponse() = 
        member val Permissions:String = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    ///<summary>
    ///Get a list of grouped permissions for an appliance.
    ///</summary>
    [<Api(Description="Get a list of grouped permissions for an appliance.")>]
    [<AllowNullLiteral>]
    type 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")>]
        member val ApplianceId:Guid = new Guid() with get,set

F# GetPermissionTree DTOs

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

HTTP + CSV

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/csv
Content-Type: text/csv
Content-Length: length

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