Foundry API

<back to all web services

SearchAllUsersRequest

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

GET /users/all HTTP/1.1 
Host: foundrystage-api-app.azurewebsites.net 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	},
	userDetails: 
	[
		{
			lastLoginDate: ,
			twoFactorEnabled: False,
			name: String,
			userId: String,
			userEmailAddress: String,
			status: Shadowed,
			type: Person,
			roles: 
			[
				String
			],
			id: String,
			organisationId: String
		}
	]
}