BokaMera.API.Host

<back to all web services

TestBookingPrintout

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
POST/reports/booking/printout/testTest to print a report to PDF with fake data
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


# @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
# @ValidateRequest(Validator="IsAuthenticated")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TestBookingPrintout(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 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
    """

Python TestBookingPrintout DTOs

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

HTTP + CSV

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

POST /reports/booking/printout/test HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000","HeaderLeftCell":"String","HeaderMiddleCell":"String","HeaderRightCell":"String","BodyCell":"String","FooterLeftCell":"String","FooterMiddleCell":"String","FooterRightCell":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{}