ClubReady Api

<back to all web services

UserFindByLoginRequest

import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class UserFindByLoginRequest extends UserFindByLoginRequestDto implements IRestrictedApiRequest
    {
        /**
        * Api Key - grants access to resources
        */
        @ApiMember(DataType="string", Description="Api Key - grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")
        public String ApiKey = null;

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

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

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

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

        public Integer RestrictedId = null;
        public RestrictedResourceType RestrictedResourceType = null;
        
        public String getApiKey() { return ApiKey; }
        public UserFindByLoginRequest setApiKey(String value) { this.ApiKey = value; return this; }
        public Integer getStoreId() { return StoreId; }
        public UserFindByLoginRequest setStoreId(Integer value) { this.StoreId = value; return this; }
        public Integer getChainId() { return ChainId; }
        public UserFindByLoginRequest setChainId(Integer value) { this.ChainId = value; return this; }
        public String getUserName() { return UserName; }
        public UserFindByLoginRequest setUserName(String value) { this.UserName = value; return this; }
        public String getPassword() { return Password; }
        public UserFindByLoginRequest setPassword(String value) { this.Password = value; return this; }
        public Integer getRestrictedId() { return RestrictedId; }
        public UserFindByLoginRequest setRestrictedId(Integer value) { this.RestrictedId = value; return this; }
        public RestrictedResourceType getRestrictedResourceType() { return RestrictedResourceType; }
        public UserFindByLoginRequest setRestrictedResourceType(RestrictedResourceType value) { this.RestrictedResourceType = value; return this; }
    }

    public static class UserFindByLoginRequestDto extends ApiDtoBase
    {
        public Integer UserId = null;
        public String UserName = null;
        public String Password = null;
        
        public Integer getUserId() { return UserId; }
        public UserFindByLoginRequestDto setUserId(Integer value) { this.UserId = value; return this; }
        public String getUserName() { return UserName; }
        public UserFindByLoginRequestDto setUserName(String value) { this.UserName = value; return this; }
        public String getPassword() { return Password; }
        public UserFindByLoginRequestDto setPassword(String value) { this.Password = value; return this; }
    }

    public static class ApiDtoBase
    {
        public String ApiKey = null;
        public Integer StoreId = null;
        public Integer ChainId = null;
        
        public String getApiKey() { return ApiKey; }
        public ApiDtoBase setApiKey(String value) { this.ApiKey = value; return this; }
        public Integer getStoreId() { return StoreId; }
        public ApiDtoBase setStoreId(Integer value) { this.StoreId = value; return this; }
        public Integer getChainId() { return ChainId; }
        public ApiDtoBase setChainId(Integer value) { this.ChainId = value; return this; }
    }

    public static enum RestrictedResourceType
    {
        Store,
        Chain,
        User,
        Undefined;
    }

    public static class UserFindByLoginResponse extends UserFindByLoginResponseDto
    {
        public Integer HomeStoreId = null;
        public Integer UserId = null;
        
        public Integer getHomeStoreId() { return HomeStoreId; }
        public UserFindByLoginResponse setHomeStoreId(Integer value) { this.HomeStoreId = value; return this; }
        public Integer getUserId() { return UserId; }
        public UserFindByLoginResponse setUserId(Integer value) { this.UserId = value; return this; }
    }

    public static class UserFindByLoginResponseDto extends ApiResponseBase
    {
        public Integer HomeStoreId = null;
        public Integer UserId = null;
        
        public Integer getHomeStoreId() { return HomeStoreId; }
        public UserFindByLoginResponseDto setHomeStoreId(Integer value) { this.HomeStoreId = value; return this; }
        public Integer getUserId() { return UserId; }
        public UserFindByLoginResponseDto setUserId(Integer value) { this.UserId = value; return this; }
    }

    public static class ApiResponseBase
    {
        public Boolean Success = null;
        public String Message = null;
        
        public Boolean isSuccess() { return Success; }
        public ApiResponseBase setSuccess(Boolean value) { this.Success = value; return this; }
        public String getMessage() { return Message; }
        public ApiResponseBase setMessage(String value) { this.Message = value; return this; }
    }

}

Java UserFindByLoginRequest DTOs

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

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

<UserFindByLoginResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Web.Api.Members.Model">
  <Message xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">String</Message>
  <Success xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">false</Success>
  <HomeStoreId xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0</HomeStoreId>
  <UserId xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">0</UserId>
</UserFindByLoginResponse>