| 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 .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>