ClubReady Api

UserFindByLoginRequest

The following routes are available for this service:
GET	/users/find/login-details	Verify a user's login details.


export class ApiDtoBase implements IApiDtoBase
{
    public ApiKey?: string;
    public StoreId?: number;
    public ChainId?: number;

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

export class UserFindByLoginRequestDto extends ApiDtoBase
{
    public UserId: number;
    public UserName: string;
    public Password: string;

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

export enum RestrictedResourceType
{
    Store = 'Store',
    Chain = 'Chain',
    User = 'User',
    Undefined = 'Undefined',
}

export class UserFindByLoginRequest extends UserFindByLoginRequestDto implements IRestrictedApiRequest
{
    /**
    * IP address of the end user
    */
    // @ApiMember(Description="IP address of the end user", Name="X-Forwarded-For", ParameterType="header")
    public XForwardedFor: string;

    /**
    * Api Key - grants access to resources
    */
    // @ApiMember(DataType="string", Description="Api Key - grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")
    public ApiKey: string;

    /**
    * ClubReady Club ID (StoreID internally)
    */
    // @ApiMember(DataType="integer", Description="ClubReady Club ID (StoreID internally)", Name="StoreId", ParameterType="query")
    public StoreId?: number;

    /**
    * StoreId OR ChainId is required
    */
    // @ApiMember(DataType="integer", Description="StoreId OR ChainId is required", Name="ChainId", ParameterType="query")
    public ChainId?: number;

    /**
    * ClubReady username
    */
    // @ApiMember(DataType="string", Description="ClubReady username", IsRequired=true, Name="UserName", ParameterType="query")
    public UserName: string;

    /**
    * ClubReady password
    */
    // @ApiMember(DataType="string", Description="ClubReady password", IsRequired=true, Name="Password", ParameterType="query")
    public Password: string;

    public RestrictedId?: number;
    public RestrictedResourceType: RestrictedResourceType;

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

export class ApiResponseBase
{
    public Success: boolean;
    public Message?: string;

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

export class UserFindByLoginResponseDto extends ApiResponseBase
{
    public HomeStoreId?: number;
    public UserId: number;

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

export class UserFindByLoginResponse extends UserFindByLoginResponseDto
{
    public HomeStoreId?: number;
    public UserId: number;

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

TypeScript UserFindByLoginRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET /users/find/login-details HTTP/1.1 
Host: clubready.com 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"HomeStoreId":0,"UserId":0,"Success":false,"Message":"String"}