GET | /tracks | ||
---|---|---|---|
GET | /tracks/{TrackId} |
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*
open class QueryTracks : QueryDb<Tracks>(), IGet
{
open var trackId:Long? = null
open var nameContains:String? = null
}
open class QueryDb<T> : QueryBase()
{
}
@DataContract
open class QueryBase
{
@DataMember(Order=1)
open var skip:Int? = null
@DataMember(Order=2)
open var take:Int? = null
@DataMember(Order=3)
open var orderBy:String? = null
@DataMember(Order=4)
open var orderByDesc:String? = null
@DataMember(Order=5)
open var include:String? = null
@DataMember(Order=6)
open var fields:String? = null
@DataMember(Order=7)
open var meta:HashMap<String,String>? = null
}
open class Tracks
{
open var trackId:Long? = null
@Required()
open var name:String? = null
@References(Type=Albums::class)
open var albumId:Long? = null
@References(Type=MediaTypes::class)
open var mediaTypeId:Long? = null
@References(Type=Genres::class)
open var genreId:Long? = null
open var composer:String? = null
open var milliseconds:Long? = null
open var bytes:Long? = null
open var unitPrice:BigDecimal? = null
open var album:Albums? = null
open var mediaType:MediaTypes? = null
open var genre:Genres? = null
}
open class Albums
{
open var albumId:Long? = null
@Required()
open var title:String? = null
open var artistId:Long? = null
}
open class MediaTypes
{
open var mediaTypeId:Long? = null
open var name:String? = null
}
open class Genres
{
open var genreId:Long? = null
open var name:String? = null
}
@DataContract
open class QueryResponse<T>
{
@DataMember(Order=1)
open var offset:Int? = null
@DataMember(Order=2)
open var total:Int? = null
@DataMember(Order=3)
open var results:ArrayList<Albums>? = null
@DataMember(Order=4)
open var meta:HashMap<String,String>? = null
@DataMember(Order=5)
open var responseStatus:ResponseStatus? = null
}
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 /tracks 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: [ { trackId: 0, name: String, albumId: 0, mediaTypeId: 0, genreId: 0, composer: String, milliseconds: 0, bytes: 0, unitPrice: 0, album: { albumId: 0, title: String, artistId: 0 }, mediaType: { mediaTypeId: 0, name: String }, genre: { genreId: 0, name: String } } ], meta: { String: String }, responseStatus: { errorCode: String, message: String, stackTrace: String, errors: [ { errorCode: String, fieldName: String, message: String, meta: { String: String } } ], meta: { String: String } } }