ClubManager.Api

FindUser

**Requires Authentication**
Required role:	API

The following routes are available for this service:
All Verbs	/api/Query/User

import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

// @DataContract
abstract class QueryBase
{
    // @DataMember(Order=1)
    int? Skip;

    // @DataMember(Order=2)
    int? Take;

    // @DataMember(Order=3)
    String? OrderBy;

    // @DataMember(Order=4)
    String? OrderByDesc;

    // @DataMember(Order=5)
    String? Include;

    // @DataMember(Order=6)
    String? Fields;

    // @DataMember(Order=7)
    Map<String,String?>? Meta;

    QueryBase({this.Skip,this.Take,this.OrderBy,this.OrderByDesc,this.Include,this.Fields,this.Meta});
    QueryBase.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Skip = json['Skip'];
        Take = json['Take'];
        OrderBy = json['OrderBy'];
        OrderByDesc = json['OrderByDesc'];
        Include = json['Include'];
        Fields = json['Fields'];
        Meta = JsonConverters.toStringMap(json['Meta']);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Skip': Skip,
        'Take': Take,
        'OrderBy': OrderBy,
        'OrderByDesc': OrderByDesc,
        'Include': Include,
        'Fields': Fields,
        'Meta': Meta
    };

    getTypeName() => "QueryBase";
    TypeContext? context = _ctx;
}

abstract class QueryDb<T> extends QueryBase
{
    QueryDb();
    QueryDb.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() => "QueryDb<$T>";
    TypeContext? context = _ctx;
}

class UserInstance implements IConvertible
{
    int? UserId;
    String? UserName;
    String? Name;
    String? Email;
    String? MobilePhone;
    bool? Enabled;
    DateTime? LastLogin;
    DateTime? Created;
    bool? Training;
    bool? Deleted;
    int? CoursesCompleted;
    bool? DisplayHomeNotification;
    bool? TwoFactorEnabled;
    bool? EmailConfirmed;
    bool? MobilePhoneConfirmed;
    bool? Notifications;
    DateTime? ChangePassword;
    DateTime? Activated;

    UserInstance({this.UserId,this.UserName,this.Name,this.Email,this.MobilePhone,this.Enabled,this.LastLogin,this.Created,this.Training,this.Deleted,this.CoursesCompleted,this.DisplayHomeNotification,this.TwoFactorEnabled,this.EmailConfirmed,this.MobilePhoneConfirmed,this.Notifications,this.ChangePassword,this.Activated});
    UserInstance.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        UserId = json['UserId'];
        UserName = json['UserName'];
        Name = json['Name'];
        Email = json['Email'];
        MobilePhone = json['MobilePhone'];
        Enabled = json['Enabled'];
        LastLogin = JsonConverters.fromJson(json['LastLogin'],'DateTime',context!);
        Created = JsonConverters.fromJson(json['Created'],'DateTime',context!);
        Training = json['Training'];
        Deleted = json['Deleted'];
        CoursesCompleted = json['CoursesCompleted'];
        DisplayHomeNotification = json['DisplayHomeNotification'];
        TwoFactorEnabled = json['TwoFactorEnabled'];
        EmailConfirmed = json['EmailConfirmed'];
        MobilePhoneConfirmed = json['MobilePhoneConfirmed'];
        Notifications = json['Notifications'];
        ChangePassword = JsonConverters.fromJson(json['ChangePassword'],'DateTime',context!);
        Activated = JsonConverters.fromJson(json['Activated'],'DateTime',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'UserId': UserId,
        'UserName': UserName,
        'Name': Name,
        'Email': Email,
        'MobilePhone': MobilePhone,
        'Enabled': Enabled,
        'LastLogin': JsonConverters.toJson(LastLogin,'DateTime',context!),
        'Created': JsonConverters.toJson(Created,'DateTime',context!),
        'Training': Training,
        'Deleted': Deleted,
        'CoursesCompleted': CoursesCompleted,
        'DisplayHomeNotification': DisplayHomeNotification,
        'TwoFactorEnabled': TwoFactorEnabled,
        'EmailConfirmed': EmailConfirmed,
        'MobilePhoneConfirmed': MobilePhoneConfirmed,
        'Notifications': Notifications,
        'ChangePassword': JsonConverters.toJson(ChangePassword,'DateTime',context!),
        'Activated': JsonConverters.toJson(Activated,'DateTime',context!)
    };

    getTypeName() => "UserInstance";
    TypeContext? context = _ctx;
}

// @AutoQueryViewer(Description="", IconUrl="octicon:database", Title="User")
class FindUser extends QueryDb<UserInstance> implements IConvertible
{
    FindUser();
    FindUser.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() => "FindUser";
    TypeContext? context = _ctx;
}

// @DataContract
class QueryResponse<T> implements IConvertible
{
    // @DataMember(Order=1)
    int? Offset;

    // @DataMember(Order=2)
    int? Total;

    // @DataMember(Order=3)
    List<T>? Results;

    // @DataMember(Order=4)
    Map<String,String?>? Meta;

    // @DataMember(Order=5)
    ResponseStatus? ResponseStatus;

    QueryResponse({this.Offset,this.Total,this.Results,this.Meta,this.ResponseStatus});
    QueryResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Offset = json['Offset'];
        Total = json['Total'];
        Results = JsonConverters.fromJson(json['Results'],'List<${runtimeGenericTypeDefs(this,[0]).join(",")}>',context!);
        Meta = JsonConverters.toStringMap(json['Meta']);
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Offset': Offset,
        'Total': Total,
        'Results': JsonConverters.toJson(Results,'List<T>',context!),
        'Meta': Meta,
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "QueryResponse<$T>";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'api.clubmanagercentral.com', types: <String, TypeInfo> {
    'UserInstance': TypeInfo(TypeOf.Class, create:() => UserInstance()),
    'FindUser': TypeInfo(TypeOf.Class, create:() => FindUser()),
    'List<UserInstance>': TypeInfo(TypeOf.Class, create:() => <UserInstance>[]),
});

Dart FindUser DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/Query/User HTTP/1.1 
Host: api.clubmanagercentral.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Skip: 0,
	Take: 0,
	OrderBy: String,
	OrderByDesc: String,
	Include: String,
	Fields: String,
	Meta: 
	{
		String: String
	}
}

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

{
	Offset: 0,
	Total: 0,
	Results: 
	[
		{
			UserId: 0,
			UserName: String,
			Name: String,
			Email: String,
			MobilePhone: String,
			Enabled: False,
			LastLogin: 0001-01-01,
			Created: 0001-01-01,
			Training: False,
			Deleted: False,
			CoursesCompleted: 0,
			DisplayHomeNotification: False,
			TwoFactorEnabled: False,
			EmailConfirmed: False,
			MobilePhoneConfirmed: False,
			Notifications: False,
			ChangePassword: 0001-01-01,
			Activated: 0001-01-01
		}
	],
	Meta: 
	{
		String: String
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}