ClubReady Api

GetAllUsersRequest

The following routes are available for this service:
GET	/club/{StoreId}/Users/all	Get all Users for club

import 'package:servicestack/servicestack.dart';

class ApiDtoBase implements IConvertible
{
    String? ApiKey;
    int? StoreId;
    int? ChainId;

    ApiDtoBase({this.ApiKey,this.StoreId,this.ChainId});
    ApiDtoBase.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ApiKey = json['ApiKey'];
        StoreId = json['StoreId'];
        ChainId = json['ChainId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ApiKey': ApiKey,
        'StoreId': StoreId,
        'ChainId': ChainId
    };

    getTypeName() => "ApiDtoBase";
    TypeContext? context = _ctx;
}

class GetAllUsersRequestDto extends ApiDtoBase implements IConvertible
{
    bool? IncludeDeleted;

    GetAllUsersRequestDto({this.IncludeDeleted});
    GetAllUsersRequestDto.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        IncludeDeleted = json['IncludeDeleted'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'IncludeDeleted': IncludeDeleted
    });

    getTypeName() => "GetAllUsersRequestDto";
    TypeContext? context = _ctx;
}

enum RestrictedResourceType
{
    Store,
    Chain,
    User,
    Undefined,
}

class GetAllUsersRequest extends GetAllUsersRequestDto implements IRestrictedApiRequest, IConvertible
{
    /**
    * Api Key - grants access to resources
    */
    // @ApiMember(DataType="string", Description="Api Key - grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")
    String? ApiKey;

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

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

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

    /**
    * 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")
    int? PageSize;

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

    int? RestrictedId;
    RestrictedResourceType? RestrictedResourceType;

    GetAllUsersRequest({this.ApiKey,this.ChainId,this.StoreId,this.IncludeDeleted,this.PageSize,this.PageNumber,this.RestrictedId,this.RestrictedResourceType});
    GetAllUsersRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        ApiKey = json['ApiKey'];
        ChainId = json['ChainId'];
        StoreId = json['StoreId'];
        IncludeDeleted = json['IncludeDeleted'];
        PageSize = json['PageSize'];
        PageNumber = json['PageNumber'];
        RestrictedId = json['RestrictedId'];
        RestrictedResourceType = JsonConverters.fromJson(json['RestrictedResourceType'],'RestrictedResourceType',context!);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'ApiKey': ApiKey,
        'ChainId': ChainId,
        'StoreId': StoreId,
        'IncludeDeleted': IncludeDeleted,
        'PageSize': PageSize,
        'PageNumber': PageNumber,
        'RestrictedId': RestrictedId,
        'RestrictedResourceType': JsonConverters.toJson(RestrictedResourceType,'RestrictedResourceType',context!)
    });

    getTypeName() => "GetAllUsersRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'www.clubready.com', types: <String, TypeInfo> {
    'ApiDtoBase': TypeInfo(TypeOf.Class, create:() => ApiDtoBase()),
    'GetAllUsersRequestDto': TypeInfo(TypeOf.Class, create:() => GetAllUsersRequestDto()),
    'RestrictedResourceType': TypeInfo(TypeOf.Enum, enumValues:RestrictedResourceType.values),
    'GetAllUsersRequest': TypeInfo(TypeOf.Class, create:() => GetAllUsersRequest()),
});

Dart GetAllUsersRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

[{"UserId":0,"Prospect":false,"Member":false,"DateAdded":"0001-01-01T00:00:00.0000000","Email":"String","FirstName":"String","LastName":"String","StoreId":0,"Username":"String","Address":"String","City":"String","State":"String","Zip":"String","Barcode":"String","Phone":"String","CellPhone":"String","ExternalUserId":"String","ProspectTypeName":"String","DateOfBirth":"String","MemberSinceDate":"String","MembershipExpiresDate":"String","MembershipEndedDate":"String","EmailOptOut":false,"SmsOptOut":false,"SmsOptIn":false,"ReferralTypeId":0,"ReferralTypeName":"String"}]