ClubReady Api

ClubVisitHistoryRequest

The following routes are available for this service:
GET	/club/visit-history	Return list of club visits, by club or entire chain.

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


open class ClubVisitHistoryRequest : ClubVisitHistoryRequestDto(), 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

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

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

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

    /**
    * Max 24 Hours (UTC Format)
    */
    @ApiMember(DataType="date", Description="Max 24 Hours (UTC Format)", IsRequired=true, Name="ToDate", ParameterType="query")
    var ToDate:Date? = null

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

open class ClubVisitHistoryRequestDto : ApiDtoBase()
{
    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,
}

open class ClubVisitHistoryResponse : ClubVisitHistoryResponseDto()
{
    var Success:Boolean? = null
    var Message:String? = null
    var TotalVisits:Int? = null
    var Visits:ArrayList<ClubVisitHistoryItem> = ArrayList<ClubVisitHistoryItem>()
}

open class ClubVisitHistoryResponseDto : ApiResponseBase()
{
    var TotalVisits:Int? = null
    var Visits:ArrayList<ClubVisitHistoryItem> = ArrayList<ClubVisitHistoryItem>()
}

open class ApiResponseBase
{
    var Success:Boolean? = null
    var Message:String? = null
}

open class ClubVisitHistoryItem
{
    var CheckinLogId:Int? = null
    var UserId:Int? = null
    var FirstName:String? = null
    var LastName:String? = null
    var CheckinStoreId:Int? = null
    var CheckinLocationName:String? = null
    var HomeStoreId:Int? = null
    var HomeStoreLocationName:String? = null
    var UtcTime:Date? = null
}

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

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Success: False,
	Message: String,
	TotalVisits: 0,
	Visits: 
	[
		{
			CheckinLogId: 0,
			UserId: 0,
			FirstName: String,
			LastName: String,
			CheckinStoreId: 0,
			CheckinLocationName: String,
			HomeStoreId: 0,
			HomeStoreLocationName: String,
			UtcTime: 0001-01-01
		}
	]
}