| POST | /rating/ | Create RatingScore | Create rating from booking |
|---|
import Foundation
import ServiceStack
// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
public class AddRating : Codable
{
/**
*
*/
// @ApiMember(Description="", IsRequired=true)
public var companyId:String
/**
* Id of the booking
*/
// @ApiMember(Description="Id of the booking", IsRequired=true)
public var bookingId:Int
/**
* The identifier for the booking, use to verify the booking.
*/
// @ApiMember(Description="The identifier for the booking, use to verify the booking.", IsRequired=true)
public var identifier:String
/**
* The rating score between 1 and 5.
*/
// @ApiMember(Description="The rating score between 1 and 5.", IsRequired=true)
public var ratingScore:Int
/**
* The review for the rating
*/
// @ApiMember(Description="The review for the rating")
public var review:CreateReview
required public init(){}
}
public class CreateReview : Codable
{
/**
* The title for the review
*/
// @ApiMember(Description="The title for the review")
public var title:String
/**
* The description for the review
*/
// @ApiMember(Description="The description for the review")
public var Description:String
/**
* The review author
*/
// @ApiMember(Description="The review author")
public var author:String
/**
* The review author
*/
// @ApiMember(Description="The review author")
public var reviewAnswer:String
required public init(){}
}
public class CompanyRatingResponse : Codable
{
/**
*
*/
// @ApiMember(Description="")
public var companyId:String
/**
* Id of the booking
*/
// @ApiMember(Description="Id of the booking")
public var bookingId:Int
/**
* The status of the rating, 1 = Active
*/
// @ApiMember(Description="The status of the rating, 1 = Active")
public var status:Int
/**
* The rating score
*/
// @ApiMember(Description="The rating score")
public var ratingScore:Int
/**
* The review if any exists to the rating
*/
// @ApiMember(Description="The review if any exists to the rating")
public var review:RatingReviewResponse
public var createdDate:Date
public var updatedDate:Date
required public init(){}
}
public class RatingReviewResponse : Codable
{
/**
* The title for the review
*/
// @ApiMember(Description="The title for the review")
public var title:String
/**
* The description for the review
*/
// @ApiMember(Description="The description for the review")
public var Description:String
/**
* The rating score
*/
// @ApiMember(Description="The rating score")
public var ratingScore:Int
/**
* The review author
*/
// @ApiMember(Description="The review author")
public var author:String
/**
* The created date
*/
// @ApiMember(Description="The created date")
public var created:Date
/**
* The review answer from the company
*/
// @ApiMember(Description="The review answer from the company")
public var reviewAnswer:String
required public init(){}
}
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.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>