| GET | /tracks | ||
|---|---|---|---|
| GET | /tracks/{TrackId} |
<?php namespace dtos;
use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};
// @DataContract
class QueryBase implements JsonSerializable
{
public function __construct(
// @DataMember(Order=1)
/** @var int|null */
public ?int $skip=null,
// @DataMember(Order=2)
/** @var int|null */
public ?int $take=null,
// @DataMember(Order=3)
/** @var string|null */
public ?string $orderBy=null,
// @DataMember(Order=4)
/** @var string|null */
public ?string $orderByDesc=null,
// @DataMember(Order=5)
/** @var string|null */
public ?string $include=null,
// @DataMember(Order=6)
/** @var string|null */
public ?string $fields=null,
// @DataMember(Order=7)
/** @var array<string,string>|null */
public ?array $meta=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['skip'])) $this->skip = $o['skip'];
if (isset($o['take'])) $this->take = $o['take'];
if (isset($o['orderBy'])) $this->orderBy = $o['orderBy'];
if (isset($o['orderByDesc'])) $this->orderByDesc = $o['orderByDesc'];
if (isset($o['include'])) $this->include = $o['include'];
if (isset($o['fields'])) $this->fields = $o['fields'];
if (isset($o['meta'])) $this->meta = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['string','string']), $o['meta']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->skip)) $o['skip'] = $this->skip;
if (isset($this->take)) $o['take'] = $this->take;
if (isset($this->orderBy)) $o['orderBy'] = $this->orderBy;
if (isset($this->orderByDesc)) $o['orderByDesc'] = $this->orderByDesc;
if (isset($this->include)) $o['include'] = $this->include;
if (isset($this->fields)) $o['fields'] = $this->fields;
if (isset($this->meta)) $o['meta'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['string','string']), $this->meta);
return empty($o) ? new class(){} : $o;
}
}
/**
* @template T
*/
class QueryDb extends QueryBase implements JsonSerializable
{
public array $genericArgs = [];
public static function create(array $genericArgs=[]): QueryDb {
$to = new QueryDb();
$to->genericArgs = $genericArgs;
return $to;
}
/**
* @param int|null $skip
* @param int|null $take
* @param string|null $orderBy
* @param string|null $orderByDesc
* @param string|null $include
* @param string|null $fields
* @param array<string,string>|null $meta
*/
public function __construct(
mixed $skip=null,
mixed $take=null,
mixed $orderBy=null,
mixed $orderByDesc=null,
mixed $include=null,
mixed $fields=null,
mixed $meta=null
) {
parent::__construct($skip,$take,$orderBy,$orderByDesc,$include,$fields,$meta);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
return empty($o) ? new class(){} : $o;
}
}
class Albums implements JsonSerializable
{
public function __construct(
/** @var int */
public int $albumId=0,
// @Required()
/** @var string */
public string $title='',
/** @var int */
public int $artistId=0
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['albumId'])) $this->albumId = $o['albumId'];
if (isset($o['title'])) $this->title = $o['title'];
if (isset($o['artistId'])) $this->artistId = $o['artistId'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->albumId)) $o['albumId'] = $this->albumId;
if (isset($this->title)) $o['title'] = $this->title;
if (isset($this->artistId)) $o['artistId'] = $this->artistId;
return empty($o) ? new class(){} : $o;
}
}
class MediaTypes implements JsonSerializable
{
public function __construct(
/** @var int */
public int $mediaTypeId=0,
/** @var string|null */
public ?string $name=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['mediaTypeId'])) $this->mediaTypeId = $o['mediaTypeId'];
if (isset($o['name'])) $this->name = $o['name'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->mediaTypeId)) $o['mediaTypeId'] = $this->mediaTypeId;
if (isset($this->name)) $o['name'] = $this->name;
return empty($o) ? new class(){} : $o;
}
}
class Genres implements JsonSerializable
{
public function __construct(
/** @var int */
public int $genreId=0,
/** @var string|null */
public ?string $name=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['genreId'])) $this->genreId = $o['genreId'];
if (isset($o['name'])) $this->name = $o['name'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->genreId)) $o['genreId'] = $this->genreId;
if (isset($this->name)) $o['name'] = $this->name;
return empty($o) ? new class(){} : $o;
}
}
class Tracks implements JsonSerializable
{
public function __construct(
/** @var int */
public int $trackId=0,
// @Required()
/** @var string */
public string $name='',
// @References("typeof(Chinook.ServiceModel.Types.Albums)")
/** @var int|null */
public ?int $albumId=null,
// @References("typeof(Chinook.ServiceModel.Types.MediaTypes)")
/** @var int */
public int $mediaTypeId=0,
// @References("typeof(Chinook.ServiceModel.Types.Genres)")
/** @var int|null */
public ?int $genreId=null,
/** @var string|null */
public ?string $composer=null,
/** @var int */
public int $milliseconds=0,
/** @var int|null */
public ?int $bytes=null,
/** @var float */
public float $unitPrice=0.0,
/** @var Albums|null */
public ?Albums $album=null,
/** @var MediaTypes|null */
public ?MediaTypes $mediaType=null,
/** @var Genres|null */
public ?Genres $genre=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['trackId'])) $this->trackId = $o['trackId'];
if (isset($o['name'])) $this->name = $o['name'];
if (isset($o['albumId'])) $this->albumId = $o['albumId'];
if (isset($o['mediaTypeId'])) $this->mediaTypeId = $o['mediaTypeId'];
if (isset($o['genreId'])) $this->genreId = $o['genreId'];
if (isset($o['composer'])) $this->composer = $o['composer'];
if (isset($o['milliseconds'])) $this->milliseconds = $o['milliseconds'];
if (isset($o['bytes'])) $this->bytes = $o['bytes'];
if (isset($o['unitPrice'])) $this->unitPrice = $o['unitPrice'];
if (isset($o['album'])) $this->album = JsonConverters::from('Albums', $o['album']);
if (isset($o['mediaType'])) $this->mediaType = JsonConverters::from('MediaTypes', $o['mediaType']);
if (isset($o['genre'])) $this->genre = JsonConverters::from('Genres', $o['genre']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->trackId)) $o['trackId'] = $this->trackId;
if (isset($this->name)) $o['name'] = $this->name;
if (isset($this->albumId)) $o['albumId'] = $this->albumId;
if (isset($this->mediaTypeId)) $o['mediaTypeId'] = $this->mediaTypeId;
if (isset($this->genreId)) $o['genreId'] = $this->genreId;
if (isset($this->composer)) $o['composer'] = $this->composer;
if (isset($this->milliseconds)) $o['milliseconds'] = $this->milliseconds;
if (isset($this->bytes)) $o['bytes'] = $this->bytes;
if (isset($this->unitPrice)) $o['unitPrice'] = $this->unitPrice;
if (isset($this->album)) $o['album'] = JsonConverters::to('Albums', $this->album);
if (isset($this->mediaType)) $o['mediaType'] = JsonConverters::to('MediaTypes', $this->mediaType);
if (isset($this->genre)) $o['genre'] = JsonConverters::to('Genres', $this->genre);
return empty($o) ? new class(){} : $o;
}
}
/**
* @template QueryDb of Tracks
*/
class QueryTracks extends QueryDb implements IGet, JsonSerializable
{
/**
* @param int|null $skip
* @param int|null $take
* @param string|null $orderBy
* @param string|null $orderByDesc
* @param string|null $include
* @param string|null $fields
* @param array<string,string>|null $meta
*/
public function __construct(
?int $skip=null,
?int $take=null,
?string $orderBy=null,
?string $orderByDesc=null,
?string $include=null,
?string $fields=null,
?array $meta=null,
/** @var int|null */
public ?int $trackId=null,
/** @var string|null */
public ?string $nameContains=null
) {
parent::__construct($skip,$take,$orderBy,$orderByDesc,$include,$fields,$meta);
}
/** @throws Exception */
public function fromMap($o): void {
parent::fromMap($o);
if (isset($o['trackId'])) $this->trackId = $o['trackId'];
if (isset($o['nameContains'])) $this->nameContains = $o['nameContains'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = parent::jsonSerialize();
if (isset($this->trackId)) $o['trackId'] = $this->trackId;
if (isset($this->nameContains)) $o['nameContains'] = $this->nameContains;
return empty($o) ? new class(){} : $o;
}
}
// @DataContract
/**
* @template T
*/
class QueryResponse implements JsonSerializable
{
public array $genericArgs = [];
public static function create(array $genericArgs=[]): QueryResponse {
$to = new QueryResponse();
$to->genericArgs = $genericArgs;
return $to;
}
public function __construct(
// @DataMember(Order=1)
/** @var int */
public mixed $offset=0,
// @DataMember(Order=2)
/** @var int */
public mixed $total=0,
// @DataMember(Order=3)
/** @var array<Albums>|null */
public mixed $results=null,
// @DataMember(Order=4)
/** @var array<string,string>|null */
public mixed $meta=null,
// @DataMember(Order=5)
/** @var ResponseStatus|null */
public mixed $responseStatus=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['offset'])) $this->offset = $o['offset'];
if (isset($o['total'])) $this->total = $o['total'];
if (isset($o['results'])) $this->results = JsonConverters::fromArray('Albums', $o['results']);
if (isset($o['meta'])) $this->meta = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['string','string']), $o['meta']);
if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->offset)) $o['offset'] = $this->offset;
if (isset($this->total)) $o['total'] = $this->total;
if (isset($this->results)) $o['results'] = JsonConverters::toArray('Albums', $this->results);
if (isset($this->meta)) $o['meta'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['string','string']), $this->meta);
if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
return empty($o) ? new class(){} : $o;
}
}
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>