ClubReady Api

<back to all web services

UsersListRequest

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

public class dtos
{

    public static class UsersListRequest extends UsersListRequestDto 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;

        /**
        * 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="integer", Description="StoreId OR ChainId is required", Name="ChainId", ParameterType="query")
        public Integer ChainId = null;

        /**
        * Date to use for filter
        */
        @ApiMember(DataType="Date", Description="Date to use for filter", IsRequired=true, Name="ActivityDate", ParameterType="query")
        public String ActivityDate = null;

        /**
        * The operator to use when comparing ActivityDate.  Options are GT,EQ and LT for Greater Than, Equal and Less Than.  Defaults to GT if not provided.
        */
        @ApiMember(DataType="String", Description="The operator to use when comparing ActivityDate.  Options are GT,EQ and LT for Greater Than, Equal and Less Than.  Defaults to GT if not provided.", Name="ActivityOperator", ParameterType="query")
        public String ActivityOperator = null;

        /**
        * Filter by a specific segment. Types: Prospects, Active, Inactive, All, PastDue
        */
        @ApiMember(DataType="string", Description="Filter by a specific segment. Types: Prospects, Active, Inactive, All, PastDue", Name="Segment", ParameterType="query")
        public String Segment = null;

        public Integer RestrictedId = null;
        public RestrictedResourceType RestrictedResourceType = null;
        /**
        * Version 2 adds email and mobile phone to output
        */
        @ApiMember(DataType="string", Description="Version 2 adds email and mobile phone to output", Name="Version", ParameterType="query")
        public Integer Version = null;
        
        public String getApiKey() { return ApiKey; }
        public UsersListRequest setApiKey(String value) { this.ApiKey = value; return this; }
        public Integer getStoreId() { return StoreId; }
        public UsersListRequest setStoreId(Integer value) { this.StoreId = value; return this; }
        public Integer getChainId() { return ChainId; }
        public UsersListRequest setChainId(Integer value) { this.ChainId = value; return this; }
        public String getActivityDate() { return ActivityDate; }
        public UsersListRequest setActivityDate(String value) { this.ActivityDate = value; return this; }
        public String getActivityOperator() { return ActivityOperator; }
        public UsersListRequest setActivityOperator(String value) { this.ActivityOperator = value; return this; }
        public String getSegment() { return Segment; }
        public UsersListRequest setSegment(String value) { this.Segment = value; return this; }
        public Integer getRestrictedId() { return RestrictedId; }
        public UsersListRequest setRestrictedId(Integer value) { this.RestrictedId = value; return this; }
        public RestrictedResourceType getRestrictedResourceType() { return RestrictedResourceType; }
        public UsersListRequest setRestrictedResourceType(RestrictedResourceType value) { this.RestrictedResourceType = value; return this; }
        public Integer getVersion() { return Version; }
        public UsersListRequest setVersion(Integer value) { this.Version = value; return this; }
    }

    public static class UsersListRequestDto extends ApiDtoBase
    {
        public String Segment = null;
        public String ActivityDate = null;
        public String ActivityOperator = null;
        
        public String getSegment() { return Segment; }
        public UsersListRequestDto setSegment(String value) { this.Segment = value; return this; }
        public String getActivityDate() { return ActivityDate; }
        public UsersListRequestDto setActivityDate(String value) { this.ActivityDate = value; return this; }
        public String getActivityOperator() { return ActivityOperator; }
        public UsersListRequestDto setActivityOperator(String value) { this.ActivityOperator = 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 UsersListRequest DTOs

GET /users HTTP/1.1 
Host: clubready.com 
Accept: text/csv