GET | /users/find/login-details | Verify a user's login details. |
---|
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using ClubReady.Web.Api.Members.Model;
using ClubReady.Core.Api.Models;
using ClubReady.Web.Api;
namespace ClubReady.Core.Api.Models
{
public partial class ApiDtoBase
{
public virtual string ApiKey { get; set; }
public virtual int? StoreId { get; set; }
public virtual int? ChainId { get; set; }
}
public partial class ApiResponseBase
{
public virtual bool Success { get; set; }
public virtual string Message { get; set; }
}
public partial class UserFindByLoginRequestDto
: ApiDtoBase
{
public virtual int UserId { get; set; }
public virtual string UserName { get; set; }
public virtual string Password { get; set; }
}
public partial class UserFindByLoginResponseDto
: ApiResponseBase
{
public virtual int? HomeStoreId { get; set; }
public virtual int UserId { get; set; }
}
}
namespace ClubReady.Web.Api
{
public enum RestrictedResourceType
{
Store,
Chain,
User,
Undefined,
}
}
namespace ClubReady.Web.Api.Members.Model
{
public partial class UserFindByLoginRequest
: UserFindByLoginRequestDto, IRestrictedApiRequest
{
///<summary>
///Api Key - grants access to resources
///</summary>
[ApiMember(DataType="string", Description="Api Key - grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")]
public virtual string ApiKey { get; set; }
///<summary>
///ClubReady Club ID (StoreID internally)
///</summary>
[ApiMember(DataType="integer", Description="ClubReady Club ID (StoreID internally)", Name="StoreId", ParameterType="query")]
public virtual int? StoreId { get; set; }
///<summary>
///StoreId OR ChainId is required
///</summary>
[ApiMember(DataType="integer", Description="StoreId OR ChainId is required", Name="ChainId", ParameterType="query")]
public virtual int? ChainId { get; set; }
///<summary>
///ClubReady username
///</summary>
[ApiMember(DataType="string", Description="ClubReady username", IsRequired=true, Name="UserName", ParameterType="query")]
public virtual string UserName { get; set; }
///<summary>
///ClubReady password
///</summary>
[ApiMember(DataType="string", Description="ClubReady password", IsRequired=true, Name="Password", ParameterType="query")]
public virtual string Password { get; set; }
public virtual int? RestrictedId { get; set; }
public virtual RestrictedResourceType RestrictedResourceType { get; set; }
}
public partial class UserFindByLoginResponse
: UserFindByLoginResponseDto
{
public virtual int? HomeStoreId { get; set; }
public virtual int UserId { get; set; }
}
}
C# UserFindByLoginRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: text/jsv
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { HomeStoreId: 0, UserId: 0, Success: False, Message: String }