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


@ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
@ValidateRequest(Validator="IsAuthenticated")
open class TestBookingPrintout : ICompany
{
    /**
    * 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 CompanyId:UUID? = null

    /**
    * Report header left cell content
    */
    @ApiMember(Description="Report header left cell content", IsRequired=true)
    var HeaderLeftCell:String? = null

    /**
    * Report header middle cell content
    */
    @ApiMember(Description="Report header middle cell content", IsRequired=true)
    var HeaderMiddleCell:String? = null

    /**
    * Report header right cell content
    */
    @ApiMember(Description="Report header right cell content", IsRequired=true)
    var HeaderRightCell:String? = null

    /**
    * Report body cell content
    */
    @ApiMember(Description="Report body cell content", IsRequired=true)
    var BodyCell:String? = null

    /**
    * Report footer left cell content
    */
    @ApiMember(Description="Report footer left cell content", IsRequired=true)
    var FooterLeftCell:String? = null

    /**
    * Report footer middle cell content
    */
    @ApiMember(Description="Report footer middle cell content", IsRequired=true)
    var FooterMiddleCell:String? = null

    /**
    * Report footer right cell content
    */
    @ApiMember(Description="Report footer right cell content", IsRequired=true)
    var FooterRightCell:String? = null
}

Kotlin 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/" />