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

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
export class TestBookingPrintout implements ICompany
{
    /** @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 */
    // @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")
    public CompanyId?: string;

    /** @description Report header left cell content */
    // @ApiMember(Description="Report header left cell content", IsRequired=true)
    public HeaderLeftCell: string;

    /** @description Report header middle cell content */
    // @ApiMember(Description="Report header middle cell content", IsRequired=true)
    public HeaderMiddleCell: string;

    /** @description Report header right cell content */
    // @ApiMember(Description="Report header right cell content", IsRequired=true)
    public HeaderRightCell: string;

    /** @description Report body cell content */
    // @ApiMember(Description="Report body cell content", IsRequired=true)
    public BodyCell: string;

    /** @description Report footer left cell content */
    // @ApiMember(Description="Report footer left cell content", IsRequired=true)
    public FooterLeftCell: string;

    /** @description Report footer middle cell content */
    // @ApiMember(Description="Report footer middle cell content", IsRequired=true)
    public FooterMiddleCell: string;

    /** @description Report footer right cell content */
    // @ApiMember(Description="Report footer right cell content", IsRequired=true)
    public FooterRightCell: string;

    public constructor(init?: Partial<TestBookingPrintout>) { (Object as any).assign(this, init); }
}

TypeScript 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: api.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

{}