BokaMera.API.Host

<back to all web services

CreateBookingPrintout

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
POST/reports/booking/printoutAdd new booking printout report
import Foundation
import ServiceStack

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
public class CreateBookingPrintout : ReportBase, 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")
    public var companyId:String?

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case companyId
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        companyId = try container.decodeIfPresent(String.self, forKey: .companyId)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if companyId != nil { try container.encode(companyId, forKey: .companyId) }
    }
}

public class ReportBase : Codable
{
    /**
    * Report Name
    */
    // @ApiMember(Description="Report Name", IsRequired=true)
    public var name:String

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

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

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

    /**
    * Report body cell content
    */
    // @ApiMember(Description="Report body cell content", IsRequired=true)
    public var bodyCell:String

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

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

    /**
    * Report footer right cell content
    */
    // @ApiMember(Description="Report footer right cell content", IsRequired=true)
    public var footerRightCell:String

    /**
    * Report id
    */
    // @ApiMember(Description="Report id")
    public var id:Int

    required public init(){}
}

public class PrintoutQueryResponse : Codable
{
    /**
    * Report id
    */
    // @ApiMember(Description="Report id")
    public var id:Int

    /**
    * Report Name
    */
    // @ApiMember(Description="Report Name")
    public var name:String

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

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

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

    /**
    * Report body cell content
    */
    // @ApiMember(Description="Report body cell content", IsRequired=true)
    public var bodyCell:String

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

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

    /**
    * Report footer right cell content
    */
    // @ApiMember(Description="Report footer right cell content", IsRequired=true)
    public var footerRightCell:String

    required public init(){}
}


Swift CreateBookingPrintout 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.

POST /reports/booking/printout HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CompanyId: 00000000-0000-0000-0000-000000000000,
	Name: String,
	HeaderLeftCell: String,
	HeaderMiddleCell: String,
	HeaderRightCell: String,
	BodyCell: String,
	FooterLeftCell: String,
	FooterMiddleCell: String,
	FooterRightCell: String,
	Id: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Id: 0,
	Name: String,
	HeaderLeftCell: String,
	HeaderMiddleCell: String,
	HeaderRightCell: String,
	BodyCell: String,
	FooterLeftCell: String,
	FooterMiddleCell: String,
	FooterRightCell: String
}