| 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 'package:servicestack/servicestack.dart';
class CommitBookingReservationResponse implements IConvertible
{
/**
* The opaque session key that identifies the reservation.
*/
// @ApiMember(Description="The opaque session key that identifies the reservation.")
String SessionKey = "";
/**
* The BookingReservationStatus value after commit.
*/
// @ApiMember(Description="The BookingReservationStatus value after commit.")
int StatusCode = 0;
/**
* The BookingReservationStatus name after commit.
*/
// @ApiMember(Description="The BookingReservationStatus name after commit.")
String StatusName = "";
/**
* 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).")
bool PaymentRequired;
/**
* 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.")
int? BookingId;
/**
* The computed final price of the reservation, if any.
*/
// @ApiMember(Description="The computed final price of the reservation, if any.")
double? Price;
/**
* 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.")
String InternalReferenceId = "";
ResponseStatus ResponseStatus;
CommitBookingReservationResponse({this.SessionKey,this.StatusCode,this.StatusName,this.PaymentRequired,this.BookingId,this.Price,this.InternalReferenceId,this.ResponseStatus});
CommitBookingReservationResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
SessionKey = json['SessionKey'];
StatusCode = json['StatusCode'];
StatusName = json['StatusName'];
PaymentRequired = json['PaymentRequired'];
BookingId = json['BookingId'];
Price = JsonConverters.toDouble(json['Price']);
InternalReferenceId = json['InternalReferenceId'];
ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
return this;
}
Map<String, dynamic> toJson() => {
'SessionKey': SessionKey,
'StatusCode': StatusCode,
'StatusName': StatusName,
'PaymentRequired': PaymentRequired,
'BookingId': BookingId,
'Price': Price,
'InternalReferenceId': InternalReferenceId,
'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
};
getTypeName() => "CommitBookingReservationResponse";
TypeContext? context = _ctx;
}
// @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)
class CommitBookingReservation implements ICompany, IConvertible
{
/**
* The opaque session key that identifies the reservation.
*/
// @ApiMember(Description="The opaque session key that identifies the reservation.", IsRequired=true, ParameterType="path")
String SessionKey = "";
/**
* 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.")
String? CompanyId;
/**
* Rebate codes to apply when computing the final price.
*/
// @ApiMember(Description="Rebate codes to apply when computing the final price.")
List<int> RebateCodeIds = [];
CommitBookingReservation({this.SessionKey,this.CompanyId,this.RebateCodeIds});
CommitBookingReservation.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
SessionKey = json['SessionKey'];
CompanyId = json['CompanyId'];
RebateCodeIds = JsonConverters.fromJson(json['RebateCodeIds'],'List<int>',context!);
return this;
}
Map<String, dynamic> toJson() => {
'SessionKey': SessionKey,
'CompanyId': CompanyId,
'RebateCodeIds': JsonConverters.toJson(RebateCodeIds,'List<int>',context!)
};
getTypeName() => "CommitBookingReservation";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'testapi.bokamera.se', types: <String, TypeInfo> {
'CommitBookingReservationResponse': TypeInfo(TypeOf.Class, create:() => CommitBookingReservationResponse()),
'CommitBookingReservation': TypeInfo(TypeOf.Class, create:() => CommitBookingReservation()),
});
Dart 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>