| Requires any of the roles: | bookingsupplier-administrator-write, bookingsupplier-administrator-read, superadmin |
| GET | /admin/bookingreservations | List booking-reservation holds (admin) | Lists the active reservation holds for a company. By default only the spot-holding statuses (Selecting, AwaitingPayment) — the ones actually reducing availability — are returned; pass StatusCode to filter to a specific status. Optionally filter by ServiceId and a From/To window on the hold start. |
|---|
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 AdminBookingReservationResult:
# @ApiMember(Description="The internal reservation id (target for the release endpoint).")
id: int = 0
"""
The internal reservation id (target for the release endpoint).
"""
# @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 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="Number of reserved spots.")
number_of_booked_spots: int = 0
"""
Number of reserved spots.
"""
# @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 BookingReservationStatus value.")
status_code: int = 0
"""
The BookingReservationStatus value.
"""
# @ApiMember(Description="The BookingReservationStatus name.")
status_name: Optional[str] = None
"""
The BookingReservationStatus name.
"""
# @ApiMember(Description="The customer id holding the reservation, if any.")
customer_id: Optional[str] = None
"""
The customer id holding the reservation, if any.
"""
# @ApiMember(Description="The customer's full name, when a customer is attached.")
customer_name: Optional[str] = None
"""
The customer's full name, when a customer is attached.
"""
# @ApiMember(Description="The customer email (falls back to the BookedBy email when no customer is attached).")
customer_email: Optional[str] = None
"""
The customer email (falls back to the BookedBy email when no customer is attached).
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryBookingReservationsResponse:
# @ApiMember(Description="The matching reservation holds.")
results: List[AdminBookingReservationResult] = field(default_factory=list)
"""
The matching reservation holds.
"""
response_status: Optional[ResponseStatus] = None
# @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
# @ApiResponse(Description="You are not an administrator for the requested company", StatusCode=403)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryBookingReservations(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.
"""
# @ApiMember(Description="Only holds for this service id.")
service_id: Optional[int] = None
"""
Only holds for this service id.
"""
# @ApiMember(Description="Only holds whose start (From) is on or after this datetime.")
from_: Optional[datetime.datetime] = field(metadata=config(field_name='from'), default=None)
"""
Only holds whose start (From) is on or after this datetime.
"""
# @ApiMember(Description="Only holds whose start (From) is on or before this datetime.")
to: Optional[datetime.datetime] = None
"""
Only holds whose start (From) is on or before this datetime.
"""
# @ApiMember(Description="Filter by BookingReservationStatus value. When omitted, the spot-holding statuses (Selecting=1, AwaitingPayment=2) are returned.")
status_code: Optional[int] = None
"""
Filter by BookingReservationStatus value. When omitted, the spot-holding statuses (Selecting=1, AwaitingPayment=2) are returned.
"""
Python QueryBookingReservations DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /admin/bookingreservations HTTP/1.1 Host: testapi.bokamera.se Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"Results":[{"Id":0,"ServiceId":0,"NumberOfBookedSpots":0,"StatusCode":0,"StatusName":"String","CustomerId":"00000000-0000-0000-0000-000000000000","CustomerName":"String","CustomerEmail":"String"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}