ClubReady Api

<back to all web services

UserListDateAddedRequest

The following routes are available for this service:
GET/users/date-addedList of users added in a certain date range.
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;
using ClubReady.Core.Users.Models;

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 UserListDateAddedRequestDto
        : ApiDtoBase
    {
        public virtual DateTime FromDate { get; set; }
        public virtual DateTime ToDate { get; set; }
    }

    public partial class UserListDateAddedResponseDto
    {
        public UserListDateAddedResponseDto()
        {
            Users = new List<ClubClient>{};
        }

        public virtual List<ClubClient> Users { get; set; }
    }

}

namespace ClubReady.Core.Users.Models
{
    public partial class ClubClient
    {
        public virtual int UserId { get; set; }
        public virtual string Username { get; set; }
        public virtual string FirstName { get; set; }
        public virtual string LastName { get; set; }
        public virtual int? StoreId { get; set; }
        public virtual DateTime? DateAdded { get; set; }
        public virtual int? ReferredBy { get; set; }
        public virtual int? AddedBy { get; set; }
        public virtual int? ReferralTypeId { get; set; }
        public virtual string ReferralTypeName { get; set; }
    }

}

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

}

namespace ClubReady.Web.Api.Members.Model
{
    public partial class UserListDateAddedRequest
        : UserListDateAddedRequestDto, 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>
        ///Chain ID
        ///</summary>
        [ApiMember(DataType="integer", Description="Chain ID", Name="ChainId", ParameterType="query")]
        public virtual int? ChainId { get; set; }

        ///<summary>
        ///Store ID
        ///</summary>
        [ApiMember(DataType="integer", Description="Store ID", Name="StoreId", ParameterType="query")]
        public virtual int? StoreId { get; set; }

        ///<summary>
        ///UTC Format
        ///</summary>
        [ApiMember(DataType="date", Description="UTC Format", IsRequired=true, Name="FromDate", ParameterType="query")]
        public virtual DateTime FromDate { get; set; }

        ///<summary>
        ///Max 24 Hours (UTC Format)
        ///</summary>
        [ApiMember(DataType="date", Description="Max 24 Hours (UTC Format)", IsRequired=true, Name="ToDate", ParameterType="query")]
        public virtual DateTime ToDate { get; set; }

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

    public partial class UserListDateAddedResponse
        : UserListDateAddedResponseDto
    {
        public UserListDateAddedResponse()
        {
            Users = new List<ClubClient>{};
        }

        public virtual List<ClubClient> Users { get; set; }
    }

}

C# UserListDateAddedRequest 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/date-added HTTP/1.1 
Host: www.clubready.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Users: 
	[
		{
			UserId: 0,
			Username: String,
			FirstName: String,
			LastName: String,
			StoreId: 0,
			DateAdded: 0001-01-01,
			ReferredBy: 0,
			AddedBy: 0,
			ReferralTypeId: 0,
			ReferralTypeName: String
		}
	]
}