| 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 .jsv suffix or ?format=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
}
}
}