| 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. |
|---|
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BokaMera.API.ServiceModel.Dtos
Namespace Global
Namespace BokaMera.API.ServiceModel.Dtos
<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)>
Public Partial Class CommitBookingReservation
Implements ICompany
'''<Summary>
'''The opaque session key that identifies the reservation.
'''</Summary>
<ApiMember(Description:="The opaque session key that identifies the reservation.", IsRequired:=true, ParameterType:="path")>
Public Overridable Property SessionKey As Guid
'''<Summary>
'''The company id, if empty will use the company id for the user you are logged in with.
'''</Summary>
<ApiMember(Description:="The company id, if empty will use the company id for the user you are logged in with.")>
Public Overridable Property CompanyId As Guid? Implements ICompany.CompanyId
'''<Summary>
'''Rebate codes to apply when computing the final price.
'''</Summary>
<ApiMember(Description:="Rebate codes to apply when computing the final price.")>
Public Overridable Property RebateCodeIds As List(Of Integer) = New List(Of Integer)
End Class
Public Partial Class CommitBookingReservationResponse
'''<Summary>
'''The opaque session key that identifies the reservation.
'''</Summary>
<ApiMember(Description:="The opaque session key that identifies the reservation.")>
Public Overridable Property SessionKey As Guid
'''<Summary>
'''The BookingReservationStatus value after commit.
'''</Summary>
<ApiMember(Description:="The BookingReservationStatus value after commit.")>
Public Overridable Property StatusCode As Integer
'''<Summary>
'''The BookingReservationStatus name after commit.
'''</Summary>
<ApiMember(Description:="The BookingReservationStatus name after commit.")>
Public Overridable Property StatusName As String
'''<Summary>
'''True when the customer still needs to pay (reservation moved to AwaitingPayment).
'''</Summary>
<ApiMember(Description:="True when the customer still needs to pay (reservation moved to AwaitingPayment).")>
Public Overridable Property PaymentRequired As Boolean
'''<Summary>
'''The created booking id, set when the reservation was converted without payment.
'''</Summary>
<ApiMember(Description:="The created booking id, set when the reservation was converted without payment.")>
Public Overridable Property BookingId As Integer?
'''<Summary>
'''The computed final price of the reservation, if any.
'''</Summary>
<ApiMember(Description:="The computed final price of the reservation, if any.")>
Public Overridable Property Price As Decimal?
'''<Summary>
'''The reservation payable reference to use as the checkout InternalReferenceId when PaymentRequired is true.
'''</Summary>
<ApiMember(Description:="The reservation payable reference to use as the checkout InternalReferenceId when PaymentRequired is true.")>
Public Overridable Property InternalReferenceId As String
Public Overridable Property ResponseStatus As ResponseStatus
End Class
End Namespace
End Namespace
VB.NET CommitBookingReservation 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.
POST /bookingreservations/{SessionKey}/commit HTTP/1.1
Host: testapi.bokamera.se
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<CommitBookingReservation 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>
<RebateCodeIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>0</d2p1:int>
</RebateCodeIds>
<SessionKey>00000000-0000-0000-0000-000000000000</SessionKey>
</CommitBookingReservation>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<CommitBookingReservationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<BookingId>0</BookingId>
<InternalReferenceId>String</InternalReferenceId>
<PaymentRequired>false</PaymentRequired>
<Price>0</Price>
<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>
<SessionKey>00000000-0000-0000-0000-000000000000</SessionKey>
<StatusCode>0</StatusCode>
<StatusName>String</StatusName>
</CommitBookingReservationResponse>