Chinook

<back to all web services

QueryTracks

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryBase:
    skip: Optional[int] = None
    take: Optional[int] = None
    order_by: Optional[str] = None
    order_by_desc: Optional[str] = None
    include: Optional[str] = None
    fields: Optional[str] = None
    meta: Optional[Dict[str, str]] = None


T = TypeVar('T')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryDb(Generic[T], QueryBase, IReturn[QueryResponse[T]]):
    @staticmethod
    def response_type(): return QueryResponse[T]


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Albums:
    album_id: int = 0
    # @Required()
    title: Optional[str] = None

    artist_id: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class MediaTypes:
    media_type_id: int = 0
    name: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Genres:
    genre_id: int = 0
    name: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Tracks:
    track_id: int = 0
    # @Required()
    name: Optional[str] = None

    # @References(typeof(Albums))
    album_id: Optional[int] = None

    # @References(typeof(MediaTypes))
    media_type_id: int = 0

    # @References(typeof(Genres))
    genre_id: Optional[int] = None

    composer: Optional[str] = None
    milliseconds: int = 0
    bytes_: Optional[int] = field(metadata=config(field_name='bytes'), default=None)
    unit_price: Decimal = decimal.Decimal(0)
    album: Optional[Albums] = None
    media_type: Optional[MediaTypes] = None
    genre: Optional[Genres] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryTracks(QueryDb[Tracks], IGet):
    track_id: Optional[int] = None
    name_contains: Optional[str] = None


T = TypeVar('T')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryResponse(Generic[T]):
    offset: int = 0
    total: int = 0
    results: Optional[List[Albums]] = None
    meta: Optional[Dict[str, str]] = None
    response_status: Optional[ResponseStatus] = None

Python QueryTracks DTOs

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