ClubReady Api

GetAllUsersRequest

The following routes are available for this service:
GET	/club/{StoreId}/Users/all	Get all Users for club

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

public class dtos
{

    public static class GetAllUsersRequest extends GetAllUsersRequestDto 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;

        /**
        * Chain ID
        */
        @ApiMember(DataType="integer", Description="Chain ID", Name="ChainId", ParameterType="query")
        public Integer ChainId = null;

        /**
        * Store ID
        */
        @ApiMember(DataType="integer", Description="Store ID", IsRequired=true, Name="StoreId", ParameterType="query")
        public Integer StoreId = null;

        /**
        * Include deleted users in result? (defaults to false)
        */
        @ApiMember(DataType="bool", Description="Include deleted users in result? (defaults to false)", Name="IncludeDeleted", ParameterType="query")
        public Boolean IncludeDeleted = null;

        /**
        * Max number of records to include in the response.
        */
        @ApiMember(DataType="int", Description="Max number of records to include in the response.", Name="PageSize", ParameterType="query")
        public Integer PageSize = null;

        /**
        * Page number to retrieve.
        */
        @ApiMember(DataType="int", Description="Page number to retrieve.", Name="PageNumber", ParameterType="query")
        public Integer PageNumber = null;

        public Integer RestrictedId = null;
        public RestrictedResourceType RestrictedResourceType = null;
        
        public String getApiKey() { return ApiKey; }
        public GetAllUsersRequest setApiKey(String value) { this.ApiKey = value; return this; }
        public Integer getChainId() { return ChainId; }
        public GetAllUsersRequest setChainId(Integer value) { this.ChainId = value; return this; }
        public Integer getStoreId() { return StoreId; }
        public GetAllUsersRequest setStoreId(Integer value) { this.StoreId = value; return this; }
        public Boolean isIncludeDeleted() { return IncludeDeleted; }
        public GetAllUsersRequest setIncludeDeleted(Boolean value) { this.IncludeDeleted = value; return this; }
        public Integer getPageSize() { return PageSize; }
        public GetAllUsersRequest setPageSize(Integer value) { this.PageSize = value; return this; }
        public Integer getPageNumber() { return PageNumber; }
        public GetAllUsersRequest setPageNumber(Integer value) { this.PageNumber = value; return this; }
        public Integer getRestrictedId() { return RestrictedId; }
        public GetAllUsersRequest setRestrictedId(Integer value) { this.RestrictedId = value; return this; }
        public RestrictedResourceType getRestrictedResourceType() { return RestrictedResourceType; }
        public GetAllUsersRequest setRestrictedResourceType(RestrictedResourceType value) { this.RestrictedResourceType = value; return this; }
    }

    public static class GetAllUsersRequestDto extends ApiDtoBase
    {
        public Boolean IncludeDeleted = null;
        
        public Boolean isIncludeDeleted() { return IncludeDeleted; }
        public GetAllUsersRequestDto setIncludeDeleted(Boolean value) { this.IncludeDeleted = 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;
    }

}

Java GetAllUsersRequest 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 /club/{StoreId}/Users/all HTTP/1.1 
Host: www.clubready.com 
Accept: application/json

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

[{"UserId":0,"Prospect":false,"Member":false,"DateAdded":"0001-01-01T00:00:00.0000000","Email":"String","FirstName":"String","LastName":"String","StoreId":0,"Username":"String","Address":"String","City":"String","State":"String","Zip":"String","Barcode":"String","Phone":"String","CellPhone":"String","ExternalUserId":"String","ProspectTypeName":"String","DateOfBirth":"String","MemberSinceDate":"String","MembershipExpiresDate":"String","MembershipEndedDate":"String","EmailOptOut":false,"SmsOptOut":false,"SmsOptIn":false,"ReferralTypeId":0,"ReferralTypeName":"String"}]