MyApp

<back to all web services

QueryPlayer

Game
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 AuditBase:
    created_date: datetime.datetime = datetime.datetime(1, 1, 1)
    # @Required()
    created_by: Optional[str] = None

    modified_date: datetime.datetime = datetime.datetime(1, 1, 1)
    # @Required()
    modified_by: Optional[str] = None

    deleted_date: Optional[datetime.datetime] = None
    deleted_by: Optional[str] = None


class PhoneKind(str, Enum):
    HOME = 'Home'
    MOBILE = 'Mobile'
    WORK = 'Work'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Phone:
    kind: Optional[PhoneKind] = None
    number: Optional[str] = None
    ext: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PlayerGameItem:
    id: int = 0
    # @References(typeof(Player))
    player_id: int = 0

    # @References(typeof(GameItem))
    game_item_name: Optional[str] = None


class PlayerRole(str, Enum):
    LEADER = 'Leader'
    PLAYER = 'Player'
    NON_PLAYER = 'NonPlayer'


class PlayerRegion(IntEnum):
    AFRICA = 1
    AMERICAS = 2
    ASIA = 3
    AUSTRALASIA = 4
    EUROPE = 5


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Profile(AuditBase):
    id: int = 0
    role: Optional[PlayerRole] = None
    region: Optional[PlayerRegion] = None
    username: Optional[str] = None
    high_score: int = 0
    games_played: int = 0
    energy: int = 0
    profile_url: Optional[str] = None
    cover_url: Optional[str] = None
    meta: Optional[Dict[str, str]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Player(AuditBase):
    id: int = 0
    # @Required()
    first_name: Optional[str] = None

    last_name: Optional[str] = None
    email: Optional[str] = None
    phone_numbers: List[Phone] = field(default_factory=list)
    game_items: List[PlayerGameItem] = field(default_factory=list)
    profile: Optional[Profile] = None
    profile_id: int = 0
    saved_level_id: Optional[str] = None
    row_version: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryPlayer(QueryDb[Player]):
    pass


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Todo:
    id: int = 0
    text: Optional[str] = None
    is_finished: bool = False


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[Todo]] = None
    meta: Optional[Dict[str, str]] = None
    response_status: Optional[ResponseStatus] = None

Python QueryPlayer DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/QueryPlayer HTTP/1.1 
Host: blazor-gallery.servicestack.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<QueryPlayer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyApp.ServiceModel">
  <Skip xmlns="http://schemas.servicestack.net/types">0</Skip>
  <Take xmlns="http://schemas.servicestack.net/types">0</Take>
  <OrderBy xmlns="http://schemas.servicestack.net/types">String</OrderBy>
  <OrderByDesc xmlns="http://schemas.servicestack.net/types">String</OrderByDesc>
  <Include xmlns="http://schemas.servicestack.net/types">String</Include>
  <Fields xmlns="http://schemas.servicestack.net/types">String</Fields>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.servicestack.net/types">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
</QueryPlayer>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfPlayertlJ4_P31p 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/MyApp.ServiceModel">
    <d2p1:Player>
      <CreatedDate>0001-01-01T00:00:00</CreatedDate>
      <CreatedBy>String</CreatedBy>
      <ModifiedDate>0001-01-01T00:00:00</ModifiedDate>
      <ModifiedBy>String</ModifiedBy>
      <DeletedDate>0001-01-01T00:00:00</DeletedDate>
      <DeletedBy>String</DeletedBy>
      <d2p1:Email>String</d2p1:Email>
      <d2p1:FirstName>String</d2p1:FirstName>
      <d2p1:GameItems>
        <d2p1:PlayerGameItem>
          <d2p1:GameItemName>String</d2p1:GameItemName>
          <d2p1:Id>0</d2p1:Id>
          <d2p1:PlayerId>0</d2p1:PlayerId>
        </d2p1:PlayerGameItem>
      </d2p1:GameItems>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:LastName>String</d2p1:LastName>
      <d2p1:PhoneNumbers>
        <d2p1:Phone>
          <d2p1:Ext>String</d2p1:Ext>
          <d2p1:Kind>Home</d2p1:Kind>
          <d2p1:Number>String</d2p1:Number>
        </d2p1:Phone>
      </d2p1:PhoneNumbers>
      <d2p1:Profile>
        <CreatedDate>0001-01-01T00:00:00</CreatedDate>
        <CreatedBy>String</CreatedBy>
        <ModifiedDate>0001-01-01T00:00:00</ModifiedDate>
        <ModifiedBy>String</ModifiedBy>
        <DeletedDate>0001-01-01T00:00:00</DeletedDate>
        <DeletedBy>String</DeletedBy>
        <d2p1:CoverUrl>String</d2p1:CoverUrl>
        <d2p1:Energy>0</d2p1:Energy>
        <d2p1:GamesPlayed>0</d2p1:GamesPlayed>
        <d2p1:HighScore>0</d2p1:HighScore>
        <d2p1:Id>0</d2p1:Id>
        <d2p1: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>
        </d2p1:Meta>
        <d2p1:ProfileUrl>String</d2p1:ProfileUrl>
        <d2p1:Region>Africa</d2p1:Region>
        <d2p1:Role>Leader</d2p1:Role>
        <d2p1:Username>String</d2p1:Username>
      </d2p1:Profile>
      <d2p1:ProfileId>0</d2p1:ProfileId>
      <d2p1:RowVersion>0</d2p1:RowVersion>
      <d2p1:SavedLevelId>00000000-0000-0000-0000-000000000000</d2p1:SavedLevelId>
    </d2p1:Player>
  </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>
</QueryResponseOfPlayertlJ4_P31p>