| 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. |
|---|
"use strict";
export class AdminBookingReservationResult {
/** @param {{Id?:number,SessionKey?:string,ServiceId?:number,From?:string,To?:string,NumberOfBookedSpots?:number,ExpirationDatetime?:string,StatusCode?:number,StatusName?:string,CustomerId?:string,CustomerName?:string,CustomerEmail?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {number}
* @description The internal reservation id (target for the release endpoint). */
Id;
/**
* @type {string}
* @description The opaque session key that identifies the reservation. */
SessionKey;
/**
* @type {number}
* @description The reserved service id. */
ServiceId;
/**
* @type {string}
* @description The reservation start. */
From;
/**
* @type {string}
* @description The reservation end. */
To;
/**
* @type {number}
* @description Number of reserved spots. */
NumberOfBookedSpots;
/**
* @type {string}
* @description When the hold expires (company-local time). */
ExpirationDatetime;
/**
* @type {number}
* @description The BookingReservationStatus value. */
StatusCode;
/**
* @type {string}
* @description The BookingReservationStatus name. */
StatusName;
/**
* @type {?string}
* @description The customer id holding the reservation, if any. */
CustomerId;
/**
* @type {string}
* @description The customer's full name, when a customer is attached. */
CustomerName;
/**
* @type {string}
* @description The customer email (falls back to the BookedBy email when no customer is attached). */
CustomerEmail;
}
export class QueryBookingReservationsResponse {
/** @param {{Results?:AdminBookingReservationResult[],ResponseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {AdminBookingReservationResult[]}
* @description The matching reservation holds. */
Results = [];
/** @type {ResponseStatus} */
ResponseStatus;
}
export class QueryBookingReservations {
/** @param {{CompanyId?:string,ServiceId?:number,From?:string,To?:string,StatusCode?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {?string}
* @description The company id, if empty will use the company id for the user you are logged in with. */
CompanyId;
/**
* @type {?number}
* @description Only holds for this service id. */
ServiceId;
/**
* @type {?string}
* @description Only holds whose start (From) is on or after this datetime. */
From;
/**
* @type {?string}
* @description Only holds whose start (From) is on or before this datetime. */
To;
/**
* @type {?number}
* @description Filter by BookingReservationStatus value. When omitted, the spot-holding statuses (Selecting=1, AwaitingPayment=2) are returned. */
StatusCode;
}
JavaScript QueryBookingReservations 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.
GET /admin/bookingreservations HTTP/1.1 Host: testapi.bokamera.se Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Results:
[
{
Id: 0,
ServiceId: 0,
NumberOfBookedSpots: 0,
StatusCode: 0,
StatusName: String,
CustomerId: 00000000-0000-0000-0000-000000000000,
CustomerName: String,
CustomerEmail: String
}
],
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}