BokaMera.API.Host

RatingQuery

The following routes are available for this service:
GET	/rating/	Get Ratings	Get Ratings.

**RatingQuery** Parameters:
Name	Parameter	Data Type	Required	Description
CompanyId	query	Guid?	No
BookingId	query	int?	No	Id of the booking
Active	query	bool?	No	If you want to collect only active ratings. Ratings are only active after one has past since creation date.
IncludeRatingReviews	query	boolean	No	If you want to include the rating reviews
CreatedFrom	query	dateTime	No	Start of interval to query for bookings when they where created. UTC+0 and parameter as defined by date-time - RFC3339
CreatedTo	query	dateTime	No	End of interval to query for bookings when they where created. UTC+0 and parameter as defined by date-time - RFC3339

**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

**Rating** Parameters:
Name	Parameter	Data Type	Required
ReviewId	form	Guid?	No
Review	form	Review	No
CompanyId	form	Guid	Yes
BookingId	form	int	Yes
RatingScore	form	int	Yes
Status	form	int	Yes
Created	form	DateTime	Yes
Updated	form	DateTime	Yes
ModifiedDate	form	DateTimeOffset?	No

**Review** Parameters:
Name	Parameter	Data Type	Required
ReviewId	form	Guid	No
CompanyId	form	Guid	Yes
Title	form	string	Yes
Description	form	string	Yes
Author	form	string	Yes
Status	form	int	Yes
Created	form	DateTime	Yes
Updated	form	DateTime	Yes
ModifiedDate	form	DateTimeOffset?	No
ReviewAnswer	form	string	No

**CompanyRatingResponse** Parameters:
Name	Parameter	Data Type	Required	Description
CompanyId	form	Guid	No
BookingId	form	int	No	Id of the booking
Status	form	int	No	The status of the rating, 1 = Active
RatingScore	form	int	No	The rating score
Review	form	RatingReviewResponse	No	The review if any exists to the rating
CreatedDate	form	DateTime	No
UpdatedDate	form	DateTime	No

**RatingReviewResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Title	form	string	No	The title for the review
Description	form	string	No	The description for the review
RatingScore	form	int	No	The rating score
Author	form	string	No	The review author
Created	form	DateTime	No	The created date
ReviewAnswer	form	string	No	The review answer from the company

**QueryResponse<AccessKeyTypeResponse>** 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	No
Description	form	string	No

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 /rating/ 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: 
	[
		{
			BookingId: 0,
			Status: 0,
			RatingScore: 0,
			Review: 
			{
				Title: String,
				Description: String,
				RatingScore: 0,
				Author: String,
				ReviewAnswer: String
			}
		}
	],
	Meta: 
	{
		String: String
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}