ClubReady Api

<back to all web services

SearchUsersRequest

using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using ClubReady.Web.Api.Members.Model;
using ClubReady.Core.Api.Models;
using ClubReady.Web.Api;

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

    public partial class SearchUsersRequestDto
        : ApiDtoBase
    {
        public virtual string Barcode { get; set; }
        public virtual string FirstName { get; set; }
        public virtual string LastName { get; set; }
        public virtual string Email { get; set; }
        public virtual string Phone { get; set; }
        public virtual int? UserType { get; set; }
        public virtual int? Page { get; set; }
    }

}

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

}

namespace ClubReady.Web.Api.Members.Model
{
    public partial class SearchUsersRequest
        : SearchUsersRequestDto, IRestrictedApiRequest
    {
        ///<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>
        ///Filter by First Name
        ///</summary>
        [ApiMember(DataType="string", Description="Filter by First Name", Name="FirstName", ParameterType="query")]
        public virtual string FirstName { get; set; }

        ///<summary>
        ///Filter by Last Name
        ///</summary>
        [ApiMember(DataType="string", Description="Filter by Last Name", Name="LastName", ParameterType="query")]
        public virtual string LastName { get; set; }

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

        ///<summary>
        ///StoreId OR ChainId is required
        ///</summary>
        [ApiMember(DataType="string", Description="StoreId OR ChainId is required", Name="ChainId", ParameterType="query")]
        public virtual int? ChainId { get; set; }

        ///<summary>
        ///Filter by barcode
        ///</summary>
        [ApiMember(DataType="string", Description="Filter by barcode", Name="Barcode", ParameterType="query")]
        public virtual string Barcode { get; set; }

        ///<summary>
        ///Filter by Email Address
        ///</summary>
        [ApiMember(DataType="string", Description="Filter by Email Address", Name="Email", ParameterType="query")]
        public virtual string Email { get; set; }

        ///<summary>
        ///Filter by Phone Number
        ///</summary>
        [ApiMember(DataType="string", Description="Filter by Phone Number", Name="Phone", ParameterType="query")]
        public virtual string Phone { get; set; }

        ///<summary>
        ///Filter by ClubReady User Type
        ///</summary>
        [ApiMember(DataType="integer", Description="Filter by ClubReady User Type", Name="UserType", ParameterType="query")]
        public virtual int? UserType { get; set; }

        ///<summary>
        ///Page of users to retrieve. Pulls back 100 users per page.
        ///</summary>
        [ApiMember(DataType="integer", Description="Page of users to retrieve. Pulls back 100 users per page.", Name="Page", ParameterType="query")]
        public virtual int? Page { get; set; }

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

}

C# SearchUsersRequest DTOs

GET /users/find HTTP/1.1 
Host: clubready.com 
Accept: application/xml