| GET | /bookingreservations/current | Get the caller's current booking reservation hold (from cookie) | Resolves the caller's active reservation hold from the bm_hold cookie so a reopened browser or a second tab can resume the same hold instead of creating a second one. Returns the full selection (including the entered personal details) when the cookie proves this browser owns the hold. 404 when there is no active hold, in which case the stale cookie is cleared. |
|---|
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
Object = TypeVar('Object')
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BookingReservationResponse:
# @ApiMember(Description="The opaque session key that identifies the reservation.")
session_key: Optional[str] = None
"""
The opaque session key that identifies the reservation.
"""
# @ApiMember(Description="The company id.")
company_id: Optional[str] = None
"""
The company id.
"""
# @ApiMember(Description="The reserved service id.")
service_id: int = 0
"""
The reserved service id.
"""
# @ApiMember(Description="The reservation start.")
from_: datetime.datetime = field(metadata=config(field_name='from'), default=datetime.datetime(1, 1, 1))
"""
The reservation start.
"""
# @ApiMember(Description="The reservation end.")
to: datetime.datetime = datetime.datetime(1, 1, 1)
"""
The reservation end.
"""
# @ApiMember(Description="The BookingReservationStatus value.")
status_code: int = 0
"""
The BookingReservationStatus value.
"""
# @ApiMember(Description="The BookingReservationStatus name.")
status_name: Optional[str] = None
"""
The BookingReservationStatus name.
"""
# @ApiMember(Description="When the hold expires (company-local time).")
expiration_datetime: datetime.datetime = datetime.datetime(1, 1, 1)
"""
When the hold expires (company-local time).
"""
# @ApiMember(Description="The company's current time, in the same company-local frame as ExpirationDatetime. Clients compute the remaining hold as (ExpirationDatetime - ServerTime) so a countdown is correct regardless of the viewer's timezone or clock skew.")
server_time: datetime.datetime = datetime.datetime(1, 1, 1)
"""
The company's current time, in the same company-local frame as ExpirationDatetime. Clients compute the remaining hold as (ExpirationDatetime - ServerTime) so a countdown is correct regardless of the viewer's timezone or clock skew.
"""
# @ApiMember(Description="Number of reserved spots.")
number_of_booked_spots: int = 0
"""
Number of reserved spots.
"""
# @ApiMember(Description="The computed price of the reservation, if any.")
price: Optional[Decimal] = None
"""
The computed price of the reservation, if any.
"""
# @ApiMember(Description="The currency of the price, if any.")
currency_id: Optional[str] = None
"""
The currency of the price, if any.
"""
# @ApiMember(Description="Ids of the resources held by the reservation.")
resource_ids: List[int] = field(default_factory=list)
"""
Ids of the resources held by the reservation.
"""
# @ApiMember(Description="The full in-progress selection payload (wizard/session state) as JSON.")
selection_payload: Optional[str] = None
"""
The full in-progress selection payload (wizard/session state) as JSON.
"""
response_status: Optional[ResponseStatus] = None
# @ApiResponse(Description="No active reservation hold for the caller", StatusCode=404)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetCurrentBookingReservation(ICompany):
# @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
company_id: Optional[str] = None
"""
The company id, if empty will use the company id for the user you are logged in with.
"""
Python GetCurrentBookingReservation DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /bookingreservations/current HTTP/1.1 Host: testapi.bokamera.se Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"ServiceId":0,"StatusCode":0,"StatusName":"String","NumberOfBookedSpots":0,"Price":0,"CurrencyId":"String","ResourceIds":[0],"SelectionPayload":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}