GET | /customers | ||
---|---|---|---|
GET | /customers/{CustomerId} |
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;
}
class Customers implements IConvertible
{
int? customerId;
// @computed()
String? displayName;
// @required()
String? firstName;
// @required()
String? lastName;
int? supportRepId;
String? company;
String? address;
String? city;
String? state;
String? country;
String? postalCode;
String? phone;
String? fax;
// @required()
String? email;
Customers({this.customerId,this.displayName,this.firstName,this.lastName,this.supportRepId,this.company,this.address,this.city,this.state,this.country,this.postalCode,this.phone,this.fax,this.email});
Customers.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
customerId = json['customerId'];
displayName = json['displayName'];
firstName = json['firstName'];
lastName = json['lastName'];
supportRepId = json['supportRepId'];
company = json['company'];
address = json['address'];
city = json['city'];
state = json['state'];
country = json['country'];
postalCode = json['postalCode'];
phone = json['phone'];
fax = json['fax'];
email = json['email'];
return this;
}
Map<String, dynamic> toJson() => {
'customerId': customerId,
'displayName': displayName,
'firstName': firstName,
'lastName': lastName,
'supportRepId': supportRepId,
'company': company,
'address': address,
'city': city,
'state': state,
'country': country,
'postalCode': postalCode,
'phone': phone,
'fax': fax,
'email': email
};
getTypeName() => "Customers";
TypeContext? context = _ctx;
}
class QueryCustomers extends QueryDb<Customers> implements IGet, IConvertible
{
int? customerId;
QueryCustomers({this.customerId});
QueryCustomers.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
customerId = json['customerId'];
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'customerId': customerId
});
getTypeName() => "QueryCustomers";
TypeContext? context = _ctx;
}
class Albums implements IConvertible
{
int? albumId;
// @required()
String? title;
int? artistId;
Albums({this.albumId,this.title,this.artistId});
Albums.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
albumId = json['albumId'];
title = json['title'];
artistId = json['artistId'];
return this;
}
Map<String, dynamic> toJson() => {
'albumId': albumId,
'title': title,
'artistId': artistId
};
getTypeName() => "Albums";
TypeContext? context = _ctx;
}
// @DataContract
class QueryResponse<T> implements IConvertible
{
// @DataMember(Order=1)
int? offset;
// @DataMember(Order=2)
int? total;
// @DataMember(Order=3)
List<Albums>? 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<Albums>',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<Albums>',context!),
'meta': meta,
'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!)
};
getTypeName() => "QueryResponse<$T>";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'chinook.netcore.io', types: <String, TypeInfo> {
'Customers': TypeInfo(TypeOf.Class, create:() => Customers()),
'QueryCustomers': TypeInfo(TypeOf.Class, create:() => QueryCustomers()),
'List<Customers>': TypeInfo(TypeOf.Class, create:() => <Customers>[]),
'Albums': TypeInfo(TypeOf.Class, create:() => Albums()),
'List<Albums>': TypeInfo(TypeOf.Class, create:() => <Albums>[]),
});
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.
GET /customers HTTP/1.1 Host: chinook.netcore.io Accept: text/jsv
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { offset: 0, total: 0, results: [ { customerId: 0, displayName: String String, firstName: String, lastName: String, supportRepId: 0, company: String, address: String, city: String, state: String, country: String, postalCode: String, phone: String, fax: String, email: String } ], meta: { String: String }, responseStatus: { errorCode: String, message: String, stackTrace: String, errors: [ { errorCode: String, fieldName: String, message: String, meta: { String: String } } ], meta: { String: String } } }