MyApp

<back to all web services

QueryBookings

bookings

Find Bookings

The following routes are available for this service:
GET/bookings
GET/bookings/{Id}
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 RoomType(str, Enum):
    SINGLE = 'Single'
    DOUBLE = 'Double'
    QUEEN = 'Queen'
    TWIN = 'Twin'
    SUITE = 'Suite'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Coupon:
    """
    Discount Coupons
    """

    id: Optional[str] = None
    description: Optional[str] = None
    discount: int = 0
    expiry_date: datetime.datetime = datetime.datetime(1, 1, 1)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Booking(AuditBase):
    """
    Booking Details
    """

    id: int = 0
    name: Optional[str] = None
    room_type: Optional[RoomType] = None
    room_number: int = 0
    booking_start_date: datetime.datetime = datetime.datetime(1, 1, 1)
    booking_end_date: Optional[datetime.datetime] = None
    cost: Decimal = decimal.Decimal(0)
    # @References(typeof(Coupon))
    coupon_id: Optional[str] = None

    discount: Optional[Coupon] = None
    notes: Optional[str] = None
    cancelled: Optional[bool] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryBookings(QueryDb[Booking]):
    """
    Find Bookings
    """

    id: Optional[int] = None


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


Todo = TypeVar('Todo')


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

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

GET /bookings HTTP/1.1 
Host: blazor-gallery.servicestack.net 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfBookingtlJ4_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:Booking>
      <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:BookingEndDate>0001-01-01T00:00:00</d2p1:BookingEndDate>
      <d2p1:BookingStartDate>0001-01-01T00:00:00</d2p1:BookingStartDate>
      <d2p1:Cancelled>false</d2p1:Cancelled>
      <d2p1:Cost>0</d2p1:Cost>
      <d2p1:CouponId>String</d2p1:CouponId>
      <d2p1:Discount>
        <d2p1:Description>String</d2p1:Description>
        <d2p1:Discount>0</d2p1:Discount>
        <d2p1:ExpiryDate>0001-01-01T00:00:00</d2p1:ExpiryDate>
        <d2p1:Id>String</d2p1:Id>
      </d2p1:Discount>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:Notes>String</d2p1:Notes>
      <d2p1:RoomNumber>0</d2p1:RoomNumber>
      <d2p1:RoomType>Single</d2p1:RoomType>
    </d2p1:Booking>
  </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>
</QueryResponseOfBookingtlJ4_P31p>