| POST | /bookingreservations/{SessionKey}/commit | Commit a booking reservation | Commits a reservation. If the service has no payment or the final price is zero the reservation is converted to a real booking synchronously and PaymentRequired is false. Otherwise the reservation is moved to AwaitingPayment and PaymentRequired is true. |
|---|
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 CommitBookingReservationResponse:
# @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 BookingReservationStatus value after commit.")
status_code: int = 0
"""
The BookingReservationStatus value after commit.
"""
# @ApiMember(Description="The BookingReservationStatus name after commit.")
status_name: Optional[str] = None
"""
The BookingReservationStatus name after commit.
"""
# @ApiMember(Description="True when the customer still needs to pay (reservation moved to AwaitingPayment).")
payment_required: bool = False
"""
True when the customer still needs to pay (reservation moved to AwaitingPayment).
"""
# @ApiMember(Description="The created booking id, set when the reservation was converted without payment.")
booking_id: Optional[int] = None
"""
The created booking id, set when the reservation was converted without payment.
"""
# @ApiMember(Description="The computed final price of the reservation, if any.")
price: Optional[Decimal] = None
"""
The computed final price of the reservation, if any.
"""
# @ApiMember(Description="The reservation payable reference to use as the checkout InternalReferenceId when PaymentRequired is true.")
internal_reference_id: Optional[str] = None
"""
The reservation payable reference to use as the checkout InternalReferenceId when PaymentRequired is true.
"""
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)
# @ApiResponse(Description="The selected slot is no longer available", StatusCode=409)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CommitBookingReservation(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.
"""
# @ApiMember(Description="Rebate codes to apply when computing the final price.")
rebate_code_ids: List[int] = field(default_factory=list)
"""
Rebate codes to apply when computing the final price.
"""
Python CommitBookingReservation 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.
POST /bookingreservations/{SessionKey}/commit HTTP/1.1
Host: testapi.bokamera.se
Accept: application/json
Content-Type: application/json
Content-Length: length
{"CompanyId":"00000000-0000-0000-0000-000000000000","RebateCodeIds":[0]}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"StatusCode":0,"StatusName":"String","PaymentRequired":false,"BookingId":0,"Price":0,"InternalReferenceId":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}