BokaMera.API.Host

<back to all web services

TestBookingPrintout

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
POST/reports/booking/printout/testTest to print a report to PDF with fake data
<?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};


// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
class TestBookingPrintout implements ICompany, JsonSerializable
{
    public function __construct(
        /** @description Enter the company you want to see add a token for, if blank and you are an admin, your company id will be used */
        // @ApiMember(Description="Enter the company you want to see add a token for, if blank and you are an admin, your company id will be used", ParameterType="query")
        /** @var string|null */
        public ?string $CompanyId=null,

        /** @description Report header left cell content */
        // @ApiMember(Description="Report header left cell content", IsRequired=true)
        /** @var string */
        public string $HeaderLeftCell='',

        /** @description Report header middle cell content */
        // @ApiMember(Description="Report header middle cell content", IsRequired=true)
        /** @var string */
        public string $HeaderMiddleCell='',

        /** @description Report header right cell content */
        // @ApiMember(Description="Report header right cell content", IsRequired=true)
        /** @var string */
        public string $HeaderRightCell='',

        /** @description Report body cell content */
        // @ApiMember(Description="Report body cell content", IsRequired=true)
        /** @var string */
        public string $BodyCell='',

        /** @description Report footer left cell content */
        // @ApiMember(Description="Report footer left cell content", IsRequired=true)
        /** @var string */
        public string $FooterLeftCell='',

        /** @description Report footer middle cell content */
        // @ApiMember(Description="Report footer middle cell content", IsRequired=true)
        /** @var string */
        public string $FooterMiddleCell='',

        /** @description Report footer right cell content */
        // @ApiMember(Description="Report footer right cell content", IsRequired=true)
        /** @var string */
        public string $FooterRightCell=''
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['CompanyId'])) $this->CompanyId = $o['CompanyId'];
        if (isset($o['HeaderLeftCell'])) $this->HeaderLeftCell = $o['HeaderLeftCell'];
        if (isset($o['HeaderMiddleCell'])) $this->HeaderMiddleCell = $o['HeaderMiddleCell'];
        if (isset($o['HeaderRightCell'])) $this->HeaderRightCell = $o['HeaderRightCell'];
        if (isset($o['BodyCell'])) $this->BodyCell = $o['BodyCell'];
        if (isset($o['FooterLeftCell'])) $this->FooterLeftCell = $o['FooterLeftCell'];
        if (isset($o['FooterMiddleCell'])) $this->FooterMiddleCell = $o['FooterMiddleCell'];
        if (isset($o['FooterRightCell'])) $this->FooterRightCell = $o['FooterRightCell'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->CompanyId)) $o['CompanyId'] = $this->CompanyId;
        if (isset($this->HeaderLeftCell)) $o['HeaderLeftCell'] = $this->HeaderLeftCell;
        if (isset($this->HeaderMiddleCell)) $o['HeaderMiddleCell'] = $this->HeaderMiddleCell;
        if (isset($this->HeaderRightCell)) $o['HeaderRightCell'] = $this->HeaderRightCell;
        if (isset($this->BodyCell)) $o['BodyCell'] = $this->BodyCell;
        if (isset($this->FooterLeftCell)) $o['FooterLeftCell'] = $this->FooterLeftCell;
        if (isset($this->FooterMiddleCell)) $o['FooterMiddleCell'] = $this->FooterMiddleCell;
        if (isset($this->FooterRightCell)) $o['FooterRightCell'] = $this->FooterRightCell;
        return empty($o) ? new class(){} : $o;
    }
}

PHP TestBookingPrintout 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.

POST /reports/booking/printout/test HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<TestBookingPrintout xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <BodyCell>String</BodyCell>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <FooterLeftCell>String</FooterLeftCell>
  <FooterMiddleCell>String</FooterMiddleCell>
  <FooterRightCell>String</FooterRightCell>
  <HeaderLeftCell>String</HeaderLeftCell>
  <HeaderMiddleCell>String</HeaderMiddleCell>
  <HeaderRightCell>String</HeaderRightCell>
</TestBookingPrintout>
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/" />