ClubReady Api

UsersListRequest

The following routes are available for this service:
GET	/users	Get users list filtered by date

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

Namespace Global

    Namespace ClubReady.Core.Api.Models

        Public Partial Class ApiDtoBase
            Public Overridable Property ApiKey As String
            Public Overridable Property StoreId As Nullable(Of Integer)
            Public Overridable Property ChainId As Nullable(Of Integer)
        End Class

        Public Partial Class UsersListRequestDto
            Inherits ApiDtoBase
            Public Overridable Property Segment As String
            Public Overridable Property ActivityDate As String
            Public Overridable Property ActivityOperator As String
        End Class
    End Namespace

    Namespace ClubReady.Web.Api

        Public Enum RestrictedResourceType
            Store
            Chain
            User
            Undefined
        End Enum
    End Namespace

    Namespace ClubReady.Web.Api.Members.Model

        Public Partial Class UsersListRequest
            Inherits UsersListRequestDto
            Implements 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 Overridable Property ApiKey As String

            '''<Summary>
            '''StoreId OR ChainId is required
            '''</Summary>
            <ApiMember(DataType:="integer", Description:="StoreId OR ChainId is required", Name:="StoreId", ParameterType:="query")>
            Public Overridable Property StoreId As Nullable(Of Integer)

            '''<Summary>
            '''StoreId OR ChainId is required
            '''</Summary>
            <ApiMember(DataType:="integer", Description:="StoreId OR ChainId is required", Name:="ChainId", ParameterType:="query")>
            Public Overridable Property ChainId As Nullable(Of Integer)

            '''<Summary>
            '''Date to use for filter
            '''</Summary>
            <ApiMember(DataType:="Date", Description:="Date to use for filter", IsRequired:=true, Name:="ActivityDate", ParameterType:="query")>
            Public Overridable Property ActivityDate As String

            '''<Summary>
            '''The operator to use when comparing ActivityDate.  Options are GT,EQ and LT for Greater Than, Equal and Less Than.  Defaults to GT if not provided.
            '''</Summary>
            <ApiMember(DataType:="String", Description:="The operator to use when comparing ActivityDate.  Options are GT,EQ and LT for Greater Than, Equal and Less Than.  Defaults to GT if not provided.", Name:="ActivityOperator", ParameterType:="query")>
            Public Overridable Property ActivityOperator As String

            '''<Summary>
            '''Filter by a specific segment. Types: Prospects, Active, Inactive, All, PastDue
            '''</Summary>
            <ApiMember(DataType:="string", Description:="Filter by a specific segment. Types: Prospects, Active, Inactive, All, PastDue", Name:="Segment", ParameterType:="query")>
            Public Overridable Property Segment As String

            Public Overridable Property RestrictedId As Nullable(Of Integer)
            Public Overridable Property RestrictedResourceType As RestrictedResourceType
            '''<Summary>
            '''Version 2 adds email and mobile phone to output
            '''</Summary>
            <ApiMember(DataType:="string", Description:="Version 2 adds email and mobile phone to output", Name:="Version", ParameterType:="query")>
            Public Overridable Property Version As Nullable(Of Integer)
        End Class
    End Namespace
End Namespace

VB.NET UsersListRequest 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 HTTP/1.1 
Host: clubready.com 
Accept: text/csv