| GET | /club/visit-history | Return list of club visits, by club or entire chain. |
|---|
namespace ClubReady.Core.Api.Models
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type ApiDtoBase() =
member val ApiKey:String = null with get,set
member val StoreId:Nullable<Int32> = new Nullable<Int32>() with get,set
member val ChainId:Nullable<Int32> = new Nullable<Int32>() with get,set
[<AllowNullLiteral>]
type ClubVisitHistoryRequestDto() =
inherit ApiDtoBase()
member val FromDate:DateTime = new DateTime() with get,set
member val ToDate:DateTime = new DateTime() with get,set
type RestrictedResourceType =
| Store = 0
| Chain = 1
| User = 2
| Undefined = 3
[<AllowNullLiteral>]
type ClubVisitHistoryRequest() =
inherit ClubVisitHistoryRequestDto()
///<summary>
///Api Key - grants access to resources
///</summary>
[<ApiMember(DataType="string", Description="Api Key - grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")>]
member val ApiKey:String = null with get,set
///<summary>
///Either StoreId or ChainId is required
///</summary>
[<ApiMember(DataType="integer", Description="Either StoreId or ChainId is required", Name="StoreId", ParameterType="query")>]
member val StoreId:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///Either StoreId or ChainId is required
///</summary>
[<ApiMember(DataType="integer", Description="Either StoreId or ChainId is required", Name="ChainId", ParameterType="query")>]
member val ChainId:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///UTC Format
///</summary>
[<ApiMember(DataType="date", Description="UTC Format", IsRequired=true, Name="FromDate", ParameterType="query")>]
member val FromDate:DateTime = new DateTime() with get,set
///<summary>
///Max 24 Hours (UTC Format)
///</summary>
[<ApiMember(DataType="date", Description="Max 24 Hours (UTC Format)", IsRequired=true, Name="ToDate", ParameterType="query")>]
member val ToDate:DateTime = new DateTime() with get,set
member val RestrictedId:Nullable<Int32> = new Nullable<Int32>() with get,set
member val RestrictedResourceType:RestrictedResourceType = new RestrictedResourceType() with get,set
[<AllowNullLiteral>]
type ApiResponseBase() =
member val Success:Boolean = new Boolean() with get,set
member val Message:String = null with get,set
[<AllowNullLiteral>]
type ClubVisitHistoryItem() =
member val CheckinLogId:Int32 = new Int32() with get,set
member val UserId:Int32 = new Int32() with get,set
member val FirstName:String = null with get,set
member val LastName:String = null with get,set
member val CheckinStoreId:Int32 = new Int32() with get,set
member val CheckinLocationName:String = null with get,set
member val HomeStoreId:Int32 = new Int32() with get,set
member val HomeStoreLocationName:String = null with get,set
member val UtcTime:DateTime = new DateTime() with get,set
[<AllowNullLiteral>]
type ClubVisitHistoryResponseDto() =
inherit ApiResponseBase()
member val TotalVisits:Int32 = new Int32() with get,set
member val Visits:ResizeArray<ClubVisitHistoryItem> = new ResizeArray<ClubVisitHistoryItem>() with get,set
[<AllowNullLiteral>]
type ClubVisitHistoryResponse() =
inherit ClubVisitHistoryResponseDto()
member val Success:Boolean = new Boolean() with get,set
member val Message:String = null with get,set
member val TotalVisits:Int32 = new Int32() with get,set
member val Visits:ResizeArray<ClubVisitHistoryItem> = new ResizeArray<ClubVisitHistoryItem>() with get,set
F# ClubVisitHistoryRequest 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/visit-history HTTP/1.1 Host: www.clubready.com Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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-01T00:00:00.0000000"}]}