ClubReady Api

<back to all web services

UserAccountInfoRequest

The following routes are available for this service:
GET/users/{UserId}Get user account summary
import java.math.*
import java.util.*
import net.servicestack.client.*


open class UserAccountInfoRequest : UserAccountInfoRequestDto(), 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

    /**
    * (debug id) Jen A = 28975
    */
    @ApiMember(DataType="integer", Description="(debug id) Jen A = 28975", IsRequired=true, Name="UserId", ParameterType="query")
    var UserId:Int? = 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

    /**
    * Whether you want full detail to be returned or a basic User object. (Format: true|false(default))
    */
    @ApiMember(DataType="Boolean", Description="Whether you want full detail to be returned or a basic User object. (Format: true|false(default))", Name="FullDetail", ParameterType="query")
    var FullDetail:Boolean? = null

    var RestrictedId:Int? = null
    var RestrictedResourceType:RestrictedResourceType? = null
}

open class UserAccountInfoRequestDto : ApiDtoBase()
{
    var UserId:Int? = null
    var FullDetail: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 UserAccountInfoRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /users/{UserId} HTTP/1.1 
Host: clubready.com 
Accept: text/jsv