ClubReady Api

<back to all web services

UserVisitHistoryRequest

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

using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using ClubReady.Web.Api.Members.Model;
using ClubReady.Core.Api.Models;
using ClubReady.Web.Api;

namespace ClubReady.Core.Api.Models
{
    public partial class ApiDtoBase
    {
        public virtual string ApiKey { get; set; }
        public virtual int? StoreId { get; set; }
        public virtual int? ChainId { get; set; }
    }

    public partial class UserVisitHistoryRequestDto
        : ApiDtoBase
    {
        public virtual int UserId { get; set; }
        public virtual DateTime FromDate { get; set; }
        public virtual DateTime ToDate { get; set; }
    }

}

namespace ClubReady.Web.Api
{
    public enum RestrictedResourceType
    {
        Store,
        Chain,
        User,
        Undefined,
    }

}

namespace ClubReady.Web.Api.Members.Model
{
    ///<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.")]
    public partial class UserVisitHistoryRequest
        : UserVisitHistoryRequestDto, IRestrictedApiRequest
    {
        ///<summary>
        ///Api Key - grants access to resources
        ///</summary>
        [ApiMember(DataType="string", Description="Api Key - grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")]
        public virtual string ApiKey { get; set; }

        ///<summary>
        ///
        ///</summary>
        [ApiMember(DataType="integer", Description="", IsRequired=true, Name="UserId", ParameterType="query")]
        public virtual int UserId { get; set; }

        ///<summary>
        ///StoreId OR ChainId is required
        ///</summary>
        [ApiMember(DataType="string", Description="StoreId OR ChainId is required", Name="StoreId", ParameterType="query")]
        public virtual int? StoreId { get; set; }

        ///<summary>
        ///StoreId OR ChainId is required
        ///</summary>
        [ApiMember(DataType="string", Description="StoreId OR ChainId is required", Name="ChainId", ParameterType="query")]
        public virtual int? ChainId { get; set; }

        ///<summary>
        ///(Format:YYYY-MM-DD)
        ///</summary>
        [ApiMember(DataType="date", Description="(Format:YYYY-MM-DD)", IsRequired=true, Name="FromDate", ParameterType="query")]
        public virtual DateTime FromDate { 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")]
        public virtual DateTime ToDate { get; set; }

        public virtual int? RestrictedId { get; set; }
        public virtual RestrictedResourceType RestrictedResourceType { get; set; }
    }

}

C# UserVisitHistoryRequest DTOs

GET /users/{UserId}/visit-history HTTP/1.1 
Host: clubready.com 
Accept: text/csv