ClubReady Api

<back to all web services

GetAllUsersRequest

import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static 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 String XForwardedFor = null;

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

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

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

        /**
        * 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 Boolean IncludeDeleted = null;

        /**
        * 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 Integer PageSize = null;

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

        public Integer RestrictedId = null;
        public RestrictedResourceType RestrictedResourceType = null;
        
        public String getXForwardedFor() { return XForwardedFor; }
        public GetAllUsersRequest setXForwardedFor(String value) { this.XForwardedFor = value; return this; }
        public String getApiKey() { return ApiKey; }
        public GetAllUsersRequest setApiKey(String value) { this.ApiKey = value; return this; }
        public Integer getChainId() { return ChainId; }
        public GetAllUsersRequest setChainId(Integer value) { this.ChainId = value; return this; }
        public Integer getStoreId() { return StoreId; }
        public GetAllUsersRequest setStoreId(Integer value) { this.StoreId = value; return this; }
        public Boolean isIncludeDeleted() { return IncludeDeleted; }
        public GetAllUsersRequest setIncludeDeleted(Boolean value) { this.IncludeDeleted = value; return this; }
        public Integer getPageSize() { return PageSize; }
        public GetAllUsersRequest setPageSize(Integer value) { this.PageSize = value; return this; }
        public Integer getPageNumber() { return PageNumber; }
        public GetAllUsersRequest setPageNumber(Integer value) { this.PageNumber = value; return this; }
        public Integer getRestrictedId() { return RestrictedId; }
        public GetAllUsersRequest setRestrictedId(Integer value) { this.RestrictedId = value; return this; }
        public RestrictedResourceType getRestrictedResourceType() { return RestrictedResourceType; }
        public GetAllUsersRequest setRestrictedResourceType(RestrictedResourceType value) { this.RestrictedResourceType = value; return this; }
    }

    public static class GetAllUsersRequestDto extends ApiDtoBase
    {
        public Boolean IncludeDeleted = null;
        
        public Boolean isIncludeDeleted() { return IncludeDeleted; }
        public GetAllUsersRequestDto setIncludeDeleted(Boolean value) { this.IncludeDeleted = value; return this; }
    }

    public static class ApiDtoBase implements IApiDtoBase
    {
        public String ApiKey = null;
        public Integer StoreId = null;
        public Integer ChainId = null;
        
        public String getApiKey() { return ApiKey; }
        public ApiDtoBase setApiKey(String value) { this.ApiKey = value; return this; }
        public Integer getStoreId() { return StoreId; }
        public ApiDtoBase setStoreId(Integer value) { this.StoreId = value; return this; }
        public Integer getChainId() { return ChainId; }
        public ApiDtoBase setChainId(Integer value) { this.ChainId = value; return this; }
    }

    public static enum RestrictedResourceType
    {
        Store,
        Chain,
        User,
        Undefined;
    }

}

Java 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>