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.
import java.math.*
import java.util.*
import net.servicestack.client.*


@ValidateRequest(Validator="IsAuthenticated")
open class ExportReport
{
    /**
    * Id of the booking
    */
    @ApiMember(Description="Id of the booking", IsRequired=true, ParameterType="path")
    var BookingId:Int? = null

    /**
    * 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.")
    var CompanyId:UUID? = null

    /**
    * Id of the report
    */
    @ApiMember(Description="Id of the report", IsRequired=true, ParameterType="path")
    var ReportId:Int? = null

    var SendReceiptMethod:SendReceiptMethod? = null
}

enum class SendReceiptMethod(val value:Int)
{
    Email(1),
    PdfExport(2),
}

Kotlin ExportReport DTOs

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

HTTP + OTHER

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

{}