| 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 Foundation
import ServiceStack
// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ApiResponse(Description="You are not an administrator for the requested company", StatusCode=403)
public class QueryBookingReservations : ICompany, Codable
{
/**
* 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.")
public var companyId:String?
/**
* Only holds for this service id.
*/
// @ApiMember(Description="Only holds for this service id.")
public var serviceId:Int?
/**
* Only holds whose start (From) is on or after this datetime.
*/
// @ApiMember(Description="Only holds whose start (From) is on or after this datetime.")
public var from:Date?
/**
* Only holds whose start (From) is on or before this datetime.
*/
// @ApiMember(Description="Only holds whose start (From) is on or before this datetime.")
public var to:Date?
/**
* 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.")
public var statusCode:Int?
required public init(){}
}
public class QueryBookingReservationsResponse : Codable
{
/**
* The matching reservation holds.
*/
// @ApiMember(Description="The matching reservation holds.")
public var results:[AdminBookingReservationResult] = []
public var responseStatus:ResponseStatus
required public init(){}
}
public class AdminBookingReservationResult : Codable
{
/**
* The internal reservation id (target for the release endpoint).
*/
// @ApiMember(Description="The internal reservation id (target for the release endpoint).")
public var id:Int
/**
* The opaque session key that identifies the reservation.
*/
// @ApiMember(Description="The opaque session key that identifies the reservation.")
public var sessionKey:String
/**
* The reserved service id.
*/
// @ApiMember(Description="The reserved service id.")
public var serviceId:Int
/**
* The reservation start.
*/
// @ApiMember(Description="The reservation start.")
public var from:Date
/**
* The reservation end.
*/
// @ApiMember(Description="The reservation end.")
public var to:Date
/**
* Number of reserved spots.
*/
// @ApiMember(Description="Number of reserved spots.")
public var numberOfBookedSpots:Int
/**
* When the hold expires (company-local time).
*/
// @ApiMember(Description="When the hold expires (company-local time).")
public var expirationDatetime:Date
/**
* The BookingReservationStatus value.
*/
// @ApiMember(Description="The BookingReservationStatus value.")
public var statusCode:Int
/**
* The BookingReservationStatus name.
*/
// @ApiMember(Description="The BookingReservationStatus name.")
public var statusName:String
/**
* The customer id holding the reservation, if any.
*/
// @ApiMember(Description="The customer id holding the reservation, if any.")
public var customerId:String?
/**
* The customer's full name, when a customer is attached.
*/
// @ApiMember(Description="The customer's full name, when a customer is attached.")
public var customerName:String
/**
* 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).")
public var customerEmail:String
required public init(){}
}
Swift QueryBookingReservations DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}