ClubManager.Api

<back to all web services

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.*;

public class dtos
{

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

    public static class QueryDb<T> extends QueryBase
    {
        
    }

    @DataContract
    public static class QueryBase
    {
        @DataMember(Order=1)
        public Integer Skip = null;

        @DataMember(Order=2)
        public Integer Take = null;

        @DataMember(Order=3)
        public String OrderBy = null;

        @DataMember(Order=4)
        public String OrderByDesc = null;

        @DataMember(Order=5)
        public String Include = null;

        @DataMember(Order=6)
        public String Fields = null;

        @DataMember(Order=7)
        public HashMap<String,String> Meta = null;
        
        public Integer getSkip() { return Skip; }
        public QueryBase setSkip(Integer value) { this.Skip = value; return this; }
        public Integer getTake() { return Take; }
        public QueryBase setTake(Integer value) { this.Take = value; return this; }
        public String getOrderBy() { return OrderBy; }
        public QueryBase setOrderBy(String value) { this.OrderBy = value; return this; }
        public String getOrderByDesc() { return OrderByDesc; }
        public QueryBase setOrderByDesc(String value) { this.OrderByDesc = value; return this; }
        public String getInclude() { return Include; }
        public QueryBase setInclude(String value) { this.Include = value; return this; }
        public String getFields() { return Fields; }
        public QueryBase setFields(String value) { this.Fields = value; return this; }
        public HashMap<String,String> getMeta() { return Meta; }
        public QueryBase setMeta(HashMap<String,String> value) { this.Meta = value; return this; }
    }

    public static class UserInstance
    {
        public Integer UserId = null;
        public String UserName = null;
        public String Name = null;
        public String Email = null;
        public String MobilePhone = null;
        public Boolean Enabled = null;
        public Date LastLogin = null;
        public Date Created = null;
        public Boolean Training = null;
        public Boolean Deleted = null;
        public Integer CoursesCompleted = null;
        public Boolean DisplayHomeNotification = null;
        public Boolean TwoFactorEnabled = null;
        public Boolean EmailConfirmed = null;
        public Boolean MobilePhoneConfirmed = null;
        public Boolean Notifications = null;
        public Date ChangePassword = null;
        public Date Activated = null;
        
        public Integer getUserId() { return UserId; }
        public UserInstance setUserId(Integer value) { this.UserId = value; return this; }
        public String getUserName() { return UserName; }
        public UserInstance setUserName(String value) { this.UserName = value; return this; }
        public String getName() { return Name; }
        public UserInstance setName(String value) { this.Name = value; return this; }
        public String getEmail() { return Email; }
        public UserInstance setEmail(String value) { this.Email = value; return this; }
        public String getMobilePhone() { return MobilePhone; }
        public UserInstance setMobilePhone(String value) { this.MobilePhone = value; return this; }
        public Boolean isEnabled() { return Enabled; }
        public UserInstance setEnabled(Boolean value) { this.Enabled = value; return this; }
        public Date getLastLogin() { return LastLogin; }
        public UserInstance setLastLogin(Date value) { this.LastLogin = value; return this; }
        public Date getCreated() { return Created; }
        public UserInstance setCreated(Date value) { this.Created = value; return this; }
        public Boolean isTraining() { return Training; }
        public UserInstance setTraining(Boolean value) { this.Training = value; return this; }
        public Boolean isDeleted() { return Deleted; }
        public UserInstance setDeleted(Boolean value) { this.Deleted = value; return this; }
        public Integer getCoursesCompleted() { return CoursesCompleted; }
        public UserInstance setCoursesCompleted(Integer value) { this.CoursesCompleted = value; return this; }
        public Boolean isDisplayHomeNotification() { return DisplayHomeNotification; }
        public UserInstance setDisplayHomeNotification(Boolean value) { this.DisplayHomeNotification = value; return this; }
        public Boolean isTwoFactorEnabled() { return TwoFactorEnabled; }
        public UserInstance setTwoFactorEnabled(Boolean value) { this.TwoFactorEnabled = value; return this; }
        public Boolean isEmailConfirmed() { return EmailConfirmed; }
        public UserInstance setEmailConfirmed(Boolean value) { this.EmailConfirmed = value; return this; }
        public Boolean isMobilePhoneConfirmed() { return MobilePhoneConfirmed; }
        public UserInstance setMobilePhoneConfirmed(Boolean value) { this.MobilePhoneConfirmed = value; return this; }
        public Boolean isNotifications() { return Notifications; }
        public UserInstance setNotifications(Boolean value) { this.Notifications = value; return this; }
        public Date getChangePassword() { return ChangePassword; }
        public UserInstance setChangePassword(Date value) { this.ChangePassword = value; return this; }
        public Date getActivated() { return Activated; }
        public UserInstance setActivated(Date value) { this.Activated = value; return this; }
    }

    @DataContract
    public static class QueryResponse<T>
    {
        @DataMember(Order=1)
        public Integer Offset = null;

        @DataMember(Order=2)
        public Integer Total = null;

        @DataMember(Order=3)
        public ArrayList<T> Results = null;

        @DataMember(Order=4)
        public HashMap<String,String> Meta = null;

        @DataMember(Order=5)
        public ResponseStatus ResponseStatus = null;
        
        public Integer getOffset() { return Offset; }
        public QueryResponse<T> setOffset(Integer value) { this.Offset = value; return this; }
        public Integer getTotal() { return Total; }
        public QueryResponse<T> setTotal(Integer value) { this.Total = value; return this; }
        public ArrayList<T> getResults() { return Results; }
        public QueryResponse<T> setResults(ArrayList<T> value) { this.Results = value; return this; }
        public HashMap<String,String> getMeta() { return Meta; }
        public QueryResponse<T> setMeta(HashMap<String,String> value) { this.Meta = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public QueryResponse<T> setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

}

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