BokaMera.API.Host

<back to all web services

BookingPrintoutQuery

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, bookingsupplier-administrator-read, superadmin
The following routes are available for this service:
GET/reports/booking/printoutGet all reports used for booking export
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BokaMera.API.ServiceModel.Dtos;
using BokaMera.API.ServiceModel.Db;

namespace BokaMera.API.ServiceModel.Db
{
    public partial class BaseModel
    {
    }

    public partial class BookingPrintout
        : PrintoutBase
    {
        [Required]
        public virtual Guid CompanyId { get; set; }

        public virtual int Id { get; set; }
        [Required]
        public virtual string Name { get; set; }

        public virtual string? HeaderLeftCell { get; set; }
        public virtual string? HeaderMiddleCell { get; set; }
        public virtual string? HeaderRightCell { get; set; }
        [Required]
        public virtual string BodyCell { get; set; }

        public virtual string? FooterLeftCell { get; set; }
        public virtual string? FooterMiddleCell { get; set; }
        public virtual string? FooterRightCell { get; set; }
        public virtual string? MessageTemplate { get; set; }
        public virtual string? Language { get; set; }
        public virtual DateTimeOffset? ModifiedDate { get; set; }
    }

    public partial class PrintoutBase
        : BaseModel
    {
        [Required]
        public virtual Guid CompanyId { get; set; }

        public virtual int Id { get; set; }
        [Required]
        public virtual string Name { get; set; }

        public virtual string? HeaderLeftCell { get; set; }
        public virtual string? HeaderMiddleCell { get; set; }
        public virtual string? HeaderRightCell { get; set; }
        [Required]
        public virtual string BodyCell { get; set; }

        public virtual string? FooterLeftCell { get; set; }
        public virtual string? FooterMiddleCell { get; set; }
        public virtual string? FooterRightCell { get; set; }
        public virtual DateTimeOffset? ModifiedDate { get; set; }
    }

}

namespace BokaMera.API.ServiceModel.Dtos
{
    public partial class AccessKeyTypeResponse
    {
        public virtual int Id { get; set; }
        public virtual string KeyType { get; set; }
        public virtual string Description { get; set; }
    }

    [ValidateRequest("IsAuthenticated")]
    public partial class BookingPrintoutQuery
        : QueryDb<BookingPrintout, PrintoutQueryResponse>, 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 virtual Guid? CompanyId { get; set; }

        ///<summary>
        ///Report id
        ///</summary>
        [ApiMember(Description="Report id", ParameterType="query")]
        public virtual int? Id { get; set; }
    }

    public partial class PrintoutQueryResponse
    {
        ///<summary>
        ///Report id
        ///</summary>
        [ApiMember(Description="Report id")]
        public virtual int Id { get; set; }

        ///<summary>
        ///Report Name
        ///</summary>
        [ApiMember(Description="Report Name")]
        public virtual string Name { get; set; }

        ///<summary>
        ///Report header left cell content
        ///</summary>
        [ApiMember(Description="Report header left cell content", IsRequired=true)]
        public virtual string HeaderLeftCell { get; set; }

        ///<summary>
        ///Report header middle cell content
        ///</summary>
        [ApiMember(Description="Report header middle cell content", IsRequired=true)]
        public virtual string HeaderMiddleCell { get; set; }

        ///<summary>
        ///Report header right cell content
        ///</summary>
        [ApiMember(Description="Report header right cell content", IsRequired=true)]
        public virtual string HeaderRightCell { get; set; }

        ///<summary>
        ///Report body cell content
        ///</summary>
        [ApiMember(Description="Report body cell content", IsRequired=true)]
        public virtual string BodyCell { get; set; }

        ///<summary>
        ///Report footer left cell content
        ///</summary>
        [ApiMember(Description="Report footer left cell content", IsRequired=true)]
        public virtual string FooterLeftCell { get; set; }

        ///<summary>
        ///Report footer middle cell content
        ///</summary>
        [ApiMember(Description="Report footer middle cell content", IsRequired=true)]
        public virtual string FooterMiddleCell { get; set; }

        ///<summary>
        ///Report footer right cell content
        ///</summary>
        [ApiMember(Description="Report footer right cell content", IsRequired=true)]
        public virtual string FooterRightCell { get; set; }
    }

}

namespace ServiceStack
{
    [DataContract]
    public partial class QueryBase
    {
        [DataMember(Order=1)]
        public virtual int? Skip { get; set; }

        [DataMember(Order=2)]
        public virtual int? Take { get; set; }

        [DataMember(Order=3)]
        public virtual string? OrderBy { get; set; }

        [DataMember(Order=4)]
        public virtual string? OrderByDesc { get; set; }

        [DataMember(Order=5)]
        public virtual string? Include { get; set; }

        [DataMember(Order=6)]
        public virtual string? Fields { get; set; }

        [DataMember(Order=7)]
        public virtual Dictionary<string, string>? Meta { get; set; }
    }

    public partial class QueryDb<From, Into>
        : QueryBase
    {
    }

    [DataContract]
    public partial class QueryResponse<T>
    {
        [DataMember(Order=1)]
        public virtual int Offset { get; set; }

        [DataMember(Order=2)]
        public virtual int Total { get; set; }

        [DataMember(Order=3)]
        public virtual List<AccessKeyTypeResponse> Results { get; set; } = [];

        [DataMember(Order=4)]
        public virtual Dictionary<string, string>? Meta { get; set; }

        [DataMember(Order=5)]
        public virtual ResponseStatus? ResponseStatus { get; set; }
    }

}

C# BookingPrintoutQuery 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.

GET /reports/booking/printout HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfPrintoutQueryResponseWg5EthtI xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Offset>0</Offset>
  <Total>0</Total>
  <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
    <d2p1:PrintoutQueryResponse>
      <d2p1:BodyCell>String</d2p1:BodyCell>
      <d2p1:FooterLeftCell>String</d2p1:FooterLeftCell>
      <d2p1:FooterMiddleCell>String</d2p1:FooterMiddleCell>
      <d2p1:FooterRightCell>String</d2p1:FooterRightCell>
      <d2p1:HeaderLeftCell>String</d2p1:HeaderLeftCell>
      <d2p1:HeaderMiddleCell>String</d2p1:HeaderMiddleCell>
      <d2p1:HeaderRightCell>String</d2p1:HeaderRightCell>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:Name>String</d2p1:Name>
    </d2p1:PrintoutQueryResponse>
  </Results>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <ResponseStatus>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StackTrace>String</StackTrace>
    <Errors>
      <ResponseError>
        <ErrorCode>String</ErrorCode>
        <FieldName>String</FieldName>
        <Message>String</Message>
        <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Meta>
      </ResponseError>
    </Errors>
    <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Meta>
  </ResponseStatus>
</QueryResponseOfPrintoutQueryResponseWg5EthtI>