BokaMera.API.Host

<back to all web services

UpdateRating

The following routes are available for this service:
PUT/rating/Update RatingScoreUpdate 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 UpdateRating
{
    /**
    * 
    */
    @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. Only needed when a customer, not admin
    */
    @ApiMember(Description="The identifier for the booking, use to verify the booking. Only needed when a customer, not admin")
    var Identifier:String? = null

    /**
    * The rating score between 1 and 5.
    */
    @ApiMember(Description="The rating score between 1 and 5.")
    var RatingScore:Int? = null

    /**
    * The review for the rating
    */
    @ApiMember(Description="The review for the rating")
    var Review:UpdateReview? = null
}

open class UpdateReview
{
    /**
    * 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 answer from the company. Only the company can respond to this
    */
    @ApiMember(Description="The review answer from the company. Only the company can respond to this")
    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
}

Kotlin UpdateRating DTOs

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

HTTP + OTHER

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/jsonl
Content-Type: text/jsonl
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/jsonl
Content-Length: length

{"BookingId":0,"Status":0,"RatingScore":0,"Review":{"Title":"String","Description":"String","RatingScore":0,"Author":"String","ReviewAnswer":"String"}}