BokaMera.API.Host

<back to all web services

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/printoutGet 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


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryBase:
    skip: Optional[int] = None
    """
    Skip over a given number of elements in a sequence and then return the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?skip=10&orderBy=Id</code>
    """

    take: Optional[int] = None
    """
    Return a given number of elements in a sequence and then skip over the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?take=20</code>
    """

    order_by: Optional[str] = None
    """
    Comma separated list of fields to order by. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderBy=Id,-Age,FirstName</code>
    """

    order_by_desc: Optional[str] = None
    """
    Comma separated list of fields to order by in descending order. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderByDesc=Id,-Age,FirstName</code>
    """

    include: Optional[str] = None
    """
    Include any of the aggregates <code>AVG, COUNT, FIRST, LAST, MAX, MIN, SUM</code> in your result set. The results will be returned in the meta field.<br/><br/><strong>Example:</strong><br/><code>?include=COUNT(*) as Total</code><br/><br/>or multiple fields with<br/><code>?include=Count(*) Total, Min(Age), AVG(Age) AverageAge</code><br/></br>or unique with<br/><code>?include=COUNT(DISTINCT LivingStatus) as UniqueStatus</code>
    """

    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 BookingPrintoutQueryResponse:
    # @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 BookingPrintout(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


# @ValidateRequest(Validator="IsAuthenticated")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BookingPrintoutQuery(QueryDb2[BookingPrintout, BookingPrintoutQueryResponse], 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


AccessKeyTypeResponse = TypeVar('AccessKeyTypeResponse')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryResponse(Generic[AccessKeyTypeResponse]):
    offset: int = 0
    total: int = 0
    results: Optional[List[AccessKeyTypeResponse]] = None
    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 .other suffix or ?format=other

HTTP + OTHER

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.bokamera.se 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Offset":0,"Total":0,"Results":[{"Id":0,"Name":"String","HeaderLeftCell":"String","HeaderMiddleCell":"String","HeaderRightCell":"String","BodyCell":"String","FooterLeftCell":"String","FooterMiddleCell":"String","FooterRightCell":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}