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
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 UserVisitHistoryRequestDto() = 
        inherit ApiDtoBase()
        member val UserId:Int32 = new Int32() with get,set
        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

    ///<summary>
    ///Gets user check-in history based on a date range. Max 31 days.
    ///</summary>
    [<Api(Description="Gets user check-in history based on a date range. Max 31 days.")>]
    [<AllowNullLiteral>]
    type UserVisitHistoryRequest() = 
        inherit UserVisitHistoryRequestDto()
        ///<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>
        ///
        ///</summary>
        [<ApiMember(DataType="integer", Description="", IsRequired=true, Name="UserId", ParameterType="query")>]
        member val UserId:Int32 = new Int32() with get,set

        ///<summary>
        ///StoreId OR ChainId is required
        ///</summary>
        [<ApiMember(DataType="string", Description="StoreId OR ChainId is required", Name="StoreId", ParameterType="query")>]
        member val StoreId:Nullable<Int32> = new Nullable<Int32>() with get,set

        ///<summary>
        ///StoreId OR ChainId is required
        ///</summary>
        [<ApiMember(DataType="string", Description="StoreId OR ChainId is required", Name="ChainId", ParameterType="query")>]
        member val ChainId:Nullable<Int32> = new Nullable<Int32>() with get,set

        ///<summary>
        ///(Format:YYYY-MM-DD)
        ///</summary>
        [<ApiMember(DataType="date", Description="(Format:YYYY-MM-DD)", IsRequired=true, Name="FromDate", ParameterType="query")>]
        member val FromDate:DateTime = new DateTime() with get,set

        ///<summary>
        ///Max 31 Days (Format:YYYY-MM-DD)
        ///</summary>
        [<ApiMember(DataType="date", Description="Max 31 Days (Format:YYYY-MM-DD)", 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

F# 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