| All Verbs | /api/roles/{RoleId}/associatedroles/safetystaff | ||
|---|---|---|---|
| All Verbs | /api/roles/{RoleId}/associatedroles/organisation |
import 'package:servicestack/servicestack.dart';
class RoleModel implements IConvertible
{
/**
* Role Id
*/
// @ApiMember(DataType="Guid", Description="Role Id", IsRequired=true, Name="RoleId")
String? RoleId;
/**
* Role Name
*/
// @ApiMember(DataType="string", Description="Role Name", Name="RoleName")
String? RoleName;
/**
* Is the role a licensee role?
*/
// @ApiMember(DataType="bool", Description="Is the role a licensee role?", Name="IsLicensee")
bool? IsLicenseeRole;
/**
* Is manage contacts role?
*/
// @ApiMember(DataType="bool", Description="Is manage contacts role?", Name="IsManageContacts")
bool? IsManageContacts;
/**
* Is the role a Platform role?
*/
// @ApiMember(DataType="bool", Description="Is the role a Platform role?", Name="IsPlatformRole")
bool? IsPlatformRole;
/**
* Is the role a services role?
*/
// @ApiMember(DataType="bool", Description="Is the role a services role?", Name="IsServiceRole")
bool? IsServiceRole;
/**
* Is the role a customer role?
*/
// @ApiMember(DataType="bool", Description="Is the role a customer role?", Name="IsCustomerRole")
bool? IsCustomerRole;
/**
* Is the role a functional role?
*/
// @ApiMember(DataType="bool", Description="Is the role a functional role?", Name="IsFunctionalRole")
bool? IsFunctionalRole;
/**
* Is the role an auto-accept role?
*/
// @ApiMember(DataType="bool", Description="Is the role an auto-accept role?", Name="IsRequestAutoAccepted")
bool? IsRequestAutoAccepted;
/**
* Suite that the role belongs to
*/
// @ApiMember(DataType="Guid", Description="Suite that the role belongs to", Name="SuiteId")
String? SuiteId;
/**
* Suite that the role belongs to
*/
// @ApiMember(DataType="string", Description="Suite that the role belongs to", Name="SuiteName")
String? SuiteName;
/**
* 'A' (Active) or 'I' (Inactive)
*/
// @ApiMember(DataType="string", Description="'A' (Active) or 'I' (Inactive)", Name="RecordStatus")
String? RecordStatus;
/**
* Object Connection Id, which is populated when the roles are returned based on those that are connected to an object.
*/
// @ApiMember(DataType="Guid", Description="Object Connection Id, which is populated when the roles are returned based on those that are connected to an object.", Name="ObjectConnectionId")
String? ObjectConnectionId;
RoleModel({this.RoleId,this.RoleName,this.IsLicenseeRole,this.IsManageContacts,this.IsPlatformRole,this.IsServiceRole,this.IsCustomerRole,this.IsFunctionalRole,this.IsRequestAutoAccepted,this.SuiteId,this.SuiteName,this.RecordStatus,this.ObjectConnectionId});
RoleModel.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
RoleId = json['RoleId'];
RoleName = json['RoleName'];
IsLicenseeRole = json['IsLicenseeRole'];
IsManageContacts = json['IsManageContacts'];
IsPlatformRole = json['IsPlatformRole'];
IsServiceRole = json['IsServiceRole'];
IsCustomerRole = json['IsCustomerRole'];
IsFunctionalRole = json['IsFunctionalRole'];
IsRequestAutoAccepted = json['IsRequestAutoAccepted'];
SuiteId = json['SuiteId'];
SuiteName = json['SuiteName'];
RecordStatus = json['RecordStatus'];
ObjectConnectionId = json['ObjectConnectionId'];
return this;
}
Map<String, dynamic> toJson() => {
'RoleId': RoleId,
'RoleName': RoleName,
'IsLicenseeRole': IsLicenseeRole,
'IsManageContacts': IsManageContacts,
'IsPlatformRole': IsPlatformRole,
'IsServiceRole': IsServiceRole,
'IsCustomerRole': IsCustomerRole,
'IsFunctionalRole': IsFunctionalRole,
'IsRequestAutoAccepted': IsRequestAutoAccepted,
'SuiteId': SuiteId,
'SuiteName': SuiteName,
'RecordStatus': RecordStatus,
'ObjectConnectionId': ObjectConnectionId
};
getTypeName() => "RoleModel";
TypeContext? context = _ctx;
}
// @ApiResponse(Description="List of associated roles by contact type")
class GetAssociatedRolesForRoleResponse implements IConvertible
{
List<RoleModel>? Roles;
ResponseStatus? ResponseStatus;
GetAssociatedRolesForRoleResponse({this.Roles,this.ResponseStatus});
GetAssociatedRolesForRoleResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Roles = JsonConverters.fromJson(json['Roles'],'List<RoleModel>',context!);
ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
return this;
}
Map<String, dynamic> toJson() => {
'Roles': JsonConverters.toJson(Roles,'List<RoleModel>',context!),
'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
};
getTypeName() => "GetAssociatedRolesForRoleResponse";
TypeContext? context = _ctx;
}
/**
* Get associated roles for a specified role
*/
// @Api(Description="Get associated roles for a specified role")
class GetAssociatedRolesForRole implements IConvertible
{
/**
* The Role Guid. Records retrieved will belong to this role.
*/
// @ApiMember(DataType="Guid", Description="The Role Guid. Records retrieved will belong to this role.", IsRequired=true, Name="RoleId", ParameterType="query")
String? RoleId;
GetAssociatedRolesForRole({this.RoleId});
GetAssociatedRolesForRole.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
RoleId = json['RoleId'];
return this;
}
Map<String, dynamic> toJson() => {
'RoleId': RoleId
};
getTypeName() => "GetAssociatedRolesForRole";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'pfapi.pstpf.com.au', types: <String, TypeInfo> {
'RoleModel': TypeInfo(TypeOf.Class, create:() => RoleModel()),
'GetAssociatedRolesForRoleResponse': TypeInfo(TypeOf.Class, create:() => GetAssociatedRolesForRoleResponse()),
'List<RoleModel>': TypeInfo(TypeOf.Class, create:() => <RoleModel>[]),
'GetAssociatedRolesForRole': TypeInfo(TypeOf.Class, create:() => GetAssociatedRolesForRole()),
});
Dart GetAssociatedRolesForRole DTOs
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/roles/{RoleId}/associatedroles/safetystaff HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<GetAssociatedRolesForRole xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<RoleId>00000000-0000-0000-0000-000000000000</RoleId>
</GetAssociatedRolesForRole>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetAssociatedRolesForRoleResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eros.Subtle.Canvara.WebAPIModel.ServiceModel">
<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>
<Roles xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eros.Saguna.Common.WebAPIModel.Models">
<d2p1:RoleModel>
<d2p1:IsCustomerRole>false</d2p1:IsCustomerRole>
<d2p1:IsFunctionalRole>false</d2p1:IsFunctionalRole>
<d2p1:IsLicenseeRole>false</d2p1:IsLicenseeRole>
<d2p1:IsManageContacts>false</d2p1:IsManageContacts>
<d2p1:IsPlatformRole>false</d2p1:IsPlatformRole>
<d2p1:IsRequestAutoAccepted>false</d2p1:IsRequestAutoAccepted>
<d2p1:IsServiceRole>false</d2p1:IsServiceRole>
<d2p1:ObjectConnectionId>00000000-0000-0000-0000-000000000000</d2p1:ObjectConnectionId>
<d2p1:RecordStatus>String</d2p1:RecordStatus>
<d2p1:RoleId>00000000-0000-0000-0000-000000000000</d2p1:RoleId>
<d2p1:RoleName>String</d2p1:RoleName>
<d2p1:SuiteId>00000000-0000-0000-0000-000000000000</d2p1:SuiteId>
<d2p1:SuiteName>String</d2p1:SuiteName>
</d2p1:RoleModel>
</Roles>
</GetAssociatedRolesForRoleResponse>