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
BookingPrintoutQuery Parameters:
NameParameterData TypeRequiredDescription
CompanyIdqueryGuid?NoEnter the company you want to see add a token for, if blank and you are an admin, your company id will be used
Idqueryint?NoReport id
QueryBase Parameters:
NameParameterData TypeRequiredDescription
SkipqueryintNoSkip over a given number of elements in a sequence and then return the remainder. Use this when you need paging.

Example:
?skip=10&orderBy=Id
TakequeryintNoReturn a given number of elements in a sequence and then skip over the remainder. Use this when you need paging.

Example:
?take=20
OrderByquerystringNoComma 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.

Example:
?orderBy=Id,-Age,FirstName
OrderByDescquerystringNoComma 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.

Example:
?orderByDesc=Id,-Age,FirstName
IncludequerystringNoInclude any of the aggregates AVG, COUNT, FIRST, LAST, MAX, MIN, SUM in your result set. The results will be returned in the meta field.

Example:
?include=COUNT(*) as Total

or multiple fields with
?include=Count(*) Total, Min(Age), AVG(Age) AverageAge

or unique with
?include=COUNT(DISTINCT LivingStatus) as UniqueStatus
FieldsformstringNo
MetaformDictionary<string, string>No
BookingPrintout Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidYes
IdformintNo
NameformstringYes
HeaderLeftCellformstringNo
HeaderMiddleCellformstringNo
HeaderRightCellformstringNo
BodyCellformstringYes
FooterLeftCellformstringNo
FooterMiddleCellformstringNo
FooterRightCellformstringNo
ModifiedDateformDateTimeOffset?No
BookingPrintoutQueryResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNoReport id
NameformstringNoReport Name
HeaderLeftCellformstringYesReport header left cell content
HeaderMiddleCellformstringYesReport header middle cell content
HeaderRightCellformstringYesReport header right cell content
BodyCellformstringYesReport body cell content
FooterLeftCellformstringYesReport footer left cell content
FooterMiddleCellformstringYesReport footer middle cell content
FooterRightCellformstringYesReport footer right cell content
QueryResponse<AccessKeyTypeResponse> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<AccessKeyTypeResponse>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo
AccessKeyTypeResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
KeyTypeformstringNo
DescriptionformstringNo

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.

GET /reports/booking/printout HTTP/1.1 
Host: api.bokamera.se 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}