| All Verbs | /query/orders |
|---|
import 'package:servicestack/servicestack.dart';
// @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;
}
// @DataContract
class Order implements IConvertible
{
// @DataMember
int? id;
// @DataMember
String? customerId;
// @DataMember
int? employeeId;
// @DataMember
DateTime? orderDate;
// @DataMember
DateTime? requiredDate;
// @DataMember
DateTime? shippedDate;
// @DataMember
int? shipVia;
// @DataMember
double? freight;
// @DataMember
String? shipName;
// @DataMember
String? shipAddress;
// @DataMember
String? shipCity;
// @DataMember
String? shipRegion;
// @DataMember
String? shipPostalCode;
// @DataMember
String? shipCountry;
Order({this.id,this.customerId,this.employeeId,this.orderDate,this.requiredDate,this.shippedDate,this.shipVia,this.freight,this.shipName,this.shipAddress,this.shipCity,this.shipRegion,this.shipPostalCode,this.shipCountry});
Order.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
id = json['id'];
customerId = json['customerId'];
employeeId = json['employeeId'];
orderDate = JsonConverters.fromJson(json['orderDate'],'DateTime',context!);
requiredDate = JsonConverters.fromJson(json['requiredDate'],'DateTime',context!);
shippedDate = JsonConverters.fromJson(json['shippedDate'],'DateTime',context!);
shipVia = json['shipVia'];
freight = JsonConverters.toDouble(json['freight']);
shipName = json['shipName'];
shipAddress = json['shipAddress'];
shipCity = json['shipCity'];
shipRegion = json['shipRegion'];
shipPostalCode = json['shipPostalCode'];
shipCountry = json['shipCountry'];
return this;
}
Map<String, dynamic> toJson() => {
'id': id,
'customerId': customerId,
'employeeId': employeeId,
'orderDate': JsonConverters.toJson(orderDate,'DateTime',context!),
'requiredDate': JsonConverters.toJson(requiredDate,'DateTime',context!),
'shippedDate': JsonConverters.toJson(shippedDate,'DateTime',context!),
'shipVia': shipVia,
'freight': freight,
'shipName': shipName,
'shipAddress': shipAddress,
'shipCity': shipCity,
'shipRegion': shipRegion,
'shipPostalCode': shipPostalCode,
'shipCountry': shipCountry
};
getTypeName() => "Order";
TypeContext? context = _ctx;
}
class QueryOrders extends QueryDb<Order> implements IConvertible
{
double? freight;
QueryOrders({this.freight});
QueryOrders.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
freight = JsonConverters.toDouble(json['freight']);
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'freight': freight
});
getTypeName() => "QueryOrders";
TypeContext? context = _ctx;
}
// @DataContract
class Customer implements IConvertible
{
// @DataMember
String? id;
// @DataMember
String? companyName;
// @DataMember
String? contactName;
// @DataMember
String? contactTitle;
// @DataMember
String? address;
// @DataMember
String? city;
// @DataMember
String? region;
// @DataMember
String? postalCode;
// @DataMember
String? country;
// @DataMember
String? phone;
// @DataMember
String? fax;
Customer({this.id,this.companyName,this.contactName,this.contactTitle,this.address,this.city,this.region,this.postalCode,this.country,this.phone,this.fax});
Customer.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
id = json['id'];
companyName = json['companyName'];
contactName = json['contactName'];
contactTitle = json['contactTitle'];
address = json['address'];
city = json['city'];
region = json['region'];
postalCode = json['postalCode'];
country = json['country'];
phone = json['phone'];
fax = json['fax'];
return this;
}
Map<String, dynamic> toJson() => {
'id': id,
'companyName': companyName,
'contactName': contactName,
'contactTitle': contactTitle,
'address': address,
'city': city,
'region': region,
'postalCode': postalCode,
'country': country,
'phone': phone,
'fax': fax
};
getTypeName() => "Customer";
TypeContext? context = _ctx;
}
// @DataContract
class QueryResponse<Customer> implements IConvertible
{
// @DataMember(Order=1)
int? offset;
// @DataMember(Order=2)
int? total;
// @DataMember(Order=3)
List<Customer>? 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<Customer>',context!),
'meta': meta,
'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!)
};
getTypeName() => "QueryResponse<$Customer>";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'northwind.netcore.io', types: <String, TypeInfo> {
'Order': TypeInfo(TypeOf.Class, create:() => Order()),
'QueryOrders': TypeInfo(TypeOf.Class, create:() => QueryOrders()),
'List<Order>': TypeInfo(TypeOf.Class, create:() => <Order>[]),
'Customer': TypeInfo(TypeOf.Class, create:() => Customer()),
'QueryResponse<Customer>': TypeInfo(TypeOf.Class, create:() => QueryResponse<Customer>()),
});
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 /query/orders HTTP/1.1
Host: northwind.netcore.io
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
freight: 0,
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:
[
{
id: 0,
customerId: String,
employeeId: 0,
orderDate: 0001-01-01,
requiredDate: 0001-01-01,
shippedDate: 0001-01-01,
shipVia: 0,
freight: 0,
shipName: String,
shipAddress: String,
shipCity: String,
shipRegion: String,
shipPostalCode: String,
shipCountry: String
}
],
meta:
{
String: String
},
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}