| GET | /users/find | Find a member. |
|---|
import java.math.*
import java.util.*
import net.servicestack.client.*
open class SearchUsersRequest : SearchUsersRequestDto(), 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
/**
* Filter by First Name
*/
@ApiMember(DataType="string", Description="Filter by First Name", Name="FirstName", ParameterType="query")
var FirstName:String? = null
/**
* Filter by Last Name
*/
@ApiMember(DataType="string", Description="Filter by Last Name", Name="LastName", ParameterType="query")
var LastName: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="string", Description="StoreId OR ChainId is required", Name="ChainId", ParameterType="query")
var ChainId:Int? = null
/**
* Filter by barcode
*/
@ApiMember(DataType="string", Description="Filter by barcode", Name="Barcode", ParameterType="query")
var Barcode:String? = null
/**
* Filter by Email Address
*/
@ApiMember(DataType="string", Description="Filter by Email Address", Name="Email", ParameterType="query")
var Email:String? = null
/**
* Filter by Phone Number
*/
@ApiMember(DataType="string", Description="Filter by Phone Number", Name="Phone", ParameterType="query")
var Phone:String? = null
/**
* Filter by ClubReady User Type
*/
@ApiMember(DataType="integer", Description="Filter by ClubReady User Type", Name="UserType", ParameterType="query")
var UserType:Int? = 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")
var Page:Int? = null
var RestrictedId:Int? = null
var RestrictedResourceType:RestrictedResourceType? = null
}
open class SearchUsersRequestDto : ApiDtoBase()
{
var Barcode:String? = null
var FirstName:String? = null
var LastName:String? = null
var Email:String? = null
var Phone:String? = null
var UserType:Int? = null
var Page:Int? = null
}
open class ApiDtoBase
{
var ApiKey:String? = null
var StoreId:Int? = null
var ChainId:Int? = null
}
enum class RestrictedResourceType
{
Store,
Chain,
User,
Undefined,
}
Kotlin SearchUsersRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /users/find HTTP/1.1 Host: clubready.com Accept: application/xml