ClubReady Api

<back to all web services

GetAllUsersRequest

The following routes are available for this service:
GET/club/{StoreId}/Users/allGet all Users for club
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using ClubReady.Web.Api.Club.Models;
using ClubReady.Core.Api.Models;
using ClubReady.Core.Api;
using ClubReady.Web.Api;

namespace ClubReady.Core.Api
{
    public partial class ApiDtoBase
        : IApiDtoBase
    {
        public virtual string ApiKey { get; set; }
        public virtual int? StoreId { get; set; }
        public virtual int? ChainId { get; set; }
    }

}

namespace ClubReady.Core.Api.Models
{
    public partial class GetAllUsersRequestDto
        : ApiDtoBase
    {
        public virtual bool IncludeDeleted { get; set; }
    }

}

namespace ClubReady.Web.Api
{
    public enum RestrictedResourceType
    {
        Store,
        Chain,
        User,
        Undefined,
    }

}

namespace ClubReady.Web.Api.Club.Models
{
    public partial class GetAllUsersRequest
        : GetAllUsersRequestDto, IRestrictedApiRequest
    {
        ///<summary>
        ///IP address of the end user
        ///</summary>
        [ApiMember(Description="IP address of the end user", Name="X-Forwarded-For", ParameterType="header")]
        public virtual string XForwardedFor { get; set; }

        ///<summary>
        ///Api Key - grants access to resources
        ///</summary>
        [ApiMember(DataType="string", Description="Api Key - grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")]
        public virtual string ApiKey { get; set; }

        ///<summary>
        ///Chain ID
        ///</summary>
        [ApiMember(DataType="integer", Description="Chain ID", Name="ChainId", ParameterType="query")]
        public virtual int? ChainId { get; set; }

        ///<summary>
        ///Store ID
        ///</summary>
        [ApiMember(DataType="integer", Description="Store ID", IsRequired=true, Name="StoreId", ParameterType="query")]
        public virtual int? StoreId { 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")]
        public virtual bool IncludeDeleted { 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")]
        public virtual int? PageSize { get; set; }

        ///<summary>
        ///Page number to retrieve.
        ///</summary>
        [ApiMember(DataType="int", Description="Page number to retrieve.", Name="PageNumber", ParameterType="query")]
        public virtual int? PageNumber { get; set; }

        public virtual int? RestrictedId { get; set; }
        public virtual RestrictedResourceType RestrictedResourceType { get; set; }
    }

}

C# GetAllUsersRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + 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: www.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>