| All Verbs | /api/permissions/ |
|---|
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;
public class dtos
{
/**
* Get a list of grouped permissions for an appliance.
*/
@Api(Description="Get a list of grouped permissions for an appliance.")
public static 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")
public UUID ApplianceId = null;
public UUID getApplianceId() { return ApplianceId; }
public GetPermissionTree setApplianceId(UUID value) { this.ApplianceId = value; return this; }
}
@ApiResponse(Description="Returns Permission information in its grouped structure.")
public static class GetPermissionTreeResponse
{
public String Permissions = null;
public ResponseStatus ResponseStatus = null;
public String getPermissions() { return Permissions; }
public GetPermissionTreeResponse setPermissions(String value) { this.Permissions = value; return this; }
public ResponseStatus getResponseStatus() { return ResponseStatus; }
public GetPermissionTreeResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
}
}
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
}
}
}