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
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BokaMera.API.ServiceModel.Dtos

Namespace Global

    Namespace BokaMera.API.ServiceModel.Dtos

        <ApiResponse(Description:="You were unauthorized to call this service", StatusCode:=401)>
        <ValidateRequest(Validator:="IsAuthenticated")>
        Public Partial Class CreateBookingPrintout
            Implements ICompany
            '''<Summary>
            '''Enter the company you want to see add a token for, if blank and you are an admin, your company id will be used
            '''</Summary>
            <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 Overridable Property CompanyId As Nullable(Of Guid)

            '''<Summary>
            '''Report id
            '''</Summary>
            <ApiMember(Description:="Report id")>
            Public Overridable Property Id As Integer

            '''<Summary>
            '''Report Name
            '''</Summary>
            <ApiMember(Description:="Report Name", IsRequired:=true)>
            Public Overridable Property Name As String

            '''<Summary>
            '''Report header left cell content
            '''</Summary>
            <ApiMember(Description:="Report header left cell content", IsRequired:=true)>
            Public Overridable Property HeaderLeftCell As String

            '''<Summary>
            '''Report header middle cell content
            '''</Summary>
            <ApiMember(Description:="Report header middle cell content", IsRequired:=true)>
            Public Overridable Property HeaderMiddleCell As String

            '''<Summary>
            '''Report header right cell content
            '''</Summary>
            <ApiMember(Description:="Report header right cell content", IsRequired:=true)>
            Public Overridable Property HeaderRightCell As String

            '''<Summary>
            '''Report body cell content
            '''</Summary>
            <ApiMember(Description:="Report body cell content", IsRequired:=true)>
            Public Overridable Property BodyCell As String

            '''<Summary>
            '''Report footer left cell content
            '''</Summary>
            <ApiMember(Description:="Report footer left cell content", IsRequired:=true)>
            Public Overridable Property FooterLeftCell As String

            '''<Summary>
            '''Report footer middle cell content
            '''</Summary>
            <ApiMember(Description:="Report footer middle cell content", IsRequired:=true)>
            Public Overridable Property FooterMiddleCell As String

            '''<Summary>
            '''Report footer right cell content
            '''</Summary>
            <ApiMember(Description:="Report footer right cell content", IsRequired:=true)>
            Public Overridable Property FooterRightCell As String
        End Class
    End Namespace
End Namespace

VB.NET CreateBookingPrintout 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 HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateBookingPrintout 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>
  <Id>0</Id>
  <Name>String</Name>
</CreateBookingPrintout>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CreateBookingPrintout 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>
  <Id>0</Id>
  <Name>String</Name>
</CreateBookingPrintout>