ClubReady Api

UsersListRequest

The following routes are available for this service:
GET	/users	Get users list filtered by date

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


open class UsersListRequest : UsersListRequestDto(), IRestrictedApiRequest
{
    /**
    * Api Key - grants access to resources
    */
    @ApiMember(DataType="string", Description="Api Key - grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")
    var ApiKey:String? = null

    /**
    * StoreId OR ChainId is required
    */
    @ApiMember(DataType="integer", Description="StoreId OR ChainId is required", Name="StoreId", ParameterType="query")
    var StoreId:Int? = null

    /**
    * StoreId OR ChainId is required
    */
    @ApiMember(DataType="integer", Description="StoreId OR ChainId is required", Name="ChainId", ParameterType="query")
    var ChainId:Int? = null

    /**
    * Date to use for filter
    */
    @ApiMember(DataType="Date", Description="Date to use for filter", IsRequired=true, Name="ActivityDate", ParameterType="query")
    var ActivityDate:String? = 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")
    var ActivityOperator:String? = 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")
    var Segment:String? = null

    var RestrictedId:Int? = null
    var 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")
    var Version:Int? = null
}

open class UsersListRequestDto : ApiDtoBase()
{
    var Segment:String? = null
    var ActivityDate:String? = null
    var ActivityOperator:String? = null
}

open class ApiDtoBase
{
    var ApiKey:String? = null
    var StoreId:Int? = null
    var ChainId:Int? = null
}

enum class RestrictedResourceType
{
    Store,
    Chain,
    User,
    Undefined,
}

Kotlin UsersListRequest 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 /users HTTP/1.1 
Host: clubready.com 
Accept: application/json