| 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.*;
public class 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 static class CommitBookingReservation implements ICompany
{
/**
* The opaque session key that identifies the reservation.
*/
@ApiMember(Description="The opaque session key that identifies the reservation.", IsRequired=true, ParameterType="path")
public UUID SessionKey = 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.")
public UUID CompanyId = null;
/**
* Rebate codes to apply when computing the final price.
*/
@ApiMember(Description="Rebate codes to apply when computing the final price.")
public ArrayList<Integer> RebateCodeIds = new ArrayList<Integer>();
public UUID getSessionKey() { return SessionKey; }
public CommitBookingReservation setSessionKey(UUID value) { this.SessionKey = value; return this; }
public UUID getCompanyId() { return CompanyId; }
public CommitBookingReservation setCompanyId(UUID value) { this.CompanyId = value; return this; }
public ArrayList<Integer> getRebateCodeIds() { return RebateCodeIds; }
public CommitBookingReservation setRebateCodeIds(ArrayList<Integer> value) { this.RebateCodeIds = value; return this; }
}
public static class CommitBookingReservationResponse
{
/**
* The opaque session key that identifies the reservation.
*/
@ApiMember(Description="The opaque session key that identifies the reservation.")
public UUID SessionKey = null;
/**
* The BookingReservationStatus value after commit.
*/
@ApiMember(Description="The BookingReservationStatus value after commit.")
public Integer StatusCode = null;
/**
* The BookingReservationStatus name after commit.
*/
@ApiMember(Description="The BookingReservationStatus name after commit.")
public String StatusName = 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).")
public Boolean PaymentRequired = 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.")
public Integer BookingId = null;
/**
* The computed final price of the reservation, if any.
*/
@ApiMember(Description="The computed final price of the reservation, if any.")
public BigDecimal Price = 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.")
public String InternalReferenceId = null;
public ResponseStatus ResponseStatus = null;
public UUID getSessionKey() { return SessionKey; }
public CommitBookingReservationResponse setSessionKey(UUID value) { this.SessionKey = value; return this; }
public Integer getStatusCode() { return StatusCode; }
public CommitBookingReservationResponse setStatusCode(Integer value) { this.StatusCode = value; return this; }
public String getStatusName() { return StatusName; }
public CommitBookingReservationResponse setStatusName(String value) { this.StatusName = value; return this; }
public Boolean isPaymentRequired() { return PaymentRequired; }
public CommitBookingReservationResponse setPaymentRequired(Boolean value) { this.PaymentRequired = value; return this; }
public Integer getBookingId() { return BookingId; }
public CommitBookingReservationResponse setBookingId(Integer value) { this.BookingId = value; return this; }
public BigDecimal getPrice() { return Price; }
public CommitBookingReservationResponse setPrice(BigDecimal value) { this.Price = value; return this; }
public String getInternalReferenceId() { return InternalReferenceId; }
public CommitBookingReservationResponse setInternalReferenceId(String value) { this.InternalReferenceId = value; return this; }
public ResponseStatus getResponseStatus() { return ResponseStatus; }
public CommitBookingReservationResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
}
}
Java 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>