BokaMera.API.Host

<back to all web services

AddRating

The following routes are available for this service:
POST/rating/Create RatingScoreCreate 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(){}
}


Swift AddRating 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.

POST /rating/ HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

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