| 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 java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
@ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ApiResponse(Description="You are not an administrator for the requested company", StatusCode=403)
open class QueryBookingReservations : ICompany
{
/**
* 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.")
override var CompanyId:UUID? = null
/**
* Only holds for this service id.
*/
@ApiMember(Description="Only holds for this service id.")
open var ServiceId:Int? = null
/**
* Only holds whose start (From) is on or after this datetime.
*/
@ApiMember(Description="Only holds whose start (From) is on or after this datetime.")
open var From:Date? = null
/**
* Only holds whose start (From) is on or before this datetime.
*/
@ApiMember(Description="Only holds whose start (From) is on or before this datetime.")
open var To:Date? = null
/**
* 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.")
open var StatusCode:Int? = null
}
open class QueryBookingReservationsResponse
{
/**
* The matching reservation holds.
*/
@ApiMember(Description="The matching reservation holds.")
open var Results:ArrayList<AdminBookingReservationResult> = ArrayList<AdminBookingReservationResult>()
open var ResponseStatus:ResponseStatus? = null
}
open class AdminBookingReservationResult
{
/**
* The internal reservation id (target for the release endpoint).
*/
@ApiMember(Description="The internal reservation id (target for the release endpoint).")
open var Id:Int? = null
/**
* The opaque session key that identifies the reservation.
*/
@ApiMember(Description="The opaque session key that identifies the reservation.")
open var SessionKey:UUID? = null
/**
* The reserved service id.
*/
@ApiMember(Description="The reserved service id.")
open var ServiceId:Int? = null
/**
* The reservation start.
*/
@ApiMember(Description="The reservation start.")
open var From:Date? = null
/**
* The reservation end.
*/
@ApiMember(Description="The reservation end.")
open var To:Date? = null
/**
* Number of reserved spots.
*/
@ApiMember(Description="Number of reserved spots.")
open var NumberOfBookedSpots:Int? = null
/**
* When the hold expires (company-local time).
*/
@ApiMember(Description="When the hold expires (company-local time).")
open var ExpirationDatetime:Date? = null
/**
* The BookingReservationStatus value.
*/
@ApiMember(Description="The BookingReservationStatus value.")
open var StatusCode:Int? = null
/**
* The BookingReservationStatus name.
*/
@ApiMember(Description="The BookingReservationStatus name.")
open var StatusName:String? = null
/**
* The customer id holding the reservation, if any.
*/
@ApiMember(Description="The customer id holding the reservation, if any.")
open var CustomerId:UUID? = null
/**
* The customer's full name, when a customer is attached.
*/
@ApiMember(Description="The customer's full name, when a customer is attached.")
open var CustomerName:String? = null
/**
* 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).")
open var CustomerEmail:String? = null
}
Kotlin 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
}
}
}