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.*;

public class dtos
{

    @ValidateRequest(Validator="IsAuthenticated")
    public static class ExportReport
    {
        /**
        * Id of the booking
        */
        @ApiMember(Description="Id of the booking", IsRequired=true, ParameterType="path")
        public Integer BookingId = 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.")
        public UUID CompanyId = null;

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

        public SendReceiptMethod SendReceiptMethod = null;
        
        public Integer getBookingId() { return BookingId; }
        public ExportReport setBookingId(Integer value) { this.BookingId = value; return this; }
        public UUID getCompanyId() { return CompanyId; }
        public ExportReport setCompanyId(UUID value) { this.CompanyId = value; return this; }
        public Integer getReportId() { return ReportId; }
        public ExportReport setReportId(Integer value) { this.ReportId = value; return this; }
        public SendReceiptMethod getSendReceiptMethod() { return SendReceiptMethod; }
        public ExportReport setSendReceiptMethod(SendReceiptMethod value) { this.SendReceiptMethod = value; return this; }
    }

    public static enum SendReceiptMethod
    {
        Email(1),
        PdfExport(2);

        private final int value;
        SendReceiptMethod(final int intValue) { value = intValue; }
        public int getValue() { return value; }
    }

}

Java ExportReport DTOs

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

HTTP + JSV

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

{
	
}