ClubReady Api

<back to all web services

UserVisitHistoryRequest

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

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

public class dtos
{

    /**
    * 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.")
    public static class UserVisitHistoryRequest extends UserVisitHistoryRequestDto implements IRestrictedApiRequest
    {
        /**
        * Api Key - grants access to resources
        */
        @ApiMember(DataType="string", Description="Api Key - grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")
        public String ApiKey = null;

        /**
        * 
        */
        @ApiMember(DataType="integer", Description="", IsRequired=true, Name="UserId", ParameterType="query")
        public Integer UserId = null;

        /**
        * StoreId OR ChainId is required
        */
        @ApiMember(DataType="string", Description="StoreId OR ChainId is required", Name="StoreId", ParameterType="query")
        public Integer StoreId = null;

        /**
        * StoreId OR ChainId is required
        */
        @ApiMember(DataType="string", Description="StoreId OR ChainId is required", Name="ChainId", ParameterType="query")
        public Integer ChainId = null;

        /**
        * (Format:YYYY-MM-DD)
        */
        @ApiMember(DataType="date", Description="(Format:YYYY-MM-DD)", IsRequired=true, Name="FromDate", ParameterType="query")
        public Date FromDate = 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")
        public Date ToDate = null;

        public Integer RestrictedId = null;
        public RestrictedResourceType RestrictedResourceType = null;
        
        public String getApiKey() { return ApiKey; }
        public UserVisitHistoryRequest setApiKey(String value) { this.ApiKey = value; return this; }
        public Integer getUserId() { return UserId; }
        public UserVisitHistoryRequest setUserId(Integer value) { this.UserId = value; return this; }
        public Integer getStoreId() { return StoreId; }
        public UserVisitHistoryRequest setStoreId(Integer value) { this.StoreId = value; return this; }
        public Integer getChainId() { return ChainId; }
        public UserVisitHistoryRequest setChainId(Integer value) { this.ChainId = value; return this; }
        public Date getFromDate() { return FromDate; }
        public UserVisitHistoryRequest setFromDate(Date value) { this.FromDate = value; return this; }
        public Date getToDate() { return ToDate; }
        public UserVisitHistoryRequest setToDate(Date value) { this.ToDate = value; return this; }
        public Integer getRestrictedId() { return RestrictedId; }
        public UserVisitHistoryRequest setRestrictedId(Integer value) { this.RestrictedId = value; return this; }
        public RestrictedResourceType getRestrictedResourceType() { return RestrictedResourceType; }
        public UserVisitHistoryRequest setRestrictedResourceType(RestrictedResourceType value) { this.RestrictedResourceType = value; return this; }
    }

    public static class UserVisitHistoryRequestDto extends ApiDtoBase
    {
        public Integer UserId = null;
        public Date FromDate = null;
        public Date ToDate = null;
        
        public Integer getUserId() { return UserId; }
        public UserVisitHistoryRequestDto setUserId(Integer value) { this.UserId = value; return this; }
        public Date getFromDate() { return FromDate; }
        public UserVisitHistoryRequestDto setFromDate(Date value) { this.FromDate = value; return this; }
        public Date getToDate() { return ToDate; }
        public UserVisitHistoryRequestDto setToDate(Date value) { this.ToDate = value; return this; }
    }

    public static class ApiDtoBase
    {
        public String ApiKey = null;
        public Integer StoreId = null;
        public Integer ChainId = null;
        
        public String getApiKey() { return ApiKey; }
        public ApiDtoBase setApiKey(String value) { this.ApiKey = value; return this; }
        public Integer getStoreId() { return StoreId; }
        public ApiDtoBase setStoreId(Integer value) { this.StoreId = value; return this; }
        public Integer getChainId() { return ChainId; }
        public ApiDtoBase setChainId(Integer value) { this.ChainId = value; return this; }
    }

    public static enum RestrictedResourceType
    {
        Store,
        Chain,
        User,
        Undefined;
    }

}

Java UserVisitHistoryRequest DTOs

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