GET | /tracks | ||
---|---|---|---|
GET | /tracks/{TrackId} |
"use strict";
export class QueryBase {
/** @param {{skip?:number,take?:number,orderBy?:string,orderByDesc?:string,include?:string,fields?:string,meta?:{ [index:string]: string; }}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?number} */
skip;
/** @type {?number} */
take;
/** @type {string} */
orderBy;
/** @type {string} */
orderByDesc;
/** @type {string} */
include;
/** @type {string} */
fields;
/** @type {{ [index:string]: string; }} */
meta;
}
/** @typedef T {any} */
export class QueryDb extends QueryBase {
/** @param {{skip?:number,take?:number,orderBy?:string,orderByDesc?:string,include?:string,fields?:string,meta?:{ [index:string]: string; }}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
}
export class Albums {
/** @param {{albumId?:number,title?:string,artistId?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
albumId;
/** @type {string} */
title;
/** @type {number} */
artistId;
}
export class MediaTypes {
/** @param {{mediaTypeId?:number,name?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
mediaTypeId;
/** @type {string} */
name;
}
export class Genres {
/** @param {{genreId?:number,name?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
genreId;
/** @type {string} */
name;
}
export class Tracks {
/** @param {{trackId?:number,name?:string,albumId?:number,mediaTypeId?:number,genreId?:number,composer?:string,milliseconds?:number,bytes?:number,unitPrice?:number,album?:Albums,mediaType?:MediaTypes,genre?:Genres}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
trackId;
/** @type {string} */
name;
/** @type {?number} */
albumId;
/** @type {number} */
mediaTypeId;
/** @type {?number} */
genreId;
/** @type {string} */
composer;
/** @type {number} */
milliseconds;
/** @type {?number} */
bytes;
/** @type {number} */
unitPrice;
/** @type {Albums} */
album;
/** @type {MediaTypes} */
mediaType;
/** @type {Genres} */
genre;
}
export class QueryTracks extends QueryDb {
/** @param {{trackId?:number,nameContains?:string,skip?:number,take?:number,orderBy?:string,orderByDesc?:string,include?:string,fields?:string,meta?:{ [index:string]: string; }}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {?number} */
trackId;
/** @type {string} */
nameContains;
}
/** @typedef T {any} */
export class QueryResponse {
/** @param {{offset?:number,total?:number,results?:T[],meta?:{ [index:string]: string; },responseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
offset;
/** @type {number} */
total;
/** @type {T[]} */
results;
/** @type {{ [index:string]: string; }} */
meta;
/** @type {ResponseStatus} */
responseStatus;
}
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>