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
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
import com.google.gson.annotations.*;
import com.google.gson.reflect.*;

public class dtos
{

    @ValidateRequest(Validator="IsAuthenticated")
    public static class BookingPrintoutQuery extends QueryDb<BookingPrintout, BookingPrintoutQueryResponse> implements 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 UUID CompanyId = null;

        /**
        * Report id
        */
        @ApiMember(Description="Report id", ParameterType="query")
        public Integer Id = null;
        
        public UUID getCompanyId() { return CompanyId; }
        public BookingPrintoutQuery setCompanyId(UUID value) { this.CompanyId = value; return this; }
        public Integer getId() { return Id; }
        public BookingPrintoutQuery setId(Integer value) { this.Id = value; return this; }
    }

    public static class QueryDb<From, Into> extends QueryBase
    {
        
    }

    @DataContract
    public static class QueryBase
    {
        /**
        * Skip over a given number of elements in a sequence and then return the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?skip=10&orderBy=Id</code>
        */
        @DataMember(Order=1)
        public Integer Skip = null;

        /**
        * Return a given number of elements in a sequence and then skip over the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?take=20</code>
        */
        @DataMember(Order=2)
        public Integer Take = null;

        /**
        * Comma separated list of fields to order by. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderBy=Id,-Age,FirstName</code>
        */
        @DataMember(Order=3)
        public String OrderBy = null;

        /**
        * Comma separated list of fields to order by in descending order. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderByDesc=Id,-Age,FirstName</code>
        */
        @DataMember(Order=4)
        public String OrderByDesc = null;

        /**
        * Include any of the aggregates <code>AVG, COUNT, FIRST, LAST, MAX, MIN, SUM</code> in your result set. The results will be returned in the meta field.<br/><br/><strong>Example:</strong><br/><code>?include=COUNT(*) as Total</code><br/><br/>or multiple fields with<br/><code>?include=Count(*) Total, Min(Age), AVG(Age) AverageAge</code><br/></br>or unique with<br/><code>?include=COUNT(DISTINCT LivingStatus) as UniqueStatus</code>
        */
        @DataMember(Order=5)
        public String Include = null;

        @DataMember(Order=6)
        public String Fields = null;

        @DataMember(Order=7)
        public HashMap<String,String> Meta = null;
        
        public Integer getSkip() { return Skip; }
        public QueryBase setSkip(Integer value) { this.Skip = value; return this; }
        public Integer getTake() { return Take; }
        public QueryBase setTake(Integer value) { this.Take = value; return this; }
        public String getOrderBy() { return OrderBy; }
        public QueryBase setOrderBy(String value) { this.OrderBy = value; return this; }
        public String getOrderByDesc() { return OrderByDesc; }
        public QueryBase setOrderByDesc(String value) { this.OrderByDesc = value; return this; }
        public String getInclude() { return Include; }
        public QueryBase setInclude(String value) { this.Include = value; return this; }
        public String getFields() { return Fields; }
        public QueryBase setFields(String value) { this.Fields = value; return this; }
        public HashMap<String,String> getMeta() { return Meta; }
        public QueryBase setMeta(HashMap<String,String> value) { this.Meta = value; return this; }
    }

    public static class BookingPrintout extends BaseModel
    {
        @Required()
        public UUID CompanyId = null;

        public Integer Id = null;
        @Required()
        public String Name = null;

        public String HeaderLeftCell = null;
        public String HeaderMiddleCell = null;
        public String HeaderRightCell = null;
        @Required()
        public String BodyCell = null;

        public String FooterLeftCell = null;
        public String FooterMiddleCell = null;
        public String FooterRightCell = null;
        public Date ModifiedDate = null;
        
        public UUID getCompanyId() { return CompanyId; }
        public BookingPrintout setCompanyId(UUID value) { this.CompanyId = value; return this; }
        public Integer getId() { return Id; }
        public BookingPrintout setId(Integer value) { this.Id = value; return this; }
        public String getName() { return Name; }
        public BookingPrintout setName(String value) { this.Name = value; return this; }
        public String getHeaderLeftCell() { return HeaderLeftCell; }
        public BookingPrintout setHeaderLeftCell(String value) { this.HeaderLeftCell = value; return this; }
        public String getHeaderMiddleCell() { return HeaderMiddleCell; }
        public BookingPrintout setHeaderMiddleCell(String value) { this.HeaderMiddleCell = value; return this; }
        public String getHeaderRightCell() { return HeaderRightCell; }
        public BookingPrintout setHeaderRightCell(String value) { this.HeaderRightCell = value; return this; }
        public String getBodyCell() { return BodyCell; }
        public BookingPrintout setBodyCell(String value) { this.BodyCell = value; return this; }
        public String getFooterLeftCell() { return FooterLeftCell; }
        public BookingPrintout setFooterLeftCell(String value) { this.FooterLeftCell = value; return this; }
        public String getFooterMiddleCell() { return FooterMiddleCell; }
        public BookingPrintout setFooterMiddleCell(String value) { this.FooterMiddleCell = value; return this; }
        public String getFooterRightCell() { return FooterRightCell; }
        public BookingPrintout setFooterRightCell(String value) { this.FooterRightCell = value; return this; }
        public Date getModifiedDate() { return ModifiedDate; }
        public BookingPrintout setModifiedDate(Date value) { this.ModifiedDate = value; return this; }
    }

    public static class BaseModel
    {
        
    }

    public static class BookingPrintoutQueryResponse
    {
        /**
        * Report id
        */
        @ApiMember(Description="Report id")
        public Integer Id = null;

        /**
        * Report Name
        */
        @ApiMember(Description="Report Name")
        public String Name = null;

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

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

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

        /**
        * Report body cell content
        */
        @ApiMember(Description="Report body cell content", IsRequired=true)
        public String BodyCell = null;

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

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

        /**
        * Report footer right cell content
        */
        @ApiMember(Description="Report footer right cell content", IsRequired=true)
        public String FooterRightCell = null;
        
        public Integer getId() { return Id; }
        public BookingPrintoutQueryResponse setId(Integer value) { this.Id = value; return this; }
        public String getName() { return Name; }
        public BookingPrintoutQueryResponse setName(String value) { this.Name = value; return this; }
        public String getHeaderLeftCell() { return HeaderLeftCell; }
        public BookingPrintoutQueryResponse setHeaderLeftCell(String value) { this.HeaderLeftCell = value; return this; }
        public String getHeaderMiddleCell() { return HeaderMiddleCell; }
        public BookingPrintoutQueryResponse setHeaderMiddleCell(String value) { this.HeaderMiddleCell = value; return this; }
        public String getHeaderRightCell() { return HeaderRightCell; }
        public BookingPrintoutQueryResponse setHeaderRightCell(String value) { this.HeaderRightCell = value; return this; }
        public String getBodyCell() { return BodyCell; }
        public BookingPrintoutQueryResponse setBodyCell(String value) { this.BodyCell = value; return this; }
        public String getFooterLeftCell() { return FooterLeftCell; }
        public BookingPrintoutQueryResponse setFooterLeftCell(String value) { this.FooterLeftCell = value; return this; }
        public String getFooterMiddleCell() { return FooterMiddleCell; }
        public BookingPrintoutQueryResponse setFooterMiddleCell(String value) { this.FooterMiddleCell = value; return this; }
        public String getFooterRightCell() { return FooterRightCell; }
        public BookingPrintoutQueryResponse setFooterRightCell(String value) { this.FooterRightCell = value; return this; }
    }

    @DataContract
    public static class QueryResponse<AccessKeyTypeResponse>
    {
        @DataMember(Order=1)
        public Integer Offset = null;

        @DataMember(Order=2)
        public Integer Total = null;

        @DataMember(Order=3)
        public ArrayList<AccessKeyTypeResponse> Results = null;

        @DataMember(Order=4)
        public HashMap<String,String> Meta = null;

        @DataMember(Order=5)
        public ResponseStatus ResponseStatus = null;
        
        public Integer getOffset() { return Offset; }
        public QueryResponse<AccessKeyTypeResponse> setOffset(Integer value) { this.Offset = value; return this; }
        public Integer getTotal() { return Total; }
        public QueryResponse<AccessKeyTypeResponse> setTotal(Integer value) { this.Total = value; return this; }
        public ArrayList<AccessKeyTypeResponse> getResults() { return Results; }
        public QueryResponse<AccessKeyTypeResponse> setResults(ArrayList<AccessKeyTypeResponse> value) { this.Results = value; return this; }
        public HashMap<String,String> getMeta() { return Meta; }
        public QueryResponse<AccessKeyTypeResponse> setMeta(HashMap<String,String> value) { this.Meta = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public QueryResponse<AccessKeyTypeResponse> setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

    public static class AccessKeyTypeResponse
    {
        public Integer Id = null;
        public String KeyType = null;
        public String Description = null;
        
        public Integer getId() { return Id; }
        public AccessKeyTypeResponse setId(Integer value) { this.Id = value; return this; }
        public String getKeyType() { return KeyType; }
        public AccessKeyTypeResponse setKeyType(String value) { this.KeyType = value; return this; }
        public String getDescription() { return Description; }
        public AccessKeyTypeResponse setDescription(String value) { this.Description = value; return this; }
    }

}

Java BookingPrintoutQuery DTOs

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

HTTP + OTHER

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: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Offset":0,"Total":0,"Results":[{"Id":0,"Name":"String","HeaderLeftCell":"String","HeaderMiddleCell":"String","HeaderRightCell":"String","BodyCell":"String","FooterLeftCell":"String","FooterMiddleCell":"String","FooterRightCell":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}