ClubManager.Api

FindUser

**Requires Authentication**
Required role:	API

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


// @DataContract
export class QueryBase
{
    // @DataMember(Order=1)
    public Skip?: number;

    // @DataMember(Order=2)
    public Take?: number;

    // @DataMember(Order=3)
    public OrderBy?: string;

    // @DataMember(Order=4)
    public OrderByDesc?: string;

    // @DataMember(Order=5)
    public Include?: string;

    // @DataMember(Order=6)
    public Fields?: string;

    // @DataMember(Order=7)
    public Meta?: { [index: string]: string; };

    public constructor(init?: Partial<QueryBase>) { (Object as any).assign(this, init); }
}

export class QueryDb<T> extends QueryBase
{

    public constructor(init?: Partial<QueryDb<T>>) { super(init); (Object as any).assign(this, init); }
}

export class UserInstance
{
    public UserId?: number;
    public UserName?: string;
    public Name?: string;
    public Email?: string;
    public MobilePhone?: string;
    public Enabled?: boolean;
    public LastLogin?: string;
    public Created?: string;
    public Training?: boolean;
    public Deleted?: boolean;
    public CoursesCompleted?: number;
    public DisplayHomeNotification?: boolean;
    public TwoFactorEnabled?: boolean;
    public EmailConfirmed?: boolean;
    public MobilePhoneConfirmed?: boolean;
    public Notifications?: boolean;
    public ChangePassword?: string;
    public Activated?: string;

    public constructor(init?: Partial<UserInstance>) { (Object as any).assign(this, init); }
}

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

    public constructor(init?: Partial<FindUser>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract
export class QueryResponse<T>
{
    // @DataMember(Order=1)
    public Offset?: number;

    // @DataMember(Order=2)
    public Total?: number;

    // @DataMember(Order=3)
    public Results?: T[];

    // @DataMember(Order=4)
    public Meta?: { [index: string]: string; };

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

    public constructor(init?: Partial<QueryResponse<T>>) { (Object as any).assign(this, init); }
}

TypeScript FindUser DTOs

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

HTTP + CSV

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/csv
Content-Type: text/csv
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/csv
Content-Length: length

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