MyApp

<back to all web services

QueryTracks

Media
The following routes are available for this service:
GET/tracks
GET/tracks/{TrackId}
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 Tracks implements IConvertible
{
    int? trackId;
    // @required()
    String? name;

    int? albumId;
    int? mediaTypeId;
    int? genreId;
    String? composer;
    int? milliseconds;
    int? bytes;
    double? unitPrice;

    Tracks({this.trackId,this.name,this.albumId,this.mediaTypeId,this.genreId,this.composer,this.milliseconds,this.bytes,this.unitPrice});
    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']);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'trackId': trackId,
        'name': name,
        'albumId': albumId,
        'mediaTypeId': mediaTypeId,
        'genreId': genreId,
        'composer': composer,
        'milliseconds': milliseconds,
        'bytes': bytes,
        'unitPrice': unitPrice
    };

    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;
}

class Todo implements IConvertible
{
    int? id;
    String? text;
    bool? isFinished;

    Todo({this.id,this.text,this.isFinished});
    Todo.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        id = json['id'];
        text = json['text'];
        isFinished = json['isFinished'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'id': id,
        'text': text,
        'isFinished': isFinished
    };

    getTypeName() => "Todo";
    TypeContext? context = _ctx;
}

// @DataContract
class QueryResponse<T> implements IConvertible
{
    // @DataMember(Order=1)
    int? offset;

    // @DataMember(Order=2)
    int? total;

    // @DataMember(Order=3)
    List<Todo>? 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<Todo>',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<Todo>',context!),
        'meta': meta,
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "QueryResponse<$T>";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'blazor_gallery.servicestack.net', types: <String, TypeInfo> {
    'Tracks': TypeInfo(TypeOf.Class, create:() => Tracks()),
    'QueryTracks': TypeInfo(TypeOf.Class, create:() => QueryTracks()),
    'List<Tracks>': TypeInfo(TypeOf.Class, create:() => <Tracks>[]),
    'Todo': TypeInfo(TypeOf.Class, create:() => Todo()),
    'List<Todo>': TypeInfo(TypeOf.Class, create:() => <Todo>[]),
});

Dart QueryTracks DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /tracks HTTP/1.1 
Host: blazor-gallery.servicestack.net 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	offset: 0,
	total: 0,
	results: 
	[
		{
			trackId: 0,
			name: String,
			albumId: 0,
			mediaTypeId: 0,
			genreId: 0,
			composer: String,
			milliseconds: 0,
			bytes: 0,
			unitPrice: 0
		}
	],
	meta: 
	{
		String: String
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}