ClubManager.Api

FindUser

**Requires Authentication**
Required role:	API

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

namespace ClubManager.Api.Services.Query

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type UserInstance() = 
        member val UserId:Int32 = new Int32() with get,set
        member val UserName:String = null with get,set
        member val Name:String = null with get,set
        member val Email:String = null with get,set
        member val MobilePhone:String = null with get,set
        member val Enabled:Boolean = new Boolean() with get,set
        member val LastLogin:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Created:DateTime = new DateTime() with get,set
        member val Training:Boolean = new Boolean() with get,set
        member val Deleted:Boolean = new Boolean() with get,set
        member val CoursesCompleted:Int32 = new Int32() with get,set
        member val DisplayHomeNotification:Nullable<Boolean> = new Nullable<Boolean>() with get,set
        member val TwoFactorEnabled:Boolean = new Boolean() with get,set
        member val EmailConfirmed:Boolean = new Boolean() with get,set
        member val MobilePhoneConfirmed:Boolean = new Boolean() with get,set
        member val Notifications:Boolean = new Boolean() with get,set
        member val ChangePassword:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Activated:Nullable<DateTime> = new Nullable<DateTime>() with get,set

    [<AutoQueryViewer(Description="", IconUrl="octicon:database", Title="User")>]
    [<AllowNullLiteral>]
    type FindUser() = 
        inherit QueryDb<UserInstance>()

    [<DataContract>]
    [<AllowNullLiteral>]
    type QueryBase() = 
        [<DataMember(Order=1)>]
        member val Skip:Nullable<Int32> = new Nullable<Int32>() with get,set

        [<DataMember(Order=2)>]
        member val Take:Nullable<Int32> = new Nullable<Int32>() with get,set

        [<DataMember(Order=3)>]
        member val OrderBy:String = null with get,set

        [<DataMember(Order=4)>]
        member val OrderByDesc:String = null with get,set

        [<DataMember(Order=5)>]
        member val Include:String = null with get,set

        [<DataMember(Order=6)>]
        member val Fields:String = null with get,set

        [<DataMember(Order=7)>]
        member val Meta:Dictionary<String, String> = new Dictionary<String, String>() with get,set

    [<AllowNullLiteral>]
    type QueryDb<'T>() = 
        inherit QueryBase()

    [<DataContract>]
    [<AllowNullLiteral>]
    type QueryResponse<'T>() = 
        [<DataMember(Order=1)>]
        member val Offset:Int32 = new Int32() with get,set

        [<DataMember(Order=2)>]
        member val Total:Int32 = new Int32() with get,set

        [<DataMember(Order=3)>]
        member val Results:ResizeArray<'T> = new ResizeArray<'T>() with get,set

        [<DataMember(Order=4)>]
        member val Meta:Dictionary<String, String> = new Dictionary<String, String>() with get,set

        [<DataMember(Order=5)>]
        member val ResponseStatus:ResponseStatus = null with get,set

F# 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
		}
	}
}