| 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 java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
@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)
open class CommitBookingReservation : ICompany
{
/**
* The opaque session key that identifies the reservation.
*/
@ApiMember(Description="The opaque session key that identifies the reservation.", IsRequired=true, ParameterType="path")
open var SessionKey:UUID? = null
/**
* The company id, if empty will use the company id for the user you are logged in with.
*/
@ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
override var CompanyId:UUID? = null
/**
* Rebate codes to apply when computing the final price.
*/
@ApiMember(Description="Rebate codes to apply when computing the final price.")
open var RebateCodeIds:ArrayList<Int> = ArrayList<Int>()
}
open class CommitBookingReservationResponse
{
/**
* The opaque session key that identifies the reservation.
*/
@ApiMember(Description="The opaque session key that identifies the reservation.")
open var SessionKey:UUID? = null
/**
* The BookingReservationStatus value after commit.
*/
@ApiMember(Description="The BookingReservationStatus value after commit.")
open var StatusCode:Int? = null
/**
* The BookingReservationStatus name after commit.
*/
@ApiMember(Description="The BookingReservationStatus name after commit.")
open var StatusName:String? = null
/**
* True when the customer still needs to pay (reservation moved to AwaitingPayment).
*/
@ApiMember(Description="True when the customer still needs to pay (reservation moved to AwaitingPayment).")
open var PaymentRequired:Boolean? = null
/**
* The created booking id, set when the reservation was converted without payment.
*/
@ApiMember(Description="The created booking id, set when the reservation was converted without payment.")
open var BookingId:Int? = null
/**
* The computed final price of the reservation, if any.
*/
@ApiMember(Description="The computed final price of the reservation, if any.")
open var Price:BigDecimal? = null
/**
* The reservation payable reference to use as the checkout InternalReferenceId when PaymentRequired is true.
*/
@ApiMember(Description="The reservation payable reference to use as the checkout InternalReferenceId when PaymentRequired is true.")
open var InternalReferenceId:String? = null
open var ResponseStatus:ResponseStatus? = null
}
Kotlin CommitBookingReservation DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: text/jsv
Content-Type: text/jsv
Content-Length: length
{
CompanyId: 00000000-0000-0000-0000-000000000000,
RebateCodeIds:
[
0
]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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
}
}
}