ClubManager.Api

FindOrder

**Requires Authentication**
Required role:	API

The following routes are available for this service:
All Verbs	/api/Query/Order

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 OrderInstance implements IConvertible
{
    int? OrderId;
    String? OrderNumber;
    String? OrderCode;
    double? OrderAmount;
    DateTime? ReceivedDateTime;
    DateTime? CompletedDateTime;
    DateTime? RefundedDateTime;
    double? OrderFee;

    OrderInstance({this.OrderId,this.OrderNumber,this.OrderCode,this.OrderAmount,this.ReceivedDateTime,this.CompletedDateTime,this.RefundedDateTime,this.OrderFee});
    OrderInstance.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        OrderId = json['OrderId'];
        OrderNumber = json['OrderNumber'];
        OrderCode = json['OrderCode'];
        OrderAmount = JsonConverters.toDouble(json['OrderAmount']);
        ReceivedDateTime = JsonConverters.fromJson(json['ReceivedDateTime'],'DateTime',context!);
        CompletedDateTime = JsonConverters.fromJson(json['CompletedDateTime'],'DateTime',context!);
        RefundedDateTime = JsonConverters.fromJson(json['RefundedDateTime'],'DateTime',context!);
        OrderFee = JsonConverters.toDouble(json['OrderFee']);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'OrderId': OrderId,
        'OrderNumber': OrderNumber,
        'OrderCode': OrderCode,
        'OrderAmount': OrderAmount,
        'ReceivedDateTime': JsonConverters.toJson(ReceivedDateTime,'DateTime',context!),
        'CompletedDateTime': JsonConverters.toJson(CompletedDateTime,'DateTime',context!),
        'RefundedDateTime': JsonConverters.toJson(RefundedDateTime,'DateTime',context!),
        'OrderFee': OrderFee
    };

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

// @AutoQueryViewer(Description="", IconUrl="octicon:database", Title="Order")
class FindOrder extends QueryDb<OrderInstance> implements IConvertible
{
    FindOrder();
    FindOrder.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() => "FindOrder";
    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> {
    'OrderInstance': TypeInfo(TypeOf.Class, create:() => OrderInstance()),
    'FindOrder': TypeInfo(TypeOf.Class, create:() => FindOrder()),
    'List<OrderInstance>': TypeInfo(TypeOf.Class, create:() => <OrderInstance>[]),
});

Dart FindOrder DTOs

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

HTTP + CSV

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

POST /api/Query/Order HTTP/1.1 
Host: api.clubmanagercentral.com 
Accept: text/csv
Content-Type: text/csv
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/csv
Content-Length: length

{"Offset":0,"Total":0,"Results":[{"OrderId":0,"OrderNumber":"String","OrderCode":"String","OrderAmount":0,"ReceivedDateTime":"0001-01-01T00:00:00.0000000","CompletedDateTime":"0001-01-01T00:00:00.0000000","RefundedDateTime":"0001-01-01T00:00:00.0000000","OrderFee":0}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}