Platform API

GetPermissionTree

Get a list of grouped permissions for an appliance.

The following routes are available for this service:
All Verbs	/api/permissions/

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


/**
* Get a list of grouped permissions for an appliance.
*/
@Api(Description="Get a list of grouped permissions for an appliance.")
open class GetPermissionTree
{
    /**
    * 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")
    open var ApplianceId:UUID? = null
}

@ApiResponse(Description="Returns Permission information in its grouped structure.")
open class GetPermissionTreeResponse
{
    open var Permissions:String? = null
    open var ResponseStatus:ResponseStatus? = null
}

Kotlin 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"}}}