POST | /rating/ | Create RatingScore | Create rating from booking |
---|
import java.math.*
import java.util.*
import net.servicestack.client.*
@ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
open class AddRating
{
/**
*
*/
@ApiMember(Description="", IsRequired=true)
var CompanyId:UUID? = null
/**
* Id of the booking
*/
@ApiMember(Description="Id of the booking", IsRequired=true)
var BookingId:Int? = null
/**
* The identifier for the booking, use to verify the booking.
*/
@ApiMember(Description="The identifier for the booking, use to verify the booking.", IsRequired=true)
var Identifier:String? = null
/**
* The rating score between 1 and 5.
*/
@ApiMember(Description="The rating score between 1 and 5.", IsRequired=true)
var RatingScore:Int? = null
/**
* The review for the rating
*/
@ApiMember(Description="The review for the rating")
var Review:CreateReview? = null
}
open class CreateReview
{
/**
* The title for the review
*/
@ApiMember(Description="The title for the review")
var Title:String? = null
/**
* The description for the review
*/
@ApiMember(Description="The description for the review")
var Description:String? = null
/**
* The review author
*/
@ApiMember(Description="The review author")
var Author:String? = null
/**
* The review author
*/
@ApiMember(Description="The review author")
var ReviewAnswer:String? = null
}
open class CompanyRatingResponse
{
/**
*
*/
@ApiMember(Description="")
var CompanyId:UUID? = null
/**
* Id of the booking
*/
@ApiMember(Description="Id of the booking")
var BookingId:Int? = null
/**
* The status of the rating, 1 = Active
*/
@ApiMember(Description="The status of the rating, 1 = Active")
var Status:Int? = null
/**
* The rating score
*/
@ApiMember(Description="The rating score")
var RatingScore:Int? = null
/**
* The review if any exists to the rating
*/
@ApiMember(Description="The review if any exists to the rating")
var Review:RatingReviewResponse? = null
var CreatedDate:Date? = null
var UpdatedDate:Date? = null
}
open class RatingReviewResponse
{
/**
* The title for the review
*/
@ApiMember(Description="The title for the review")
var Title:String? = null
/**
* The description for the review
*/
@ApiMember(Description="The description for the review")
var Description:String? = null
/**
* The rating score
*/
@ApiMember(Description="The rating score")
var RatingScore:Int? = null
/**
* The review author
*/
@ApiMember(Description="The review author")
var Author:String? = null
/**
* The created date
*/
@ApiMember(Description="The created date")
var Created:Date? = null
/**
* The review answer from the company
*/
@ApiMember(Description="The review answer from the company")
var ReviewAnswer:String? = null
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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.bookmore.com
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>