BokaMera.API.Host

<back to all web services

AddRating

The following routes are available for this service:
POST/rating/Create RatingScoreCreate 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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<AddRating xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <BookingId>0</BookingId>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <Identifier>String</Identifier>
  <RatingScore>0</RatingScore>
  <Review>
    <Author>String</Author>
    <Description>String</Description>
    <ReviewAnswer>String</ReviewAnswer>
    <Title>String</Title>
  </Review>
</AddRating>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CompanyRatingResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <BookingId>0</BookingId>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <CreatedDate>0001-01-01T00:00:00</CreatedDate>
  <RatingScore>0</RatingScore>
  <Review>
    <Author>String</Author>
    <Created>0001-01-01T00:00:00</Created>
    <Description>String</Description>
    <RatingScore>0</RatingScore>
    <ReviewAnswer>String</ReviewAnswer>
    <Title>String</Title>
  </Review>
  <Status>0</Status>
  <UpdatedDate>0001-01-01T00:00:00</UpdatedDate>
</CompanyRatingResponse>