BokaMera.API.Host

<back to all web services

RatingQuery

The following routes are available for this service:
GET/rating/Get RatingsGet Ratings.
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 QueryBase:
    skip: Optional[int] = None
    """
    Skip over a given number of elements in a sequence and then return the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?skip=10&orderBy=Id</code>
    """

    take: Optional[int] = None
    """
    Return a given number of elements in a sequence and then skip over the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?take=20</code>
    """

    order_by: Optional[str] = None
    """
    Comma separated list of fields to order by. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderBy=Id,-Age,FirstName</code>
    """

    order_by_desc: Optional[str] = None
    """
    Comma separated list of fields to order by in descending order. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderByDesc=Id,-Age,FirstName</code>
    """

    include: Optional[str] = None
    """
    Include any of the aggregates <code>AVG, COUNT, FIRST, LAST, MAX, MIN, SUM</code> in your result set. The results will be returned in the meta field.<br/><br/><strong>Example:</strong><br/><code>?include=COUNT(*) as Total</code><br/><br/>or multiple fields with<br/><code>?include=Count(*) Total, Min(Age), AVG(Age) AverageAge</code><br/></br>or unique with<br/><code>?include=COUNT(DISTINCT LivingStatus) as UniqueStatus</code>
    """

    fields: Optional[str] = None
    meta: Optional[Dict[str, str]] = None


From = TypeVar('From')
Into = TypeVar('Into')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryDb2(Generic[From, Into], QueryBase, IReturn[QueryResponse[Into]]):
    @staticmethod
    def response_type(): return QueryResponse[Into]


@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 BaseModel:
    pass


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Review(BaseModel):
    review_id: Optional[str] = None
    # @Required()
    company_id: Optional[str] = None

    # @Required()
    title: Optional[str] = None

    # @Required()
    description: Optional[str] = None

    # @Required()
    author: Optional[str] = None

    # @Required()
    status: int = 0

    # @Required()
    created: datetime.datetime = datetime.datetime(1, 1, 1)

    # @Required()
    updated: datetime.datetime = datetime.datetime(1, 1, 1)

    modified_date: Optional[datetime.datetime] = None
    review_answer: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Rating(BaseModel):
    review_id: Optional[str] = None
    review: Optional[Review] = None
    # @Required()
    company_id: Optional[str] = None

    # @Required()
    booking_id: int = 0

    # @Required()
    rating_score: int = 0

    # @Required()
    status: int = 0

    # @Required()
    created: datetime.datetime = datetime.datetime(1, 1, 1)

    # @Required()
    updated: datetime.datetime = datetime.datetime(1, 1, 1)

    modified_date: Optional[datetime.datetime] = None


# @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RatingQuery(QueryDb2[Rating, CompanyRatingResponse], ICompany):
    # @ApiMember(Description="")
    company_id: Optional[str] = None
    """
    
    """

    # @ApiMember(Description="Id of the booking")
    booking_id: Optional[int] = None
    """
    Id of the booking
    """


    # @ApiMember(Description="If you want to collect only active ratings. Ratings are only active after one has past since creation date.")
    active: Optional[bool] = None
    """
    If you want to collect only active ratings. Ratings are only active after one has past since creation date.
    """


    # @ApiMember(DataType="boolean", Description="If you want to include the rating reviews", ParameterType="query")
    include_rating_reviews: bool = False
    """
    If you want to include the rating reviews
    """


    # @ApiMember(DataType="dateTime", Description="Start of interval to query for bookings when they where created. UTC+0 and parameter as defined by date-time - RFC3339", ParameterType="query")
    created_from: Optional[datetime.datetime] = None
    """
    Start of interval to query for bookings when they where created. UTC+0 and parameter as defined by date-time - RFC3339
    """


    # @ApiMember(DataType="dateTime", Description="End of interval to query for bookings when they where created. UTC+0 and parameter as defined by date-time - RFC3339", ParameterType="query")
    created_to: Optional[datetime.datetime] = None
    """
    End of interval to query for bookings when they where created. UTC+0 and parameter as defined by date-time - RFC3339
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AccessKeyTypeResponse:
    id: int = 0
    key_type: Optional[str] = None
    description: Optional[str] = None


AccessKeyTypeResponse = TypeVar('AccessKeyTypeResponse')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryResponse(Generic[AccessKeyTypeResponse]):
    offset: int = 0
    total: int = 0
    results: Optional[List[AccessKeyTypeResponse]] = None
    meta: Optional[Dict[str, str]] = None
    response_status: Optional[ResponseStatus] = None

Python RatingQuery 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.

GET /rating/ HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Offset":0,"Total":0,"Results":[{"BookingId":0,"Status":0,"RatingScore":0,"Review":{"Title":"String","Description":"String","RatingScore":0,"Author":"String","ReviewAnswer":"String"}}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}