BokaMera.API.Host

<back to all web services

ExportReport

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
GET/bookings/{BookingId}/reports/{ReportId}Get a report as a PDF fileGet a PDF report.

export enum SendReceiptMethod
{
    Email = 1,
    PdfExport = 2,
}

// @ValidateRequest(Validator="IsAuthenticated")
export class ExportReport
{
    /** @description Id of the booking */
    // @ApiMember(Description="Id of the booking", IsRequired=true, ParameterType="path")
    public BookingId: number;

    /** @description The company id, if empty will use the company id for the user you are logged in with. */
    // @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
    public CompanyId?: string;

    /** @description Id of the report */
    // @ApiMember(Description="Id of the report", IsRequired=true, ParameterType="path")
    public ReportId: number;

    public SendReceiptMethod: SendReceiptMethod;

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

TypeScript ExportReport DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET /bookings/{BookingId}/reports/{ReportId} HTTP/1.1 
Host: api.bokamera.se 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{}