| Required role: | API |
| All Verbs | /api/Query/Product |
|---|
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 ProductInstance implements IConvertible
{
int? ProductId;
String? Group;
String? Name;
String? Description;
double? Price;
double? VAT;
double? TotalPrice;
int? ProductType;
bool? Deleted;
bool? Demo;
int? UsageCount;
int? StockLevel;
int? ReorderFlag;
bool? VisibleOnline;
ProductInstance({this.ProductId,this.Group,this.Name,this.Description,this.Price,this.VAT,this.TotalPrice,this.ProductType,this.Deleted,this.Demo,this.UsageCount,this.StockLevel,this.ReorderFlag,this.VisibleOnline});
ProductInstance.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
ProductId = json['ProductId'];
Group = json['Group'];
Name = json['Name'];
Description = json['Description'];
Price = JsonConverters.toDouble(json['Price']);
VAT = JsonConverters.toDouble(json['VAT']);
TotalPrice = JsonConverters.toDouble(json['TotalPrice']);
ProductType = json['ProductType'];
Deleted = json['Deleted'];
Demo = json['Demo'];
UsageCount = json['UsageCount'];
StockLevel = json['StockLevel'];
ReorderFlag = json['ReorderFlag'];
VisibleOnline = json['VisibleOnline'];
return this;
}
Map<String, dynamic> toJson() => {
'ProductId': ProductId,
'Group': Group,
'Name': Name,
'Description': Description,
'Price': Price,
'VAT': VAT,
'TotalPrice': TotalPrice,
'ProductType': ProductType,
'Deleted': Deleted,
'Demo': Demo,
'UsageCount': UsageCount,
'StockLevel': StockLevel,
'ReorderFlag': ReorderFlag,
'VisibleOnline': VisibleOnline
};
getTypeName() => "ProductInstance";
TypeContext? context = _ctx;
}
// @AutoQueryViewer(Description="", IconUrl="octicon:database", Title="Product")
class FindProduct extends QueryDb<ProductInstance> implements IConvertible
{
FindProduct();
FindProduct.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() => "FindProduct";
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> {
'ProductInstance': TypeInfo(TypeOf.Class, create:() => ProductInstance()),
'FindProduct': TypeInfo(TypeOf.Class, create:() => FindProduct()),
'List<ProductInstance>': TypeInfo(TypeOf.Class, create:() => <ProductInstance>[]),
});
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/Query/Product 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:
[
{
ProductId: 0,
Group: String,
Name: String,
Description: String,
Price: 0,
VAT: 0,
TotalPrice: 0,
ProductType: 0,
Deleted: False,
Demo: False,
UsageCount: 0,
StockLevel: 0,
ReorderFlag: 0,
VisibleOnline: False
}
],
Meta:
{
String: String
},
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}