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

Namespace Global

    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 Overridable Property ApplianceId As Guid
        End Class

        <ApiResponse(Description:="Returns Permission information in its grouped structure.")>
        Public Partial Class GetPermissionTreeResponse
            Public Overridable Property Permissions As String
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET 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"}}}