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.
"use strict";
/** @typedef {number} */
export var SendReceiptMethod;
(function (SendReceiptMethod) {
    SendReceiptMethod[SendReceiptMethod["Email"] = 1] = "Email"
    SendReceiptMethod[SendReceiptMethod["PdfExport"] = 2] = "PdfExport"
})(SendReceiptMethod || (SendReceiptMethod = {}));
export class ExportReport {
    /** @param {{BookingId?:number,CompanyId?:string,ReportId?:number,SendReceiptMethod?:SendReceiptMethod}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description Id of the booking */
    BookingId;
    /**
     * @type {?string}
     * @description The company id, if empty will use the company id for the user you are logged in with. */
    CompanyId;
    /**
     * @type {number}
     * @description Id of the report */
    ReportId;
    /** @type {SendReceiptMethod} */
    SendReceiptMethod;
}

JavaScript ExportReport DTOs

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

HTTP + XML

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/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<z:anyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" />