ClubReady Api

SearchUsersRequest

The following routes are available for this service:
GET	/users/find	Find a member.

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 SearchUsersRequestDto
            Inherits ApiDtoBase
            Public Overridable Property Barcode As String
            Public Overridable Property FirstName As String
            Public Overridable Property LastName As String
            Public Overridable Property Email As String
            Public Overridable Property Phone As String
            Public Overridable Property UserType As Nullable(Of Integer)
            Public Overridable Property Page As Nullable(Of Integer)
        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 SearchUsersRequest
            Inherits SearchUsersRequestDto
            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>
            '''Filter by First Name
            '''</Summary>
            <ApiMember(DataType:="string", Description:="Filter by First Name", Name:="FirstName", ParameterType:="query")>
            Public Overridable Property FirstName As String

            '''<Summary>
            '''Filter by Last Name
            '''</Summary>
            <ApiMember(DataType:="string", Description:="Filter by Last Name", Name:="LastName", ParameterType:="query")>
            Public Overridable Property LastName 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:="string", Description:="StoreId OR ChainId is required", Name:="ChainId", ParameterType:="query")>
            Public Overridable Property ChainId As Nullable(Of Integer)

            '''<Summary>
            '''Filter by barcode
            '''</Summary>
            <ApiMember(DataType:="string", Description:="Filter by barcode", Name:="Barcode", ParameterType:="query")>
            Public Overridable Property Barcode As String

            '''<Summary>
            '''Filter by Email Address
            '''</Summary>
            <ApiMember(DataType:="string", Description:="Filter by Email Address", Name:="Email", ParameterType:="query")>
            Public Overridable Property Email As String

            '''<Summary>
            '''Filter by Phone Number
            '''</Summary>
            <ApiMember(DataType:="string", Description:="Filter by Phone Number", Name:="Phone", ParameterType:="query")>
            Public Overridable Property Phone As String

            '''<Summary>
            '''Filter by ClubReady User Type
            '''</Summary>
            <ApiMember(DataType:="integer", Description:="Filter by ClubReady User Type", Name:="UserType", ParameterType:="query")>
            Public Overridable Property UserType As Nullable(Of Integer)

            '''<Summary>
            '''Page of users to retrieve. Pulls back 100 users per page.
            '''</Summary>
            <ApiMember(DataType:="integer", Description:="Page of users to retrieve. Pulls back 100 users per page.", Name:="Page", ParameterType:="query")>
            Public Overridable Property Page As Nullable(Of Integer)

            Public Overridable Property RestrictedId As Nullable(Of Integer)
            Public Overridable Property RestrictedResourceType As RestrictedResourceType
        End Class
    End Namespace
End Namespace

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