BokaMera.API.Host

AddRating

The following routes are available for this service:
POST	/rating/	Create RatingScore	Create rating from booking


export class RatingReviewResponse
{
    /** @description The title for the review */
    // @ApiMember(Description="The title for the review")
    public Title: string;

    /** @description The description for the review */
    // @ApiMember(Description="The description for the review")
    public Description: string;

    /** @description The rating score */
    // @ApiMember(Description="The rating score")
    public RatingScore: number;

    /** @description The review author */
    // @ApiMember(Description="The review author")
    public Author: string;

    /** @description The created date */
    // @ApiMember(Description="The created date")
    public Created: string;

    /** @description The review answer from the company */
    // @ApiMember(Description="The review answer from the company")
    public ReviewAnswer: string;

    public constructor(init?: Partial<RatingReviewResponse>) { (Object as any).assign(this, init); }
}

export class CompanyRatingResponse
{
    /** @description  */
    // @ApiMember(Description="")
    public CompanyId: string;

    /** @description Id of the booking */
    // @ApiMember(Description="Id of the booking")
    public BookingId: number;

    /** @description The status of the rating, 1 = Active */
    // @ApiMember(Description="The status of the rating, 1 = Active")
    public Status: number;

    /** @description The rating score */
    // @ApiMember(Description="The rating score")
    public RatingScore: number;

    /** @description The review if any exists to the rating */
    // @ApiMember(Description="The review if any exists to the rating")
    public Review: RatingReviewResponse;

    public CreatedDate: string;
    public UpdatedDate: string;

    public constructor(init?: Partial<CompanyRatingResponse>) { (Object as any).assign(this, init); }
}

export class CreateReview
{
    /** @description The title for the review */
    // @ApiMember(Description="The title for the review")
    public Title: string;

    /** @description The description for the review */
    // @ApiMember(Description="The description for the review")
    public Description: string;

    /** @description The review author */
    // @ApiMember(Description="The review author")
    public Author: string;

    /** @description The review author */
    // @ApiMember(Description="The review author")
    public ReviewAnswer: string;

    public constructor(init?: Partial<CreateReview>) { (Object as any).assign(this, init); }
}

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
export class AddRating
{
    /** @description  */
    // @ApiMember(Description="", IsRequired=true)
    public CompanyId: string;

    /** @description Id of the booking */
    // @ApiMember(Description="Id of the booking", IsRequired=true)
    public BookingId: number;

    /** @description 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 Identifier: string;

    /** @description The rating score between 1 and 5. */
    // @ApiMember(Description="The rating score between 1 and 5.", IsRequired=true)
    public RatingScore: number;

    /** @description The review for the rating */
    // @ApiMember(Description="The review for the rating")
    public Review: CreateReview;

    public constructor(init?: Partial<AddRating>) { (Object as any).assign(this, init); }
}

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