BokaMera.API.Host

<back to all web services

AddRating

The following routes are available for this service:
POST/rating/Create RatingScoreCreate rating from booking
AddRating Parameters:
NameParameterData TypeRequiredDescription
CompanyIdbodyGuidYes
BookingIdbodyintYesId of the booking
IdentifierbodystringYesThe identifier for the booking, use to verify the booking.
RatingScorebodyintYesThe rating score between 1 and 5.
ReviewbodyCreateReviewYesThe review for the rating
CreateReview Parameters:
NameParameterData TypeRequiredDescription
TitleformstringYesThe title for the review
DescriptionformstringYesThe description for the review
AuthorformstringYesThe review author
ReviewAnswerformstringYesThe review author
CompanyRatingResponse Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidNo
BookingIdformintNoId of the booking
StatusformintNoThe status of the rating, 1 = Active
RatingScoreformintNoThe rating score
ReviewformRatingReviewResponseYesThe review if any exists to the rating
CreatedDateformDateTimeNo
UpdatedDateformDateTimeNo
RatingReviewResponse Parameters:
NameParameterData TypeRequiredDescription
TitleformstringYesThe title for the review
DescriptionformstringYesThe description for the review
RatingScoreformintNoThe rating score
AuthorformstringYesThe review author
CreatedformDateTimeNoThe created date
ReviewAnswerformstringYesThe review answer from the company

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

HTTP + XML

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

POST /rating/ HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AddRating xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <BookingId>0</BookingId>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <Identifier>String</Identifier>
  <RatingScore>0</RatingScore>
  <Review>
    <Author>String</Author>
    <Description>String</Description>
    <ReviewAnswer>String</ReviewAnswer>
    <Title>String</Title>
  </Review>
</AddRating>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CompanyRatingResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <BookingId>0</BookingId>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <CreatedDate>0001-01-01T00:00:00</CreatedDate>
  <RatingScore>0</RatingScore>
  <Review>
    <Author>String</Author>
    <Created>0001-01-01T00:00:00</Created>
    <Description>String</Description>
    <RatingScore>0</RatingScore>
    <ReviewAnswer>String</ReviewAnswer>
    <Title>String</Title>
  </Review>
  <Status>0</Status>
  <UpdatedDate>0001-01-01T00:00:00</UpdatedDate>
</CompanyRatingResponse>