Requires any of the roles: | bookingsupplier-administrator-write, bookingsupplier-administrator-read, superadmin |
GET | /reports/booking/printout | Get all reports used for booking export |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CompanyId | query | Guid? | No | Enter the company you want to see add a token for, if blank and you are an admin, your company id will be used |
Id | query | int? | No | Report id |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Skip | query | int | No | Skip 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 |
Take | query | int | No | Return a given number of elements in a sequence and then skip over the remainder. Use this when you need paging. Example: ?take=20 |
OrderBy | query | string | No | 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. Example: ?orderBy=Id,-Age,FirstName |
OrderByDesc | query | string | No | 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. Example: ?orderByDesc=Id,-Age,FirstName |
Include | query | string | No | Include 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 |
Fields | form | string | No | |
Meta | form | Dictionary<string, string> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CompanyId | form | Guid | Yes | |
Id | form | int | No | |
Name | form | string | Yes | |
HeaderLeftCell | form | string | No | |
HeaderMiddleCell | form | string | No | |
HeaderRightCell | form | string | No | |
BodyCell | form | string | Yes | |
FooterLeftCell | form | string | No | |
FooterMiddleCell | form | string | No | |
FooterRightCell | form | string | No | |
ModifiedDate | form | DateTimeOffset? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | Report id |
Name | form | string | No | Report Name |
HeaderLeftCell | form | string | Yes | Report header left cell content |
HeaderMiddleCell | form | string | Yes | Report header middle cell content |
HeaderRightCell | form | string | Yes | Report header right cell content |
BodyCell | form | string | Yes | Report body cell content |
FooterLeftCell | form | string | Yes | Report footer left cell content |
FooterMiddleCell | form | string | Yes | Report footer middle cell content |
FooterRightCell | form | string | Yes | Report footer right cell content |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Offset | form | int | No | |
Total | form | int | No | |
Results | form | List<AccessKeyTypeResponse> | No | |
Meta | form | Dictionary<string, string> | No | |
ResponseStatus | form | ResponseStatus | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | |
KeyType | form | string | No | |
Description | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=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"}}}