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.
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 UserListDateAddedRequestDto() = 
        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 UserListDateAddedRequest() = 
        inherit UserListDateAddedRequestDto()
        ///<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>
        ///Chain ID
        ///</summary>
        [<ApiMember(DataType="integer", Description="Chain ID", Name="ChainId", ParameterType="query")>]
        member val ChainId:Nullable<Int32> = new Nullable<Int32>() with get,set

        ///<summary>
        ///Store ID
        ///</summary>
        [<ApiMember(DataType="integer", Description="Store ID", Name="StoreId", ParameterType="query")>]
        member val StoreId: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 ClubClient() = 
        member val UserId:Int32 = new Int32() with get,set
        member val Username:String = null with get,set
        member val FirstName:String = null with get,set
        member val LastName:String = null with get,set
        member val StoreId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val DateAdded:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val ReferredBy:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val AddedBy:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val ReferralTypeId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val ReferralTypeName:String = null with get,set

    [<AllowNullLiteral>]
    type UserListDateAddedResponseDto() = 
        member val Users:ResizeArray<ClubClient> = new ResizeArray<ClubClient>() with get,set

    [<AllowNullLiteral>]
    type UserListDateAddedResponse() = 
        inherit UserListDateAddedResponseDto()
        member val Users:ResizeArray<ClubClient> = new ResizeArray<ClubClient>() with get,set

F# UserListDateAddedRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

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