| GET | /users/find | Find a member. |
|---|
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 SearchUsersRequestDto() =
inherit ApiDtoBase()
member val Barcode:String = null with get,set
member val FirstName:String = null with get,set
member val LastName:String = null with get,set
member val Email:String = null with get,set
member val Phone:String = null with get,set
member val UserType:Nullable<Int32> = new Nullable<Int32>() with get,set
member val Page:Nullable<Int32> = new Nullable<Int32>() with get,set
type RestrictedResourceType =
| Store = 0
| Chain = 1
| User = 2
| Undefined = 3
[<AllowNullLiteral>]
type SearchUsersRequest() =
inherit SearchUsersRequestDto()
///<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>
///Filter by First Name
///</summary>
[<ApiMember(DataType="string", Description="Filter by First Name", Name="FirstName", ParameterType="query")>]
member val FirstName:String = null with get,set
///<summary>
///Filter by Last Name
///</summary>
[<ApiMember(DataType="string", Description="Filter by Last Name", Name="LastName", ParameterType="query")>]
member val LastName:String = null with get,set
///<summary>
///StoreId OR ChainId is required
///</summary>
[<ApiMember(DataType="integer", Description="StoreId OR ChainId is required", Name="StoreId", ParameterType="query")>]
member val StoreId:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///StoreId OR ChainId is required
///</summary>
[<ApiMember(DataType="string", Description="StoreId OR ChainId is required", Name="ChainId", ParameterType="query")>]
member val ChainId:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///Filter by barcode
///</summary>
[<ApiMember(DataType="string", Description="Filter by barcode", Name="Barcode", ParameterType="query")>]
member val Barcode:String = null with get,set
///<summary>
///Filter by Email Address
///</summary>
[<ApiMember(DataType="string", Description="Filter by Email Address", Name="Email", ParameterType="query")>]
member val Email:String = null with get,set
///<summary>
///Filter by Phone Number
///</summary>
[<ApiMember(DataType="string", Description="Filter by Phone Number", Name="Phone", ParameterType="query")>]
member val Phone:String = null with get,set
///<summary>
///Filter by ClubReady User Type
///</summary>
[<ApiMember(DataType="integer", Description="Filter by ClubReady User Type", Name="UserType", ParameterType="query")>]
member val UserType:Nullable<Int32> = new Nullable<Int32>() with get,set
///<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")>]
member val Page:Nullable<Int32> = new Nullable<Int32>() with get,set
member val RestrictedId:Nullable<Int32> = new Nullable<Int32>() with get,set
member val RestrictedResourceType:RestrictedResourceType = new RestrictedResourceType() with get,set
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: application/xml