| POST | /rating/ | Create RatingScore | Create rating from booking |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RatingReviewResponse:
# @ApiMember(Description="The title for the review")
title: Optional[str] = None
"""
The title for the review
"""
# @ApiMember(Description="The description for the review")
description: Optional[str] = None
"""
The description for the review
"""
# @ApiMember(Description="The rating score")
rating_score: int = 0
"""
The rating score
"""
# @ApiMember(Description="The review author")
author: Optional[str] = None
"""
The review author
"""
# @ApiMember(Description="The created date")
created: datetime.datetime = datetime.datetime(1, 1, 1)
"""
The created date
"""
# @ApiMember(Description="The review answer from the company")
review_answer: Optional[str] = None
"""
The review answer from the company
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CompanyRatingResponse:
# @ApiMember(Description="")
company_id: Optional[str] = None
"""
"""
# @ApiMember(Description="Id of the booking")
booking_id: int = 0
"""
Id of the booking
"""
# @ApiMember(Description="The status of the rating, 1 = Active")
status: int = 0
"""
The status of the rating, 1 = Active
"""
# @ApiMember(Description="The rating score")
rating_score: int = 0
"""
The rating score
"""
# @ApiMember(Description="The review if any exists to the rating")
review: Optional[RatingReviewResponse] = None
"""
The review if any exists to the rating
"""
created_date: datetime.datetime = datetime.datetime(1, 1, 1)
updated_date: datetime.datetime = datetime.datetime(1, 1, 1)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreateReview:
# @ApiMember(Description="The title for the review")
title: Optional[str] = None
"""
The title for the review
"""
# @ApiMember(Description="The description for the review")
description: Optional[str] = None
"""
The description for the review
"""
# @ApiMember(Description="The review author")
author: Optional[str] = None
"""
The review author
"""
# @ApiMember(Description="The review author")
review_answer: Optional[str] = None
"""
The review author
"""
# @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AddRating:
# @ApiMember(Description="", IsRequired=true)
company_id: Optional[str] = None
"""
"""
# @ApiMember(Description="Id of the booking", IsRequired=true)
booking_id: int = 0
"""
Id of the booking
"""
# @ApiMember(Description="The identifier for the booking, use to verify the booking.", IsRequired=true)
identifier: Optional[str] = None
"""
The identifier for the booking, use to verify the booking.
"""
# @ApiMember(Description="The rating score between 1 and 5.", IsRequired=true)
rating_score: int = 0
"""
The rating score between 1 and 5.
"""
# @ApiMember(Description="The review for the rating")
review: Optional[CreateReview] = None
"""
The review for the rating
"""
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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: testapi.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>