| Requires any of the roles: | bookingsupplier-administrator-write, bookingsupplier-administrator-read, superadmin |
| 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):
# @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
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 .jsv suffix or ?format=jsv
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: testapi.bokamera.se Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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
}
}
}