BokaMera.API.Host

UpdateRating

The following routes are available for this service:
PUT	/rating/	Update RatingScore	Update rating from booking

"use strict";
export class RatingReviewResponse {
    /** @param {{Title?:string,Description?:string,RatingScore?:number,Author?:string,Created?:string,ReviewAnswer?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The title for the review */
    Title;
    /**
     * @type {string}
     * @description The description for the review */
    Description;
    /**
     * @type {number}
     * @description The rating score */
    RatingScore;
    /**
     * @type {string}
     * @description The review author */
    Author;
    /**
     * @type {string}
     * @description The created date */
    Created;
    /**
     * @type {string}
     * @description The review answer from the company */
    ReviewAnswer;
}
export class CompanyRatingResponse {
    /** @param {{CompanyId?:string,BookingId?:number,Status?:number,RatingScore?:number,Review?:RatingReviewResponse,CreatedDate?:string,UpdatedDate?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    CompanyId;
    /**
     * @type {number}
     * @description Id of the booking */
    BookingId;
    /**
     * @type {number}
     * @description The status of the rating, 1 = Active */
    Status;
    /**
     * @type {number}
     * @description The rating score */
    RatingScore;
    /**
     * @type {RatingReviewResponse}
     * @description The review if any exists to the rating */
    Review;
    /** @type {string} */
    CreatedDate;
    /** @type {string} */
    UpdatedDate;
}
export class UpdateReview {
    /** @param {{Title?:string,Description?:string,Author?:string,ReviewAnswer?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The title for the review */
    Title;
    /**
     * @type {string}
     * @description The description for the review */
    Description;
    /**
     * @type {string}
     * @description The review author */
    Author;
    /**
     * @type {string}
     * @description The review answer from the company. Only the company can respond to this */
    ReviewAnswer;
}
export class UpdateRating {
    /** @param {{CompanyId?:string,BookingId?:number,Identifier?:string,RatingScore?:number,Review?:UpdateReview}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    CompanyId;
    /**
     * @type {number}
     * @description Id of the booking */
    BookingId;
    /**
     * @type {string}
     * @description The identifier for the booking, use to verify the booking. Only needed when a customer, not admin */
    Identifier;
    /**
     * @type {?number}
     * @description The rating score between 1 and 5. */
    RatingScore;
    /**
     * @type {UpdateReview}
     * @description The review for the rating */
    Review;
}

JavaScript 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"}}