| GET | /bookingreservations/{SessionKey} | Get a booking reservation | Returns the current state of a reservation identified by its opaque session key. |
|---|
import 'package:servicestack/servicestack.dart';
class BookingReservationResponse implements IConvertible
{
/**
* The opaque session key that identifies the reservation.
*/
// @ApiMember(Description="The opaque session key that identifies the reservation.")
String SessionKey = "";
/**
* The company id.
*/
// @ApiMember(Description="The company id.")
String CompanyId = "";
/**
* The reserved service id.
*/
// @ApiMember(Description="The reserved service id.")
int ServiceId = 0;
/**
* The reservation start.
*/
// @ApiMember(Description="The reservation start.")
DateTime From = DateTime(0);
/**
* The reservation end.
*/
// @ApiMember(Description="The reservation end.")
DateTime To = DateTime(0);
/**
* The BookingReservationStatus value.
*/
// @ApiMember(Description="The BookingReservationStatus value.")
int StatusCode = 0;
/**
* The BookingReservationStatus name.
*/
// @ApiMember(Description="The BookingReservationStatus name.")
String StatusName = "";
/**
* When the hold expires (company-local time).
*/
// @ApiMember(Description="When the hold expires (company-local time).")
DateTime ExpirationDatetime = DateTime(0);
/**
* Number of reserved spots.
*/
// @ApiMember(Description="Number of reserved spots.")
int NumberOfBookedSpots = 0;
/**
* The computed price of the reservation, if any.
*/
// @ApiMember(Description="The computed price of the reservation, if any.")
double? Price;
/**
* The currency of the price, if any.
*/
// @ApiMember(Description="The currency of the price, if any.")
String CurrencyId = "";
/**
* Ids of the resources held by the reservation.
*/
// @ApiMember(Description="Ids of the resources held by the reservation.")
List<int> ResourceIds = [];
/**
* The full in-progress selection payload (wizard/session state) as JSON.
*/
// @ApiMember(Description="The full in-progress selection payload (wizard/session state) as JSON.")
String SelectionPayload = "";
ResponseStatus ResponseStatus;
BookingReservationResponse({this.SessionKey,this.CompanyId,this.ServiceId,this.From,this.To,this.StatusCode,this.StatusName,this.ExpirationDatetime,this.NumberOfBookedSpots,this.Price,this.CurrencyId,this.ResourceIds,this.SelectionPayload,this.ResponseStatus});
BookingReservationResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
SessionKey = json['SessionKey'];
CompanyId = json['CompanyId'];
ServiceId = json['ServiceId'];
From = JsonConverters.fromJson(json['From'],'DateTime',context!);
To = JsonConverters.fromJson(json['To'],'DateTime',context!);
StatusCode = json['StatusCode'];
StatusName = json['StatusName'];
ExpirationDatetime = JsonConverters.fromJson(json['ExpirationDatetime'],'DateTime',context!);
NumberOfBookedSpots = json['NumberOfBookedSpots'];
Price = JsonConverters.toDouble(json['Price']);
CurrencyId = json['CurrencyId'];
ResourceIds = JsonConverters.fromJson(json['ResourceIds'],'List<int>',context!);
SelectionPayload = json['SelectionPayload'];
ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
return this;
}
Map<String, dynamic> toJson() => {
'SessionKey': SessionKey,
'CompanyId': CompanyId,
'ServiceId': ServiceId,
'From': JsonConverters.toJson(From,'DateTime',context!),
'To': JsonConverters.toJson(To,'DateTime',context!),
'StatusCode': StatusCode,
'StatusName': StatusName,
'ExpirationDatetime': JsonConverters.toJson(ExpirationDatetime,'DateTime',context!),
'NumberOfBookedSpots': NumberOfBookedSpots,
'Price': Price,
'CurrencyId': CurrencyId,
'ResourceIds': JsonConverters.toJson(ResourceIds,'List<int>',context!),
'SelectionPayload': SelectionPayload,
'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
};
getTypeName() => "BookingReservationResponse";
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)
class GetBookingReservation 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;
GetBookingReservation({this.SessionKey,this.CompanyId});
GetBookingReservation.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
SessionKey = json['SessionKey'];
CompanyId = json['CompanyId'];
return this;
}
Map<String, dynamic> toJson() => {
'SessionKey': SessionKey,
'CompanyId': CompanyId
};
getTypeName() => "GetBookingReservation";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'testapi.bokamera.se', types: <String, TypeInfo> {
'BookingReservationResponse': TypeInfo(TypeOf.Class, create:() => BookingReservationResponse()),
'GetBookingReservation': TypeInfo(TypeOf.Class, create:() => GetBookingReservation()),
});
Dart GetBookingReservation 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.
GET /bookingreservations/{SessionKey} HTTP/1.1
Host: testapi.bokamera.se
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<BookingReservationResponse 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>
<CurrencyId>String</CurrencyId>
<ExpirationDatetime>0001-01-01T00:00:00</ExpirationDatetime>
<From>0001-01-01T00:00:00</From>
<NumberOfBookedSpots>0</NumberOfBookedSpots>
<Price>0</Price>
<ResourceIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>0</d2p1:int>
</ResourceIds>
<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>
<SelectionPayload>String</SelectionPayload>
<ServiceId>0</ServiceId>
<SessionKey>00000000-0000-0000-0000-000000000000</SessionKey>
<StatusCode>0</StatusCode>
<StatusName>String</StatusName>
<To>0001-01-01T00:00:00</To>
</BookingReservationResponse>