| 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 .xml suffix or ?format=xml
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: clubready.com
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ArrayOfGetAllUsersResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubReady.Core.Api.Models">
<GetAllUsersResponse>
<Address>String</Address>
<Barcode>String</Barcode>
<CellPhone>String</CellPhone>
<City>String</City>
<DateAdded>0001-01-01T00:00:00</DateAdded>
<DateOfBirth>String</DateOfBirth>
<Email>String</Email>
<EmailOptOut>false</EmailOptOut>
<ExternalUserId>String</ExternalUserId>
<FirstName>String</FirstName>
<LastName>String</LastName>
<Member>false</Member>
<MemberSinceDate>String</MemberSinceDate>
<MembershipEndedDate>String</MembershipEndedDate>
<MembershipExpiresDate>String</MembershipExpiresDate>
<Phone>String</Phone>
<Prospect>false</Prospect>
<ProspectTypeName>String</ProspectTypeName>
<ReferralTypeId>0</ReferralTypeId>
<ReferralTypeName>String</ReferralTypeName>
<SmsOptIn>false</SmsOptIn>
<SmsOptOut>false</SmsOptOut>
<State>String</State>
<StoreId>0</StoreId>
<UserId>0</UserId>
<Username>String</Username>
<Zip>String</Zip>
</GetAllUsersResponse>
</ArrayOfGetAllUsersResponse>