POST | /rating/ | Create RatingScore | Create rating from booking |
---|
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BokaMera.API.ServiceModel.Dtos
Namespace Global
Namespace BokaMera.API.ServiceModel.Dtos
<ApiResponse(Description:="You were unauthorized to call this service", StatusCode:=401)>
Public Partial Class AddRating
'''<Summary>
'''
'''</Summary>
<ApiMember(Description:="", IsRequired:=true)>
Public Overridable Property CompanyId As Guid
'''<Summary>
'''Id of the booking
'''</Summary>
<ApiMember(Description:="Id of the booking", IsRequired:=true)>
Public Overridable Property BookingId As Integer
'''<Summary>
'''The identifier for the booking, use to verify the booking.
'''</Summary>
<ApiMember(Description:="The identifier for the booking, use to verify the booking.", IsRequired:=true)>
Public Overridable Property Identifier As String
'''<Summary>
'''The rating score between 1 and 5.
'''</Summary>
<ApiMember(Description:="The rating score between 1 and 5.", IsRequired:=true)>
Public Overridable Property RatingScore As Integer
'''<Summary>
'''The review for the rating
'''</Summary>
<ApiMember(Description:="The review for the rating")>
Public Overridable Property Review As CreateReview
End Class
Public Partial Class CompanyRatingResponse
'''<Summary>
'''
'''</Summary>
<ApiMember(Description:="")>
Public Overridable Property CompanyId As Guid
'''<Summary>
'''Id of the booking
'''</Summary>
<ApiMember(Description:="Id of the booking")>
Public Overridable Property BookingId As Integer
'''<Summary>
'''The status of the rating, 1 = Active
'''</Summary>
<ApiMember(Description:="The status of the rating, 1 = Active")>
Public Overridable Property Status As Integer
'''<Summary>
'''The rating score
'''</Summary>
<ApiMember(Description:="The rating score")>
Public Overridable Property RatingScore As Integer
'''<Summary>
'''The review if any exists to the rating
'''</Summary>
<ApiMember(Description:="The review if any exists to the rating")>
Public Overridable Property Review As RatingReviewResponse
Public Overridable Property CreatedDate As Date
Public Overridable Property UpdatedDate As Date
End Class
Public Partial Class CreateReview
'''<Summary>
'''The title for the review
'''</Summary>
<ApiMember(Description:="The title for the review")>
Public Overridable Property Title As String
'''<Summary>
'''The description for the review
'''</Summary>
<ApiMember(Description:="The description for the review")>
Public Overridable Property Description As String
'''<Summary>
'''The review author
'''</Summary>
<ApiMember(Description:="The review author")>
Public Overridable Property Author As String
'''<Summary>
'''The review author
'''</Summary>
<ApiMember(Description:="The review author")>
Public Overridable Property ReviewAnswer As String
End Class
Public Partial Class RatingReviewResponse
'''<Summary>
'''The title for the review
'''</Summary>
<ApiMember(Description:="The title for the review")>
Public Overridable Property Title As String
'''<Summary>
'''The description for the review
'''</Summary>
<ApiMember(Description:="The description for the review")>
Public Overridable Property Description As String
'''<Summary>
'''The rating score
'''</Summary>
<ApiMember(Description:="The rating score")>
Public Overridable Property RatingScore As Integer
'''<Summary>
'''The review author
'''</Summary>
<ApiMember(Description:="The review author")>
Public Overridable Property Author As String
'''<Summary>
'''The created date
'''</Summary>
<ApiMember(Description:="The created date")>
Public Overridable Property Created As Date
'''<Summary>
'''The review answer from the company
'''</Summary>
<ApiMember(Description:="The review answer from the company")>
Public Overridable Property ReviewAnswer As String
End Class
End Namespace
End Namespace
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>