ClubManager.Api

<back to all web services

FindPaymentRecurrence

Requires Authentication
Required role:API
The following routes are available for this service:
All Verbs/api/Query/PaymentRecurrence
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

// @DataContract
abstract class QueryBase
{
    // @DataMember(Order=1)
    int? Skip;

    // @DataMember(Order=2)
    int? Take;

    // @DataMember(Order=3)
    String? OrderBy;

    // @DataMember(Order=4)
    String? OrderByDesc;

    // @DataMember(Order=5)
    String? Include;

    // @DataMember(Order=6)
    String? Fields;

    // @DataMember(Order=7)
    Map<String,String?>? Meta;

    QueryBase({this.Skip,this.Take,this.OrderBy,this.OrderByDesc,this.Include,this.Fields,this.Meta});
    QueryBase.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Skip = json['Skip'];
        Take = json['Take'];
        OrderBy = json['OrderBy'];
        OrderByDesc = json['OrderByDesc'];
        Include = json['Include'];
        Fields = json['Fields'];
        Meta = JsonConverters.toStringMap(json['Meta']);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Skip': Skip,
        'Take': Take,
        'OrderBy': OrderBy,
        'OrderByDesc': OrderByDesc,
        'Include': Include,
        'Fields': Fields,
        'Meta': Meta
    };

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

abstract class QueryDb<T> extends QueryBase
{
    QueryDb();
    QueryDb.fromJson(Map<String, dynamic> json) : super.fromJson(json);
    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson();
    getTypeName() => "QueryDb<$T>";
    TypeContext? context = _ctx;
}

class PaymentRecurrenceInstance implements IConvertible
{
    int? PaymentRecurrenceId;
    DateTime? CheckDate;
    DateTime? NextDate;
    DateTime? EndDate;
    double? Amount;
    int? Recurrence;
    int? PaymentType;
    bool? Deleted;
    // @References(typeof(MembershipInstance))
    int? MembershipId;

    bool? ChargePerLicense;
    double? LastPaymentAmount;
    int? LastPaymentMethodId;
    bool? Disabled;

    PaymentRecurrenceInstance({this.PaymentRecurrenceId,this.CheckDate,this.NextDate,this.EndDate,this.Amount,this.Recurrence,this.PaymentType,this.Deleted,this.MembershipId,this.ChargePerLicense,this.LastPaymentAmount,this.LastPaymentMethodId,this.Disabled});
    PaymentRecurrenceInstance.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        PaymentRecurrenceId = json['PaymentRecurrenceId'];
        CheckDate = JsonConverters.fromJson(json['CheckDate'],'DateTime',context!);
        NextDate = JsonConverters.fromJson(json['NextDate'],'DateTime',context!);
        EndDate = JsonConverters.fromJson(json['EndDate'],'DateTime',context!);
        Amount = JsonConverters.toDouble(json['Amount']);
        Recurrence = json['Recurrence'];
        PaymentType = json['PaymentType'];
        Deleted = json['Deleted'];
        MembershipId = json['MembershipId'];
        ChargePerLicense = json['ChargePerLicense'];
        LastPaymentAmount = JsonConverters.toDouble(json['LastPaymentAmount']);
        LastPaymentMethodId = json['LastPaymentMethodId'];
        Disabled = json['Disabled'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'PaymentRecurrenceId': PaymentRecurrenceId,
        'CheckDate': JsonConverters.toJson(CheckDate,'DateTime',context!),
        'NextDate': JsonConverters.toJson(NextDate,'DateTime',context!),
        'EndDate': JsonConverters.toJson(EndDate,'DateTime',context!),
        'Amount': Amount,
        'Recurrence': Recurrence,
        'PaymentType': PaymentType,
        'Deleted': Deleted,
        'MembershipId': MembershipId,
        'ChargePerLicense': ChargePerLicense,
        'LastPaymentAmount': LastPaymentAmount,
        'LastPaymentMethodId': LastPaymentMethodId,
        'Disabled': Disabled
    };

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

// @AutoQueryViewer(Description="", IconUrl="octicon:database", Title="PaymentRecurrence")
class FindPaymentRecurrence extends QueryDb<PaymentRecurrenceInstance> implements IConvertible
{
    FindPaymentRecurrence();
    FindPaymentRecurrence.fromJson(Map<String, dynamic> json) : super.fromJson(json);
    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson();
    getTypeName() => "FindPaymentRecurrence";
    TypeContext? context = _ctx;
}

// @DataContract
class QueryResponse<T> implements IConvertible
{
    // @DataMember(Order=1)
    int? Offset;

    // @DataMember(Order=2)
    int? Total;

    // @DataMember(Order=3)
    List<T>? Results;

    // @DataMember(Order=4)
    Map<String,String?>? Meta;

    // @DataMember(Order=5)
    ResponseStatus? ResponseStatus;

    QueryResponse({this.Offset,this.Total,this.Results,this.Meta,this.ResponseStatus});
    QueryResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Offset = json['Offset'];
        Total = json['Total'];
        Results = JsonConverters.fromJson(json['Results'],'List<${runtimeGenericTypeDefs(this,[0]).join(",")}>',context!);
        Meta = JsonConverters.toStringMap(json['Meta']);
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Offset': Offset,
        'Total': Total,
        'Results': JsonConverters.toJson(Results,'List<T>',context!),
        'Meta': Meta,
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "QueryResponse<$T>";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'api.clubmanagercentral.com', types: <String, TypeInfo> {
    'PaymentRecurrenceInstance': TypeInfo(TypeOf.Class, create:() => PaymentRecurrenceInstance()),
    'FindPaymentRecurrence': TypeInfo(TypeOf.Class, create:() => FindPaymentRecurrence()),
    'List<PaymentRecurrenceInstance>': TypeInfo(TypeOf.Class, create:() => <PaymentRecurrenceInstance>[]),
});

Dart FindPaymentRecurrence DTOs

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

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/Query/PaymentRecurrence HTTP/1.1 
Host: api.clubmanagercentral.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Skip: 0,
	Take: 0,
	OrderBy: String,
	OrderByDesc: String,
	Include: String,
	Fields: String,
	Meta: 
	{
		String: String
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Offset: 0,
	Total: 0,
	Results: 
	[
		{
			PaymentRecurrenceId: 0,
			CheckDate: 0001-01-01,
			NextDate: 0001-01-01,
			EndDate: 0001-01-01,
			Amount: 0,
			Recurrence: 0,
			PaymentType: 0,
			Deleted: False,
			MembershipId: 0,
			ChargePerLicense: False,
			LastPaymentAmount: 0,
			LastPaymentMethodId: 0,
			Disabled: False
		}
	],
	Meta: 
	{
		String: String
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}