BokaMera.API.Host

<back to all web services

UpdateRating

The following routes are available for this service:
PUT/rating/Update RatingScoreUpdate 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

        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 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

        <ApiResponse(Description:="You were unauthorized to call this service", StatusCode:=401)>
        Public Partial Class UpdateRating
            '''<Summary>
            '''
            '''</Summary>
            <ApiMember(Description:="", IsRequired:=true)>
            Public Overridable Property CompanyId As Nullable(Of 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. Only needed when a customer, not admin
            '''</Summary>
            <ApiMember(Description:="The identifier for the booking, use to verify the booking. Only needed when a customer, not admin")>
            Public Overridable Property Identifier As String

            '''<Summary>
            '''The rating score between 1 and 5.
            '''</Summary>
            <ApiMember(Description:="The rating score between 1 and 5.")>
            Public Overridable Property RatingScore As Nullable(Of Integer)

            '''<Summary>
            '''The review for the rating
            '''</Summary>
            <ApiMember(Description:="The review for the rating")>
            Public Overridable Property Review As UpdateReview
        End Class

        Public Partial Class UpdateReview
            '''<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 answer from the company. Only the company can respond to this
            '''</Summary>
            <ApiMember(Description:="The review answer from the company. Only the company can respond to this")>
            Public Overridable Property ReviewAnswer As String
        End Class
    End Namespace
End Namespace

VB.NET UpdateRating DTOs

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: api.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
	}
}