| GET | /users/find/login-details | Verify a user's login details. |
|---|
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports ClubReady.Web.Api.Members.Model
Imports ClubReady.Core.Api.Models
Imports ClubReady.Web.Api
Namespace Global
Namespace ClubReady.Core.Api.Models
Public Partial Class ApiDtoBase
Public Overridable Property ApiKey As String
Public Overridable Property StoreId As Nullable(Of Integer)
Public Overridable Property ChainId As Nullable(Of Integer)
End Class
Public Partial Class ApiResponseBase
Public Overridable Property Success As Boolean
Public Overridable Property Message As String
End Class
Public Partial Class UserFindByLoginRequestDto
Inherits ApiDtoBase
Public Overridable Property UserId As Integer
Public Overridable Property UserName As String
Public Overridable Property Password As String
End Class
Public Partial Class UserFindByLoginResponseDto
Inherits ApiResponseBase
Public Overridable Property HomeStoreId As Nullable(Of Integer)
Public Overridable Property UserId As Integer
End Class
End Namespace
Namespace ClubReady.Web.Api
Public Enum RestrictedResourceType
Store
Chain
User
Undefined
End Enum
End Namespace
Namespace ClubReady.Web.Api.Members.Model
Public Partial Class UserFindByLoginRequest
Inherits UserFindByLoginRequestDto
Implements 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 Overridable Property ApiKey As String
'''<Summary>
'''ClubReady Club ID (StoreID internally)
'''</Summary>
<ApiMember(DataType:="integer", Description:="ClubReady Club ID (StoreID internally)", Name:="StoreId", ParameterType:="query")>
Public Overridable Property StoreId As Nullable(Of Integer)
'''<Summary>
'''StoreId OR ChainId is required
'''</Summary>
<ApiMember(DataType:="integer", Description:="StoreId OR ChainId is required", Name:="ChainId", ParameterType:="query")>
Public Overridable Property ChainId As Nullable(Of Integer)
'''<Summary>
'''ClubReady username
'''</Summary>
<ApiMember(DataType:="string", Description:="ClubReady username", IsRequired:=true, Name:="UserName", ParameterType:="query")>
Public Overridable Property UserName As String
'''<Summary>
'''ClubReady password
'''</Summary>
<ApiMember(DataType:="string", Description:="ClubReady password", IsRequired:=true, Name:="Password", ParameterType:="query")>
Public Overridable Property Password As String
Public Overridable Property RestrictedId As Nullable(Of Integer)
Public Overridable Property RestrictedResourceType As RestrictedResourceType
End Class
Public Partial Class UserFindByLoginResponse
Inherits UserFindByLoginResponseDto
Public Overridable Property HomeStoreId As Nullable(Of Integer)
Public Overridable Property UserId As Integer
End Class
End Namespace
End Namespace
VB.NET 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
}