| GET | /club/{StoreId}/Users/all | Get all Users for club |
|---|
import java.math.*
import java.util.*
import net.servicestack.client.*
open class GetAllUsersRequest : GetAllUsersRequestDto(), 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
/**
* Chain ID
*/
@ApiMember(DataType="integer", Description="Chain ID", Name="ChainId", ParameterType="query")
var ChainId:Int? = null
/**
* Store ID
*/
@ApiMember(DataType="integer", Description="Store ID", IsRequired=true, Name="StoreId", ParameterType="query")
var StoreId:Int? = 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")
var IncludeDeleted:Boolean? = 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")
var PageSize:Int? = null
/**
* Page number to retrieve.
*/
@ApiMember(DataType="int", Description="Page number to retrieve.", Name="PageNumber", ParameterType="query")
var PageNumber:Int? = null
var RestrictedId:Int? = null
var RestrictedResourceType:RestrictedResourceType? = null
}
open class GetAllUsersRequestDto : ApiDtoBase()
{
var IncludeDeleted:Boolean? = null
}
open class ApiDtoBase
{
var ApiKey:String? = null
var StoreId:Int? = null
var ChainId:Int? = null
}
enum class RestrictedResourceType
{
Store,
Chain,
User,
Undefined,
}
Kotlin GetAllUsersRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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: clubready.com
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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"}]