BokaMera.API.Host

BookingPrintoutQuery

**Requires Authentication**
Requires any of the roles:	bookingsupplier-administrator-write, bookingsupplier-administrator-read, superadmin

The following routes are available for this service:
GET	/reports/booking/printout	Get all reports used for booking export

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
Object = TypeVar('Object')


@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


From = TypeVar('From')
Into = TypeVar('Into')


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


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PrintoutQueryResponse:
    # @ApiMember(Description="Report id")
    id: int = 0
    """
    Report id
    """


    # @ApiMember(Description="Report Name")
    name: Optional[str] = None
    """
    Report Name
    """


    # @ApiMember(Description="Report header left cell content", IsRequired=true)
    header_left_cell: Optional[str] = None
    """
    Report header left cell content
    """


    # @ApiMember(Description="Report header middle cell content", IsRequired=true)
    header_middle_cell: Optional[str] = None
    """
    Report header middle cell content
    """


    # @ApiMember(Description="Report header right cell content", IsRequired=true)
    header_right_cell: Optional[str] = None
    """
    Report header right cell content
    """


    # @ApiMember(Description="Report body cell content", IsRequired=true)
    body_cell: Optional[str] = None
    """
    Report body cell content
    """


    # @ApiMember(Description="Report footer left cell content", IsRequired=true)
    footer_left_cell: Optional[str] = None
    """
    Report footer left cell content
    """


    # @ApiMember(Description="Report footer middle cell content", IsRequired=true)
    footer_middle_cell: Optional[str] = None
    """
    Report footer middle cell content
    """


    # @ApiMember(Description="Report footer right cell content", IsRequired=true)
    footer_right_cell: Optional[str] = None
    """
    Report footer right cell content
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BaseModel:
    pass


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PrintoutBase(BaseModel):
    # @Required()
    company_id: Optional[str] = None

    id: int = 0
    # @Required()
    name: Optional[str] = None

    header_left_cell: Optional[str] = None
    header_middle_cell: Optional[str] = None
    header_right_cell: Optional[str] = None
    # @Required()
    body_cell: Optional[str] = None

    footer_left_cell: Optional[str] = None
    footer_middle_cell: Optional[str] = None
    footer_right_cell: Optional[str] = None
    modified_date: Optional[datetime.datetime] = None


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

    header_left_cell: Optional[str] = None
    header_middle_cell: Optional[str] = None
    header_right_cell: Optional[str] = None
    # @Required()
    body_cell: Optional[str] = None

    footer_left_cell: Optional[str] = None
    footer_middle_cell: Optional[str] = None
    footer_right_cell: Optional[str] = None
    message_template: Optional[str] = None
    language: Optional[str] = None
    modified_date: Optional[datetime.datetime] = None


# @ValidateRequest(Validator="IsAuthenticated")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BookingPrintoutQuery(QueryDb2[BookingPrintout, PrintoutQueryResponse], ICompany):
    # @ApiMember(Description="Enter the company you want to see add a token for, if blank and you are an admin, your company id will be used", ParameterType="query")
    company_id: Optional[str] = None
    """
    Enter the company you want to see add a token for, if blank and you are an admin, your company id will be used
    """


    # @ApiMember(Description="Report id", ParameterType="query")
    id: Optional[int] = None
    """
    Report id
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AccessKeyTypeResponse:
    id: int = 0
    key_type: Optional[str] = None
    description: 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: List[AccessKeyTypeResponse] = field(default_factory=list)
    meta: Optional[Dict[str, str]] = None
    response_status: Optional[ResponseStatus] = None

Python BookingPrintoutQuery 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 /reports/booking/printout HTTP/1.1 
Host: api-staging.bookmore.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfPrintoutQueryResponseWg5EthtI 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/BokaMera.API.ServiceModel.Dtos">
    <d2p1:PrintoutQueryResponse>
      <d2p1:BodyCell>String</d2p1:BodyCell>
      <d2p1:FooterLeftCell>String</d2p1:FooterLeftCell>
      <d2p1:FooterMiddleCell>String</d2p1:FooterMiddleCell>
      <d2p1:FooterRightCell>String</d2p1:FooterRightCell>
      <d2p1:HeaderLeftCell>String</d2p1:HeaderLeftCell>
      <d2p1:HeaderMiddleCell>String</d2p1:HeaderMiddleCell>
      <d2p1:HeaderRightCell>String</d2p1:HeaderRightCell>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:Name>String</d2p1:Name>
    </d2p1:PrintoutQueryResponse>
  </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>
</QueryResponseOfPrintoutQueryResponseWg5EthtI>