Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
GET | /bookings/{BookingId}/reports/{ReportId} | Get a report as a PDF file | Get a PDF report. |
---|
<?php namespace dtos;
use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};
enum SendReceiptMethod : int
{
case Email = 1;
case PdfExport = 2;
}
// @ValidateRequest(Validator="IsAuthenticated")
class ExportReport implements JsonSerializable
{
public function __construct(
/** @description Id of the booking */
// @ApiMember(Description="Id of the booking", IsRequired=true, ParameterType="path")
/** @var int */
public int $BookingId=0,
/** @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.")
/** @var string|null */
public ?string $CompanyId=null,
/** @description Id of the report */
// @ApiMember(Description="Id of the report", IsRequired=true, ParameterType="path")
/** @var int */
public int $ReportId=0,
/** @var SendReceiptMethod|null */
public ?SendReceiptMethod $SendReceiptMethod=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['BookingId'])) $this->BookingId = $o['BookingId'];
if (isset($o['CompanyId'])) $this->CompanyId = $o['CompanyId'];
if (isset($o['ReportId'])) $this->ReportId = $o['ReportId'];
if (isset($o['SendReceiptMethod'])) $this->SendReceiptMethod = JsonConverters::from('SendReceiptMethod', $o['SendReceiptMethod']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->BookingId)) $o['BookingId'] = $this->BookingId;
if (isset($this->CompanyId)) $o['CompanyId'] = $this->CompanyId;
if (isset($this->ReportId)) $o['ReportId'] = $this->ReportId;
if (isset($this->SendReceiptMethod)) $o['SendReceiptMethod'] = JsonConverters::to('SendReceiptMethod', $this->SendReceiptMethod);
return empty($o) ? new class(){} : $o;
}
}
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
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: testapi.bokamera.se Accept: application/json
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length {}