| GET | /club/{StoreId}/Users/all | Get all Users for club |
|---|
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 GetAllUsersRequestDto() =
inherit ApiDtoBase()
member val IncludeDeleted:Boolean = new Boolean() with get,set
type RestrictedResourceType =
| Store = 0
| Chain = 1
| User = 2
| Undefined = 3
[<AllowNullLiteral>]
type GetAllUsersRequest() =
inherit GetAllUsersRequestDto()
///<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", IsRequired=true, Name="StoreId", ParameterType="query")>]
member val StoreId:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///Include deleted users in result? (defaults to false)
///</summary>
[<ApiMember(DataType="bool", Description="Include deleted users in result? (defaults to false)", Name="IncludeDeleted", ParameterType="query")>]
member val IncludeDeleted:Boolean = new Boolean() with get,set
///<summary>
///Max number of records to include in the response.
///</summary>
[<ApiMember(DataType="int", Description="Max number of records to include in the response.", Name="PageSize", ParameterType="query")>]
member val PageSize:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///Page number to retrieve.
///</summary>
[<ApiMember(DataType="int", Description="Page number to retrieve.", Name="PageNumber", ParameterType="query")>]
member val PageNumber: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 .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /club/{StoreId}/Users/all HTTP/1.1
Host: www.clubready.com
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
[
{
UserId: 0,
Prospect: False,
Member: False,
DateAdded: 0001-01-01,
Email: String,
FirstName: String,
LastName: String,
StoreId: 0,
Username: String,
Address: String,
City: String,
State: String,
Zip: String,
Barcode: String,
Phone: String,
CellPhone: String,
ExternalUserId: String,
ProspectTypeName: String,
DateOfBirth: String,
MemberSinceDate: String,
MembershipExpiresDate: String,
MembershipEndedDate: String,
EmailOptOut: False,
SmsOptOut: False,
SmsOptIn: False,
ReferralTypeId: 0,
ReferralTypeName: String
}
]