ClubManager.Api

FindUser

**Requires Authentication**
Required role:	API

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

import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


@AutoQueryViewer(Description="", IconUrl="octicon:database", Title="User")
open class FindUser : QueryDb<UserInstance>()
{
}

open class QueryDb<T> : QueryBase()
{
}

@DataContract
open class QueryBase
{
    @DataMember(Order=1)
    var Skip:Int? = null

    @DataMember(Order=2)
    var Take:Int? = null

    @DataMember(Order=3)
    var OrderBy:String? = null

    @DataMember(Order=4)
    var OrderByDesc:String? = null

    @DataMember(Order=5)
    var Include:String? = null

    @DataMember(Order=6)
    var Fields:String? = null

    @DataMember(Order=7)
    var Meta:HashMap<String,String> = HashMap<String,String>()
}

open class UserInstance
{
    var UserId:Int? = null
    var UserName:String? = null
    var Name:String? = null
    var Email:String? = null
    var MobilePhone:String? = null
    var Enabled:Boolean? = null
    var LastLogin:Date? = null
    var Created:Date? = null
    var Training:Boolean? = null
    var Deleted:Boolean? = null
    var CoursesCompleted:Int? = null
    var DisplayHomeNotification:Boolean? = null
    var TwoFactorEnabled:Boolean? = null
    var EmailConfirmed:Boolean? = null
    var MobilePhoneConfirmed:Boolean? = null
    var Notifications:Boolean? = null
    var ChangePassword:Date? = null
    var Activated:Date? = null
}

@DataContract
open class QueryResponse<T>
{
    @DataMember(Order=1)
    var Offset:Int? = null

    @DataMember(Order=2)
    var Total:Int? = null

    @DataMember(Order=3)
    var Results:ArrayList<T> = ArrayList<T>()

    @DataMember(Order=4)
    var Meta:HashMap<String,String> = HashMap<String,String>()

    @DataMember(Order=5)
    var ResponseStatus:ResponseStatus? = null
}

Kotlin 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
		}
	}
}