| GET | /tracks | ||
|---|---|---|---|
| GET | /tracks/{TrackId} |
// @DataContract
export class QueryBase
{
// @DataMember(Order=1)
public skip?: number;
// @DataMember(Order=2)
public take?: number;
// @DataMember(Order=3)
public orderBy: string;
// @DataMember(Order=4)
public orderByDesc: string;
// @DataMember(Order=5)
public include: string;
// @DataMember(Order=6)
public fields: string;
// @DataMember(Order=7)
public meta: { [index:string]: string; };
public constructor(init?: Partial<QueryBase>) { (Object as any).assign(this, init); }
}
export class QueryDb<T> extends QueryBase
{
public constructor(init?: Partial<QueryDb<T>>) { super(init); (Object as any).assign(this, init); }
}
export class Albums
{
public albumId: number;
// @Required()
public title: string;
public artistId: number;
public constructor(init?: Partial<Albums>) { (Object as any).assign(this, init); }
}
export class MediaTypes
{
public mediaTypeId: number;
public name: string;
public constructor(init?: Partial<MediaTypes>) { (Object as any).assign(this, init); }
}
export class Genres
{
public genreId: number;
public name: string;
public constructor(init?: Partial<Genres>) { (Object as any).assign(this, init); }
}
export class Tracks
{
public trackId: number;
// @Required()
public name: string;
// @References("typeof(Chinook.ServiceModel.Types.Albums)")
public albumId?: number;
// @References("typeof(Chinook.ServiceModel.Types.MediaTypes)")
public mediaTypeId: number;
// @References("typeof(Chinook.ServiceModel.Types.Genres)")
public genreId?: number;
public composer: string;
public milliseconds: number;
public bytes?: number;
public unitPrice: number;
public album: Albums;
public mediaType: MediaTypes;
public genre: Genres;
public constructor(init?: Partial<Tracks>) { (Object as any).assign(this, init); }
}
export class QueryTracks extends QueryDb<Tracks> implements IGet
{
public trackId?: number;
public nameContains: string;
public constructor(init?: Partial<QueryTracks>) { super(init); (Object as any).assign(this, init); }
}
// @DataContract
export class QueryResponse<T>
{
// @DataMember(Order=1)
public offset: number;
// @DataMember(Order=2)
public total: number;
// @DataMember(Order=3)
public results: Albums[];
// @DataMember(Order=4)
public meta: { [index:string]: string; };
// @DataMember(Order=5)
public responseStatus: ResponseStatus;
public constructor(init?: Partial<QueryResponse<T>>) { (Object as any).assign(this, init); }
}
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>