BokaMera.API.Host

ReportQuery

**Requires Authentication**
Requires any of the roles:	bookingsupplier-administrator-write, bookingsupplier-administrator-read, superadmin

The following routes are available for this service:
GET	/bookings/reports/	Get all reports	Get a list of all existing reports.

**ReportQuery** Parameters:
Name	Parameter	Data Type	Required	Description
CompanyId	query	Guid?	No	The company id, if empty will use the company id for the user you are logged in with.

**QueryBase** Parameters:
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

**BookingPrintout** Parameters:
Name	Parameter	Data Type	Required
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
MessageTemplate	form	string	No
Language	form	string	No
ModifiedDate	form	DateTimeOffset?	No

**PrintoutBase** Parameters:
Name	Parameter	Data Type	Required
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

**ReportQueryResponse** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
CompanyId	form	Guid	No
Name	form	string	Yes

**QueryResponse<T>** Parameters:
Name	Parameter	Data Type	Required
Offset	form	int	No
Total	form	int	No
Results	form	List<AccessKeyTypeResponse>	No
Meta	form	Dictionary<string, string>	No
ResponseStatus	form	ResponseStatus	No

**AccessKeyTypeResponse** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
KeyType	form	string	Yes
Description	form	string	Yes

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

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /bookings/reports/ HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Offset: 0,
	Total: 0,
	Results: 
	[
		{
			Id: 0,
			Name: String
		}
	],
	Meta: 
	{
		String: String
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}