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
namespace BokaMera.API.ServiceModel.Dtos

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)>]
    [<ValidateRequest(Validator="IsAuthenticated")>]
    [<AllowNullLiteral>]
    type TestBookingPrintout() = 
        ///<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")>]
        member val CompanyId:Nullable<Guid> = new Nullable<Guid>() with get,set

        ///<summary>
        ///Report header left cell content
        ///</summary>
        [<ApiMember(Description="Report header left cell content", IsRequired=true)>]
        member val HeaderLeftCell:String = null with get,set

        ///<summary>
        ///Report header middle cell content
        ///</summary>
        [<ApiMember(Description="Report header middle cell content", IsRequired=true)>]
        member val HeaderMiddleCell:String = null with get,set

        ///<summary>
        ///Report header right cell content
        ///</summary>
        [<ApiMember(Description="Report header right cell content", IsRequired=true)>]
        member val HeaderRightCell:String = null with get,set

        ///<summary>
        ///Report body cell content
        ///</summary>
        [<ApiMember(Description="Report body cell content", IsRequired=true)>]
        member val BodyCell:String = null with get,set

        ///<summary>
        ///Report footer left cell content
        ///</summary>
        [<ApiMember(Description="Report footer left cell content", IsRequired=true)>]
        member val FooterLeftCell:String = null with get,set

        ///<summary>
        ///Report footer middle cell content
        ///</summary>
        [<ApiMember(Description="Report footer middle cell content", IsRequired=true)>]
        member val FooterMiddleCell:String = null with get,set

        ///<summary>
        ///Report footer right cell content
        ///</summary>
        [<ApiMember(Description="Report footer right cell content", IsRequired=true)>]
        member val FooterRightCell:String = null with get,set

F# TestBookingPrintout DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

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

{}