ClubReady Api

<back to all web services

GetAllUsersRequest

export class ApiDtoBase implements IApiDtoBase
{
    public ApiKey?: string;
    public StoreId?: number;
    public ChainId?: number;

    public constructor(init?: Partial<ApiDtoBase>) { (Object as any).assign(this, init); }
}

export class GetAllUsersRequestDto extends ApiDtoBase
{
    public IncludeDeleted: boolean;

    public constructor(init?: Partial<GetAllUsersRequestDto>) { super(init); (Object as any).assign(this, init); }
}

export enum RestrictedResourceType
{
    Store = 'Store',
    Chain = 'Chain',
    User = 'User',
    Undefined = 'Undefined',
}

export class GetAllUsersRequest extends GetAllUsersRequestDto implements IRestrictedApiRequest
{
    /**
    * IP address of the end user
    */
    // @ApiMember(Description="IP address of the end user", Name="X-Forwarded-For", ParameterType="header")
    public XForwardedFor: string;

    /**
    * Api Key - grants access to resources
    */
    // @ApiMember(DataType="string", Description="Api Key - grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")
    public ApiKey: string;

    /**
    * Chain ID
    */
    // @ApiMember(DataType="integer", Description="Chain ID", Name="ChainId", ParameterType="query")
    public ChainId?: number;

    /**
    * Store ID
    */
    // @ApiMember(DataType="integer", Description="Store ID", IsRequired=true, Name="StoreId", ParameterType="query")
    public StoreId: number;

    /**
    * Include deleted users in result? (defaults to false)
    */
    // @ApiMember(DataType="bool", Description="Include deleted users in result? (defaults to false)", Name="IncludeDeleted", ParameterType="query")
    public IncludeDeleted: boolean;

    /**
    * Max number of records to include in the response.
    */
    // @ApiMember(DataType="int", Description="Max number of records to include in the response.", Name="PageSize", ParameterType="query")
    public PageSize?: number;

    /**
    * Page number to retrieve.
    */
    // @ApiMember(DataType="int", Description="Page number to retrieve.", Name="PageNumber", ParameterType="query")
    public PageNumber?: number;

    public RestrictedId?: number;
    public RestrictedResourceType: RestrictedResourceType;

    public constructor(init?: Partial<GetAllUsersRequest>) { super(init); (Object as any).assign(this, init); }
}

TypeScript GetAllUsersRequest DTOs

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>