ClubReady Api

<back to all web services

SearchUsersRequest

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

public class dtos
{

    public static class SearchUsersRequest extends SearchUsersRequestDto 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;

        /**
        * Filter by First Name
        */
        @ApiMember(DataType="string", Description="Filter by First Name", Name="FirstName", ParameterType="query")
        public String FirstName = null;

        /**
        * Filter by Last Name
        */
        @ApiMember(DataType="string", Description="Filter by Last Name", Name="LastName", ParameterType="query")
        public String LastName = null;

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

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

        /**
        * Filter by barcode
        */
        @ApiMember(DataType="string", Description="Filter by barcode", Name="Barcode", ParameterType="query")
        public String Barcode = null;

        /**
        * Filter by Email Address
        */
        @ApiMember(DataType="string", Description="Filter by Email Address", Name="Email", ParameterType="query")
        public String Email = null;

        /**
        * Filter by Phone Number
        */
        @ApiMember(DataType="string", Description="Filter by Phone Number", Name="Phone", ParameterType="query")
        public String Phone = null;

        /**
        * Filter by ClubReady User Type
        */
        @ApiMember(DataType="integer", Description="Filter by ClubReady User Type", Name="UserType", ParameterType="query")
        public Integer UserType = null;

        /**
        * Page of users to retrieve. Pulls back 100 users per page.
        */
        @ApiMember(DataType="integer", Description="Page of users to retrieve. Pulls back 100 users per page.", Name="Page", ParameterType="query")
        public Integer Page = null;

        public Integer RestrictedId = null;
        public RestrictedResourceType RestrictedResourceType = null;
        
        public String getApiKey() { return ApiKey; }
        public SearchUsersRequest setApiKey(String value) { this.ApiKey = value; return this; }
        public String getFirstName() { return FirstName; }
        public SearchUsersRequest setFirstName(String value) { this.FirstName = value; return this; }
        public String getLastName() { return LastName; }
        public SearchUsersRequest setLastName(String value) { this.LastName = value; return this; }
        public Integer getStoreId() { return StoreId; }
        public SearchUsersRequest setStoreId(Integer value) { this.StoreId = value; return this; }
        public Integer getChainId() { return ChainId; }
        public SearchUsersRequest setChainId(Integer value) { this.ChainId = value; return this; }
        public String getBarcode() { return Barcode; }
        public SearchUsersRequest setBarcode(String value) { this.Barcode = value; return this; }
        public String getEmail() { return Email; }
        public SearchUsersRequest setEmail(String value) { this.Email = value; return this; }
        public String getPhone() { return Phone; }
        public SearchUsersRequest setPhone(String value) { this.Phone = value; return this; }
        public Integer getUserType() { return UserType; }
        public SearchUsersRequest setUserType(Integer value) { this.UserType = value; return this; }
        public Integer getPage() { return Page; }
        public SearchUsersRequest setPage(Integer value) { this.Page = value; return this; }
        public Integer getRestrictedId() { return RestrictedId; }
        public SearchUsersRequest setRestrictedId(Integer value) { this.RestrictedId = value; return this; }
        public RestrictedResourceType getRestrictedResourceType() { return RestrictedResourceType; }
        public SearchUsersRequest setRestrictedResourceType(RestrictedResourceType value) { this.RestrictedResourceType = value; return this; }
    }

    public static class SearchUsersRequestDto extends ApiDtoBase
    {
        public String Barcode = null;
        public String FirstName = null;
        public String LastName = null;
        public String Email = null;
        public String Phone = null;
        public Integer UserType = null;
        public Integer Page = null;
        
        public String getBarcode() { return Barcode; }
        public SearchUsersRequestDto setBarcode(String value) { this.Barcode = value; return this; }
        public String getFirstName() { return FirstName; }
        public SearchUsersRequestDto setFirstName(String value) { this.FirstName = value; return this; }
        public String getLastName() { return LastName; }
        public SearchUsersRequestDto setLastName(String value) { this.LastName = value; return this; }
        public String getEmail() { return Email; }
        public SearchUsersRequestDto setEmail(String value) { this.Email = value; return this; }
        public String getPhone() { return Phone; }
        public SearchUsersRequestDto setPhone(String value) { this.Phone = value; return this; }
        public Integer getUserType() { return UserType; }
        public SearchUsersRequestDto setUserType(Integer value) { this.UserType = value; return this; }
        public Integer getPage() { return Page; }
        public SearchUsersRequestDto setPage(Integer value) { this.Page = 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 SearchUsersRequest DTOs

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