| All Verbs | /api/permissions/ |
|---|
import 'package:servicestack/servicestack.dart';
// @ApiResponse(Description="Returns Permission information in its grouped structure.")
class GetPermissionTreeResponse implements IConvertible
{
String? Permissions;
ResponseStatus? ResponseStatus;
GetPermissionTreeResponse({this.Permissions,this.ResponseStatus});
GetPermissionTreeResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Permissions = json['Permissions'];
ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
return this;
}
Map<String, dynamic> toJson() => {
'Permissions': Permissions,
'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
};
getTypeName() => "GetPermissionTreeResponse";
TypeContext? context = _ctx;
}
/**
* Get a list of grouped permissions for an appliance.
*/
// @Api(Description="Get a list of grouped permissions for an appliance.")
class GetPermissionTree implements IConvertible
{
/**
* 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")
String? ApplianceId;
GetPermissionTree({this.ApplianceId});
GetPermissionTree.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
ApplianceId = json['ApplianceId'];
return this;
}
Map<String, dynamic> toJson() => {
'ApplianceId': ApplianceId
};
getTypeName() => "GetPermissionTree";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'pfapi.pstpf.com.au', types: <String, TypeInfo> {
'GetPermissionTreeResponse': TypeInfo(TypeOf.Class, create:() => GetPermissionTreeResponse()),
'GetPermissionTree': TypeInfo(TypeOf.Class, create:() => GetPermissionTree()),
});
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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/xml
Content-Type: application/xml
Content-Length: length
<GetPermissionTree xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<ApplianceId>00000000-0000-0000-0000-000000000000</ApplianceId>
</GetPermissionTree>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetPermissionTreeResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<Permissions>String</Permissions>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
</GetPermissionTreeResponse>