GET | /tracks | ||
---|---|---|---|
GET | /tracks/{TrackId} |
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 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;
}
class MediaTypes implements IConvertible
{
int? mediaTypeId;
String? name;
MediaTypes({this.mediaTypeId,this.name});
MediaTypes.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
mediaTypeId = json['mediaTypeId'];
name = json['name'];
return this;
}
Map<String, dynamic> toJson() => {
'mediaTypeId': mediaTypeId,
'name': name
};
getTypeName() => "MediaTypes";
TypeContext? context = _ctx;
}
class Genres implements IConvertible
{
int? genreId;
String? name;
Genres({this.genreId,this.name});
Genres.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
genreId = json['genreId'];
name = json['name'];
return this;
}
Map<String, dynamic> toJson() => {
'genreId': genreId,
'name': name
};
getTypeName() => "Genres";
TypeContext? context = _ctx;
}
class Tracks implements IConvertible
{
int? trackId;
// @required()
String? name;
// @References(typeof(Albums))
int? albumId;
// @References(typeof(MediaTypes))
int? mediaTypeId;
// @References(typeof(Genres))
int? genreId;
String? composer;
int? milliseconds;
int? bytes;
double? unitPrice;
Albums? album;
MediaTypes? mediaType;
Genres? genre;
Tracks({this.trackId,this.name,this.albumId,this.mediaTypeId,this.genreId,this.composer,this.milliseconds,this.bytes,this.unitPrice,this.album,this.mediaType,this.genre});
Tracks.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
trackId = json['trackId'];
name = json['name'];
albumId = json['albumId'];
mediaTypeId = json['mediaTypeId'];
genreId = json['genreId'];
composer = json['composer'];
milliseconds = json['milliseconds'];
bytes = json['bytes'];
unitPrice = JsonConverters.toDouble(json['unitPrice']);
album = JsonConverters.fromJson(json['album'],'Albums',context!);
mediaType = JsonConverters.fromJson(json['mediaType'],'MediaTypes',context!);
genre = JsonConverters.fromJson(json['genre'],'Genres',context!);
return this;
}
Map<String, dynamic> toJson() => {
'trackId': trackId,
'name': name,
'albumId': albumId,
'mediaTypeId': mediaTypeId,
'genreId': genreId,
'composer': composer,
'milliseconds': milliseconds,
'bytes': bytes,
'unitPrice': unitPrice,
'album': JsonConverters.toJson(album,'Albums',context!),
'mediaType': JsonConverters.toJson(mediaType,'MediaTypes',context!),
'genre': JsonConverters.toJson(genre,'Genres',context!)
};
getTypeName() => "Tracks";
TypeContext? context = _ctx;
}
class QueryTracks extends QueryDb<Tracks> implements IGet, IConvertible
{
int? trackId;
String? nameContains;
QueryTracks({this.trackId,this.nameContains});
QueryTracks.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
trackId = json['trackId'];
nameContains = json['nameContains'];
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'trackId': trackId,
'nameContains': nameContains
});
getTypeName() => "QueryTracks";
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> {
'Albums': TypeInfo(TypeOf.Class, create:() => Albums()),
'MediaTypes': TypeInfo(TypeOf.Class, create:() => MediaTypes()),
'Genres': TypeInfo(TypeOf.Class, create:() => Genres()),
'Tracks': TypeInfo(TypeOf.Class, create:() => Tracks()),
'QueryTracks': TypeInfo(TypeOf.Class, create:() => QueryTracks()),
'List<Tracks>': TypeInfo(TypeOf.Class, create:() => <Tracks>[]),
'List<Albums>': TypeInfo(TypeOf.Class, create:() => <Albums>[]),
});
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /tracks HTTP/1.1 Host: chinook.netcore.io Accept: application/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <QueryResponseOfTracksERq9_SyN2 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types"> <Offset>0</Offset> <Total>0</Total> <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/Chinook.ServiceModel.Types"> <d2p1:Tracks> <d2p1:Album> <d2p1:AlbumId>0</d2p1:AlbumId> <d2p1:ArtistId>0</d2p1:ArtistId> <d2p1:Title>String</d2p1:Title> </d2p1:Album> <d2p1:AlbumId>0</d2p1:AlbumId> <d2p1:Bytes>0</d2p1:Bytes> <d2p1:Composer>String</d2p1:Composer> <d2p1:Genre> <d2p1:GenreId>0</d2p1:GenreId> <d2p1:Name>String</d2p1:Name> </d2p1:Genre> <d2p1:GenreId>0</d2p1:GenreId> <d2p1:MediaType> <d2p1:MediaTypeId>0</d2p1:MediaTypeId> <d2p1:Name>String</d2p1:Name> </d2p1:MediaType> <d2p1:MediaTypeId>0</d2p1:MediaTypeId> <d2p1:Milliseconds>0</d2p1:Milliseconds> <d2p1:Name>String</d2p1:Name> <d2p1:TrackId>0</d2p1:TrackId> <d2p1:UnitPrice>0</d2p1:UnitPrice> </d2p1:Tracks> </Results> <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:KeyValueOfstringstring> <d2p1:Key>String</d2p1:Key> <d2p1:Value>String</d2p1:Value> </d2p1:KeyValueOfstringstring> </Meta> <ResponseStatus> <ErrorCode>String</ErrorCode> <Message>String</Message> <StackTrace>String</StackTrace> <Errors> <ResponseError> <ErrorCode>String</ErrorCode> <FieldName>String</FieldName> <Message>String</Message> <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:KeyValueOfstringstring> <d5p1:Key>String</d5p1:Key> <d5p1:Value>String</d5p1:Value> </d5p1:KeyValueOfstringstring> </Meta> </ResponseError> </Errors> <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringstring> <d3p1:Key>String</d3p1:Key> <d3p1:Value>String</d3p1:Value> </d3p1:KeyValueOfstringstring> </Meta> </ResponseStatus> </QueryResponseOfTracksERq9_SyN2>