| Requires any of the roles: | bookingsupplier-administrator-write, bookingsupplier-administrator-read, superadmin |
| GET | /admin/bookingreservations | List booking-reservation holds (admin) | Lists the active reservation holds for a company. By default only the spot-holding statuses (Selecting, AwaitingPayment) — the ones actually reducing availability — are returned; pass StatusCode to filter to a specific status. Optionally filter by ServiceId and a From/To window on the hold start. |
|---|
import 'package:servicestack/servicestack.dart';
class AdminBookingReservationResult implements IConvertible
{
/**
* The internal reservation id (target for the release endpoint).
*/
// @ApiMember(Description="The internal reservation id (target for the release endpoint).")
int Id = 0;
/**
* The opaque session key that identifies the reservation.
*/
// @ApiMember(Description="The opaque session key that identifies the reservation.")
String SessionKey = "";
/**
* 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);
/**
* Number of reserved spots.
*/
// @ApiMember(Description="Number of reserved spots.")
int NumberOfBookedSpots = 0;
/**
* When the hold expires (company-local time).
*/
// @ApiMember(Description="When the hold expires (company-local time).")
DateTime ExpirationDatetime = DateTime(0);
/**
* The BookingReservationStatus value.
*/
// @ApiMember(Description="The BookingReservationStatus value.")
int StatusCode = 0;
/**
* The BookingReservationStatus name.
*/
// @ApiMember(Description="The BookingReservationStatus name.")
String StatusName = "";
/**
* The customer id holding the reservation, if any.
*/
// @ApiMember(Description="The customer id holding the reservation, if any.")
String? CustomerId;
/**
* The customer's full name, when a customer is attached.
*/
// @ApiMember(Description="The customer's full name, when a customer is attached.")
String CustomerName = "";
/**
* The customer email (falls back to the BookedBy email when no customer is attached).
*/
// @ApiMember(Description="The customer email (falls back to the BookedBy email when no customer is attached).")
String CustomerEmail = "";
AdminBookingReservationResult({this.Id,this.SessionKey,this.ServiceId,this.From,this.To,this.NumberOfBookedSpots,this.ExpirationDatetime,this.StatusCode,this.StatusName,this.CustomerId,this.CustomerName,this.CustomerEmail});
AdminBookingReservationResult.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Id = json['Id'];
SessionKey = json['SessionKey'];
ServiceId = json['ServiceId'];
From = JsonConverters.fromJson(json['From'],'DateTime',context!);
To = JsonConverters.fromJson(json['To'],'DateTime',context!);
NumberOfBookedSpots = json['NumberOfBookedSpots'];
ExpirationDatetime = JsonConverters.fromJson(json['ExpirationDatetime'],'DateTime',context!);
StatusCode = json['StatusCode'];
StatusName = json['StatusName'];
CustomerId = json['CustomerId'];
CustomerName = json['CustomerName'];
CustomerEmail = json['CustomerEmail'];
return this;
}
Map<String, dynamic> toJson() => {
'Id': Id,
'SessionKey': SessionKey,
'ServiceId': ServiceId,
'From': JsonConverters.toJson(From,'DateTime',context!),
'To': JsonConverters.toJson(To,'DateTime',context!),
'NumberOfBookedSpots': NumberOfBookedSpots,
'ExpirationDatetime': JsonConverters.toJson(ExpirationDatetime,'DateTime',context!),
'StatusCode': StatusCode,
'StatusName': StatusName,
'CustomerId': CustomerId,
'CustomerName': CustomerName,
'CustomerEmail': CustomerEmail
};
getTypeName() => "AdminBookingReservationResult";
TypeContext? context = _ctx;
}
class QueryBookingReservationsResponse implements IConvertible
{
/**
* The matching reservation holds.
*/
// @ApiMember(Description="The matching reservation holds.")
List<AdminBookingReservationResult> Results = [];
ResponseStatus ResponseStatus;
QueryBookingReservationsResponse({this.Results,this.ResponseStatus});
QueryBookingReservationsResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Results = JsonConverters.fromJson(json['Results'],'List<AdminBookingReservationResult>',context!);
ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
return this;
}
Map<String, dynamic> toJson() => {
'Results': JsonConverters.toJson(Results,'List<AdminBookingReservationResult>',context!),
'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
};
getTypeName() => "QueryBookingReservationsResponse";
TypeContext? context = _ctx;
}
// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ApiResponse(Description="You are not an administrator for the requested company", StatusCode=403)
class QueryBookingReservations implements ICompany, IConvertible
{
/**
* 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;
/**
* Only holds for this service id.
*/
// @ApiMember(Description="Only holds for this service id.")
int? ServiceId;
/**
* Only holds whose start (From) is on or after this datetime.
*/
// @ApiMember(Description="Only holds whose start (From) is on or after this datetime.")
DateTime? From;
/**
* Only holds whose start (From) is on or before this datetime.
*/
// @ApiMember(Description="Only holds whose start (From) is on or before this datetime.")
DateTime? To;
/**
* Filter by BookingReservationStatus value. When omitted, the spot-holding statuses (Selecting=1, AwaitingPayment=2) are returned.
*/
// @ApiMember(Description="Filter by BookingReservationStatus value. When omitted, the spot-holding statuses (Selecting=1, AwaitingPayment=2) are returned.")
int? StatusCode;
QueryBookingReservations({this.CompanyId,this.ServiceId,this.From,this.To,this.StatusCode});
QueryBookingReservations.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
CompanyId = json['CompanyId'];
ServiceId = json['ServiceId'];
From = JsonConverters.fromJson(json['From'],'DateTime',context!);
To = JsonConverters.fromJson(json['To'],'DateTime',context!);
StatusCode = json['StatusCode'];
return this;
}
Map<String, dynamic> toJson() => {
'CompanyId': CompanyId,
'ServiceId': ServiceId,
'From': JsonConverters.toJson(From,'DateTime',context!),
'To': JsonConverters.toJson(To,'DateTime',context!),
'StatusCode': StatusCode
};
getTypeName() => "QueryBookingReservations";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'testapi.bokamera.se', types: <String, TypeInfo> {
'AdminBookingReservationResult': TypeInfo(TypeOf.Class, create:() => AdminBookingReservationResult()),
'QueryBookingReservationsResponse': TypeInfo(TypeOf.Class, create:() => QueryBookingReservationsResponse()),
'List<AdminBookingReservationResult>': TypeInfo(TypeOf.Class, create:() => <AdminBookingReservationResult>[]),
'QueryBookingReservations': TypeInfo(TypeOf.Class, create:() => QueryBookingReservations()),
});
Dart QueryBookingReservations 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 /admin/bookingreservations HTTP/1.1 Host: testapi.bokamera.se Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<QueryBookingReservationsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<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>
<Results>
<AdminBookingReservationResult>
<CustomerEmail>String</CustomerEmail>
<CustomerId>00000000-0000-0000-0000-000000000000</CustomerId>
<CustomerName>String</CustomerName>
<ExpirationDatetime>0001-01-01T00:00:00</ExpirationDatetime>
<From>0001-01-01T00:00:00</From>
<Id>0</Id>
<NumberOfBookedSpots>0</NumberOfBookedSpots>
<ServiceId>0</ServiceId>
<SessionKey>00000000-0000-0000-0000-000000000000</SessionKey>
<StatusCode>0</StatusCode>
<StatusName>String</StatusName>
<To>0001-01-01T00:00:00</To>
</AdminBookingReservationResult>
</Results>
</QueryBookingReservationsResponse>