ClubReady Api

<back to all web services

UserVisitHistoryRequest

Gets user check-in history based on a date range. Max 31 days.

The following routes are available for this service:
GET/users/{UserId}/visit-historyGet user visit history
import java.math.*
import java.util.*
import net.servicestack.client.*


/**
* Gets user check-in history based on a date range. Max 31 days.
*/
@Api(Description="Gets user check-in history based on a date range. Max 31 days.")
open class UserVisitHistoryRequest : UserVisitHistoryRequestDto(), 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

    /**
    * 
    */
    @ApiMember(DataType="integer", Description="", IsRequired=true, Name="UserId", ParameterType="query")
    var UserId:Int? = null

    /**
    * StoreId OR ChainId is required
    */
    @ApiMember(DataType="string", 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

    /**
    * (Format:YYYY-MM-DD)
    */
    @ApiMember(DataType="date", Description="(Format:YYYY-MM-DD)", IsRequired=true, Name="FromDate", ParameterType="query")
    var FromDate:Date? = null

    /**
    * Max 31 Days (Format:YYYY-MM-DD)
    */
    @ApiMember(DataType="date", Description="Max 31 Days (Format:YYYY-MM-DD)", IsRequired=true, Name="ToDate", ParameterType="query")
    var ToDate:Date? = null

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

open class UserVisitHistoryRequestDto : ApiDtoBase()
{
    var UserId:Int? = null
    var FromDate:Date? = null
    var ToDate:Date? = null
}

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

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

Kotlin UserVisitHistoryRequest 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}/visit-history HTTP/1.1 
Host: clubready.com 
Accept: text/jsv