| GET | /users/all |
|---|
import 'package:servicestack/servicestack.dart';
abstract class GetOperationUnTenanted<TResponse> implements IHasGetOptions, IGet
{
String? embed;
GetOperationUnTenanted({this.embed});
GetOperationUnTenanted.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
embed = json['embed'];
return this;
}
Map<String, dynamic> toJson() => {
'embed': embed
};
getTypeName() => "GetOperationUnTenanted<$TResponse>";
TypeContext? context = _ctx;
}
abstract class SearchOperationUnTenanted<TResponse> extends GetOperationUnTenanted<TResponse> implements IHasSearchOptions
{
String? distinct;
int? limit;
int? offset;
String? sort;
String? filter;
SearchOperationUnTenanted({this.distinct,this.limit,this.offset,this.sort,this.filter});
SearchOperationUnTenanted.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
distinct = json['distinct'];
limit = json['limit'];
offset = json['offset'];
sort = json['sort'];
filter = json['filter'];
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'distinct': distinct,
'limit': limit,
'offset': offset,
'sort': sort,
'filter': filter
});
getTypeName() => "SearchOperationUnTenanted<$TResponse>";
TypeContext? context = _ctx;
}
abstract class SearchOperationTenanted<TResponse> extends SearchOperationUnTenanted<TResponse> implements ITenantedRequest
{
String? organisationId;
SearchOperationTenanted({this.organisationId});
SearchOperationTenanted.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
organisationId = json['organisationId'];
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'organisationId': organisationId
});
getTypeName() => "SearchOperationTenanted<$TResponse>";
TypeContext? context = _ctx;
}
enum AccountStatus
{
Shadowed,
Registered,
}
enum AccountType
{
Person,
Machine,
}
class UserAccountMembership implements IIdentifiableResource, IConvertible
{
String? userId;
String? userEmailAddress;
AccountStatus? status;
AccountType? type;
List<String>? roles;
String? id;
String? organisationId;
UserAccountMembership({this.userId,this.userEmailAddress,this.status,this.type,this.roles,this.id,this.organisationId});
UserAccountMembership.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
userId = json['userId'];
userEmailAddress = json['userEmailAddress'];
status = JsonConverters.fromJson(json['status'],'AccountStatus',context!);
type = JsonConverters.fromJson(json['type'],'AccountType',context!);
roles = JsonConverters.fromJson(json['roles'],'List<String>',context!);
id = json['id'];
organisationId = json['organisationId'];
return this;
}
Map<String, dynamic> toJson() => {
'userId': userId,
'userEmailAddress': userEmailAddress,
'status': JsonConverters.toJson(status,'AccountStatus',context!),
'type': JsonConverters.toJson(type,'AccountType',context!),
'roles': JsonConverters.toJson(roles,'List<String>',context!),
'id': id,
'organisationId': organisationId
};
getTypeName() => "UserAccountMembership";
TypeContext? context = _ctx;
}
class UserDetails extends UserAccountMembership implements IConvertible
{
DateTime? lastLoginDate;
bool? twoFactorEnabled;
String? name;
UserDetails({this.lastLoginDate,this.twoFactorEnabled,this.name});
UserDetails.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
lastLoginDate = JsonConverters.fromJson(json['lastLoginDate'],'DateTime',context!);
twoFactorEnabled = json['twoFactorEnabled'];
name = json['name'];
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'lastLoginDate': JsonConverters.toJson(lastLoginDate,'DateTime',context!),
'twoFactorEnabled': twoFactorEnabled,
'name': name
});
getTypeName() => "UserDetails";
TypeContext? context = _ctx;
}
class SearchAllUsersResponse implements IConvertible
{
ResponseStatus? responseStatus;
List<UserDetails>? userDetails;
SearchAllUsersResponse({this.responseStatus,this.userDetails});
SearchAllUsersResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
userDetails = JsonConverters.fromJson(json['userDetails'],'List<UserDetails>',context!);
return this;
}
Map<String, dynamic> toJson() => {
'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
'userDetails': JsonConverters.toJson(userDetails,'List<UserDetails>',context!)
};
getTypeName() => "SearchAllUsersResponse";
TypeContext? context = _ctx;
}
class SearchAllUsersRequest extends SearchOperationTenanted<SearchAllUsersResponse> implements IConvertible
{
SearchAllUsersRequest();
SearchAllUsersRequest.fromJson(Map<String, dynamic> json) : super.fromJson(json);
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
return this;
}
Map<String, dynamic> toJson() => super.toJson();
getTypeName() => "SearchAllUsersRequest";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'foundrystage_api_app.azurewebsites.net', types: <String, TypeInfo> {
'GetOperationUnTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
'SearchOperationUnTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
'SearchOperationTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
'AccountStatus': TypeInfo(TypeOf.Enum, enumValues:AccountStatus.values),
'AccountType': TypeInfo(TypeOf.Enum, enumValues:AccountType.values),
'UserAccountMembership': TypeInfo(TypeOf.Class, create:() => UserAccountMembership()),
'UserDetails': TypeInfo(TypeOf.Class, create:() => UserDetails()),
'SearchAllUsersResponse': TypeInfo(TypeOf.Class, create:() => SearchAllUsersResponse()),
'List<UserDetails>': TypeInfo(TypeOf.Class, create:() => <UserDetails>[]),
'SearchAllUsersRequest': TypeInfo(TypeOf.Class, create:() => SearchAllUsersRequest()),
});
Dart SearchAllUsersRequest 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.
GET /users/all HTTP/1.1 Host: foundrystage-api-app.azurewebsites.net Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<SearchAllUsersResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.UserAccounts">
<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>
<UserDetails xmlns:d2p1="http://schemas.datacontract.org/2004/07/Application.Interfaces.Resources">
<d2p1:UserDetails>
<d2p1:Id>String</d2p1:Id>
<d2p1:OrganisationId>String</d2p1:OrganisationId>
<d2p1:Roles xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>String</d4p1:string>
</d2p1:Roles>
<d2p1:Status>Shadowed</d2p1:Status>
<d2p1:Type>Person</d2p1:Type>
<d2p1:UserEmailAddress>String</d2p1:UserEmailAddress>
<d2p1:UserId>String</d2p1:UserId>
<d2p1:LastLoginDate>0001-01-01T00:00:00</d2p1:LastLoginDate>
<d2p1:Name>String</d2p1:Name>
<d2p1:TwoFactorEnabled>false</d2p1:TwoFactorEnabled>
</d2p1:UserDetails>
</UserDetails>
</SearchAllUsersResponse>