| GET | /bookingreservations/{SessionKey} | Get a booking reservation | Returns the current state of a reservation identified by its opaque session key. |
|---|
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="You were unauthorized to call this service", StatusCode=401)
# @ApiResponse(Description="No reservation found for the given session key", StatusCode=404)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetBookingReservation(ICompany):
# @ApiMember(Description="The opaque session key that identifies the reservation.", IsRequired=true, ParameterType="path")
session_key: Optional[str] = None
"""
The opaque session key that identifies the reservation.
"""
# @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 GetBookingReservation DTOs
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.
GET /bookingreservations/{SessionKey} HTTP/1.1
Host: testapi.bokamera.se
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<BookingReservationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<CurrencyId>String</CurrencyId>
<ExpirationDatetime>0001-01-01T00:00:00</ExpirationDatetime>
<From>0001-01-01T00:00:00</From>
<NumberOfBookedSpots>0</NumberOfBookedSpots>
<Price>0</Price>
<ResourceIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>0</d2p1:int>
</ResourceIds>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
<SelectionPayload>String</SelectionPayload>
<ServerTime>0001-01-01T00:00:00</ServerTime>
<ServiceId>0</ServiceId>
<SessionKey>00000000-0000-0000-0000-000000000000</SessionKey>
<StatusCode>0</StatusCode>
<StatusName>String</StatusName>
<To>0001-01-01T00:00:00</To>
</BookingReservationResponse>