BokaMera.API.Host

<back to all web services

UpdateRating

The following routes are available for this service:
PUT/rating/Update RatingScoreUpdate rating from booking
UpdateRating Parameters:
NameParameterData TypeRequiredDescription
CompanyIdbodyGuid?Yes
BookingIdbodyintYesId of the booking
IdentifierbodystringNoThe identifier for the booking, use to verify the booking. Only needed when a customer, not admin
RatingScorebodyint?NoThe rating score between 1 and 5.
ReviewbodyUpdateReviewNoThe review for the rating
UpdateReview Parameters:
NameParameterData TypeRequiredDescription
TitleformstringNoThe title for the review
DescriptionformstringNoThe description for the review
AuthorformstringNoThe review author
ReviewAnswerformstringNoThe review answer from the company. Only the company can respond to this
CompanyRatingResponse Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidNo
BookingIdformintNoId of the booking
StatusformintNoThe status of the rating, 1 = Active
RatingScoreformintNoThe rating score
ReviewformRatingReviewResponseNoThe review if any exists to the rating
CreatedDateformDateTimeNo
UpdatedDateformDateTimeNo
RatingReviewResponse Parameters:
NameParameterData TypeRequiredDescription
TitleformstringNoThe title for the review
DescriptionformstringNoThe description for the review
RatingScoreformintNoThe rating score
AuthorformstringNoThe review author
CreatedformDateTimeNoThe created date
ReviewAnswerformstringNoThe review answer from the company

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.

PUT /rating/ HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CompanyId: 00000000-0000-0000-0000-000000000000,
	BookingId: 0,
	Identifier: String,
	RatingScore: 0,
	Review: 
	{
		Title: String,
		Description: String,
		Author: String,
		ReviewAnswer: String
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	BookingId: 0,
	Status: 0,
	RatingScore: 0,
	Review: 
	{
		Title: String,
		Description: String,
		RatingScore: 0,
		Author: String,
		ReviewAnswer: String
	}
}