| GET | /cars |
|---|
import 'package:servicestack/servicestack.dart';
abstract class GetOperationUnTenanted<TResponse> implements IHasGetOptions, IGet
{
String? embed;
GetOperationUnTenanted({this.embed});
GetOperationUnTenanted.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
embed = json['embed'];
return this;
}
Map<String, dynamic> toJson() => {
'embed': embed
};
getTypeName() => "GetOperationUnTenanted<$TResponse>";
TypeContext? context = _ctx;
}
abstract class SearchOperationUnTenanted<TResponse> extends GetOperationUnTenanted<TResponse> implements IHasSearchOptions
{
String? distinct;
int? limit;
int? offset;
String? sort;
String? filter;
String? search;
SearchOperationUnTenanted({this.distinct,this.limit,this.offset,this.sort,this.filter,this.search});
SearchOperationUnTenanted.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
distinct = json['distinct'];
limit = json['limit'];
offset = json['offset'];
sort = json['sort'];
filter = json['filter'];
search = json['search'];
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'distinct': distinct,
'limit': limit,
'offset': offset,
'sort': sort,
'filter': filter,
'search': search
});
getTypeName() => "SearchOperationUnTenanted<$TResponse>";
TypeContext? context = _ctx;
}
abstract class SearchOperationTenanted<TResponse> extends SearchOperationUnTenanted<TResponse> implements ITenantedRequest
{
String? organisationId;
SearchOperationTenanted({this.organisationId});
SearchOperationTenanted.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
organisationId = json['organisationId'];
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'organisationId': organisationId
});
getTypeName() => "SearchOperationTenanted<$TResponse>";
TypeContext? context = _ctx;
}
enum SortDirection
{
Ascending,
Descending,
}
class Sorting implements IConvertible
{
String? by;
SortDirection? direction;
Sorting({this.by,this.direction});
Sorting.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
by = json['by'];
direction = JsonConverters.fromJson(json['direction'],'SortDirection',context!);
return this;
}
Map<String, dynamic> toJson() => {
'by': by,
'direction': JsonConverters.toJson(direction,'SortDirection',context!)
};
getTypeName() => "Sorting";
TypeContext? context = _ctx;
}
class Filtering implements IConvertible
{
List<String>? fields;
String? search;
Filtering({this.fields,this.search});
Filtering.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
fields = JsonConverters.fromJson(json['fields'],'List<String>',context!);
search = json['search'];
return this;
}
Map<String, dynamic> toJson() => {
'fields': JsonConverters.toJson(fields,'List<String>',context!),
'search': search
};
getTypeName() => "Filtering";
TypeContext? context = _ctx;
}
class SearchMetadata implements IConvertible
{
int? total;
int? limit;
int? offset;
Sorting? sort;
Filtering? filter;
SearchMetadata({this.total,this.limit,this.offset,this.sort,this.filter});
SearchMetadata.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
total = json['total'];
limit = json['limit'];
offset = json['offset'];
sort = JsonConverters.fromJson(json['sort'],'Sorting',context!);
filter = JsonConverters.fromJson(json['filter'],'Filtering',context!);
return this;
}
Map<String, dynamic> toJson() => {
'total': total,
'limit': limit,
'offset': offset,
'sort': JsonConverters.toJson(sort,'Sorting',context!),
'filter': JsonConverters.toJson(filter,'Filtering',context!)
};
getTypeName() => "SearchMetadata";
TypeContext? context = _ctx;
}
abstract class SearchOperationResponse
{
SearchMetadata? metadata;
SearchOperationResponse({this.metadata});
SearchOperationResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
metadata = JsonConverters.fromJson(json['metadata'],'SearchMetadata',context!);
return this;
}
Map<String, dynamic> toJson() => {
'metadata': JsonConverters.toJson(metadata,'SearchMetadata',context!)
};
getTypeName() => "SearchOperationResponse";
TypeContext? context = _ctx;
}
class CarManufacturer implements IConvertible
{
int? year;
String? make;
String? model;
CarManufacturer({this.year,this.make,this.model});
CarManufacturer.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
year = json['year'];
make = json['make'];
model = json['model'];
return this;
}
Map<String, dynamic> toJson() => {
'year': year,
'make': make,
'model': model
};
getTypeName() => "CarManufacturer";
TypeContext? context = _ctx;
}
class CarLicensePlate implements IConvertible
{
String? jurisdiction;
String? number;
CarLicensePlate({this.jurisdiction,this.number});
CarLicensePlate.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
jurisdiction = json['jurisdiction'];
number = json['number'];
return this;
}
Map<String, dynamic> toJson() => {
'jurisdiction': jurisdiction,
'number': number
};
getTypeName() => "CarLicensePlate";
TypeContext? context = _ctx;
}
class CarOwner implements IConvertible
{
String? id;
CarOwner({this.id});
CarOwner.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
id = json['id'];
return this;
}
Map<String, dynamic> toJson() => {
'id': id
};
getTypeName() => "CarOwner";
TypeContext? context = _ctx;
}
class CarManager implements IConvertible
{
String? id;
CarManager({this.id});
CarManager.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
id = json['id'];
return this;
}
Map<String, dynamic> toJson() => {
'id': id
};
getTypeName() => "CarManager";
TypeContext? context = _ctx;
}
class Car implements IIdentifiableResource, IConvertible
{
CarManufacturer? manufacturer;
CarLicensePlate? plate;
CarOwner? owner;
List<CarManager>? managers;
String? status;
bool? altered;
String? id;
Car({this.manufacturer,this.plate,this.owner,this.managers,this.status,this.altered,this.id});
Car.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
manufacturer = JsonConverters.fromJson(json['manufacturer'],'CarManufacturer',context!);
plate = JsonConverters.fromJson(json['plate'],'CarLicensePlate',context!);
owner = JsonConverters.fromJson(json['owner'],'CarOwner',context!);
managers = JsonConverters.fromJson(json['managers'],'List<CarManager>',context!);
status = json['status'];
altered = json['altered'];
id = json['id'];
return this;
}
Map<String, dynamic> toJson() => {
'manufacturer': JsonConverters.toJson(manufacturer,'CarManufacturer',context!),
'plate': JsonConverters.toJson(plate,'CarLicensePlate',context!),
'owner': JsonConverters.toJson(owner,'CarOwner',context!),
'managers': JsonConverters.toJson(managers,'List<CarManager>',context!),
'status': status,
'altered': altered,
'id': id
};
getTypeName() => "Car";
TypeContext? context = _ctx;
}
class SearchAllCarsResponse extends SearchOperationResponse implements IConvertible
{
ResponseStatus? responseStatus;
List<Car>? cars;
SearchAllCarsResponse({this.responseStatus,this.cars});
SearchAllCarsResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
cars = JsonConverters.fromJson(json['cars'],'List<Car>',context!);
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
'cars': JsonConverters.toJson(cars,'List<Car>',context!)
});
getTypeName() => "SearchAllCarsResponse";
TypeContext? context = _ctx;
}
class SearchAllCarsRequest extends SearchOperationTenanted<SearchAllCarsResponse> implements IConvertible
{
SearchAllCarsRequest();
SearchAllCarsRequest.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() => "SearchAllCarsRequest";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'staging_api.billiecart.com.au', types: <String, TypeInfo> {
'GetOperationUnTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
'SearchOperationUnTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
'SearchOperationTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
'SortDirection': TypeInfo(TypeOf.Enum, enumValues:SortDirection.values),
'Sorting': TypeInfo(TypeOf.Class, create:() => Sorting()),
'Filtering': TypeInfo(TypeOf.Class, create:() => Filtering()),
'SearchMetadata': TypeInfo(TypeOf.Class, create:() => SearchMetadata()),
'SearchOperationResponse': TypeInfo(TypeOf.AbstractClass),
'CarManufacturer': TypeInfo(TypeOf.Class, create:() => CarManufacturer()),
'CarLicensePlate': TypeInfo(TypeOf.Class, create:() => CarLicensePlate()),
'CarOwner': TypeInfo(TypeOf.Class, create:() => CarOwner()),
'CarManager': TypeInfo(TypeOf.Class, create:() => CarManager()),
'Car': TypeInfo(TypeOf.Class, create:() => Car()),
'List<CarManager>': TypeInfo(TypeOf.Class, create:() => <CarManager>[]),
'SearchAllCarsResponse': TypeInfo(TypeOf.Class, create:() => SearchAllCarsResponse()),
'List<Car>': TypeInfo(TypeOf.Class, create:() => <Car>[]),
'SearchAllCarsRequest': TypeInfo(TypeOf.Class, create:() => SearchAllCarsRequest()),
});
Dart SearchAllCarsRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /cars HTTP/1.1 Host: staging-api.billiecart.com.au Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"cars":[{"manufacturer":{"year":0,"make":"String","model":"String"},"plate":{"jurisdiction":"String","number":"String"},"owner":{"id":"String"},"managers":[{"id":"String"}],"status":"String","altered":false,"id":"String"}],"metadata":{"total":0,"limit":0,"offset":0,"sort":{"by":"String","direction":"Ascending"},"filter":{"fields":["String"],"search":"String"}}}