| 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. |
|---|
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BokaMera.API.ServiceModel.Dtos
Namespace Global
Namespace BokaMera.API.ServiceModel.Dtos
Public Partial Class AdminBookingReservationResult
'''<Summary>
'''The internal reservation id (target for the release endpoint).
'''</Summary>
<ApiMember(Description:="The internal reservation id (target for the release endpoint).")>
Public Overridable Property Id As Integer
'''<Summary>
'''The opaque session key that identifies the reservation.
'''</Summary>
<ApiMember(Description:="The opaque session key that identifies the reservation.")>
Public Overridable Property SessionKey As Guid
'''<Summary>
'''The reserved service id.
'''</Summary>
<ApiMember(Description:="The reserved service id.")>
Public Overridable Property ServiceId As Integer
'''<Summary>
'''The reservation start.
'''</Summary>
<ApiMember(Description:="The reservation start.")>
Public Overridable Property From As Date
'''<Summary>
'''The reservation end.
'''</Summary>
<ApiMember(Description:="The reservation end.")>
Public Overridable Property [To] As Date
'''<Summary>
'''Number of reserved spots.
'''</Summary>
<ApiMember(Description:="Number of reserved spots.")>
Public Overridable Property NumberOfBookedSpots As Integer
'''<Summary>
'''When the hold expires (company-local time).
'''</Summary>
<ApiMember(Description:="When the hold expires (company-local time).")>
Public Overridable Property ExpirationDatetime As Date
'''<Summary>
'''The BookingReservationStatus value.
'''</Summary>
<ApiMember(Description:="The BookingReservationStatus value.")>
Public Overridable Property StatusCode As Integer
'''<Summary>
'''The BookingReservationStatus name.
'''</Summary>
<ApiMember(Description:="The BookingReservationStatus name.")>
Public Overridable Property StatusName As String
'''<Summary>
'''The customer id holding the reservation, if any.
'''</Summary>
<ApiMember(Description:="The customer id holding the reservation, if any.")>
Public Overridable Property CustomerId As Guid?
'''<Summary>
'''The customer's full name, when a customer is attached.
'''</Summary>
<ApiMember(Description:="The customer's full name, when a customer is attached.")>
Public Overridable Property CustomerName As String
'''<Summary>
'''The customer email (falls back to the BookedBy email when no customer is attached).
'''</Summary>
<ApiMember(Description:="The customer email (falls back to the BookedBy email when no customer is attached).")>
Public Overridable Property CustomerEmail As String
End Class
<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 Partial Class QueryBookingReservations
Implements ICompany
'''<Summary>
'''The company id, if empty will use the company id for the user you are logged in with.
'''</Summary>
<ApiMember(Description:="The company id, if empty will use the company id for the user you are logged in with.")>
Public Overridable Property CompanyId As Guid? Implements ICompany.CompanyId
'''<Summary>
'''Only holds for this service id.
'''</Summary>
<ApiMember(Description:="Only holds for this service id.")>
Public Overridable Property ServiceId As Integer?
'''<Summary>
'''Only holds whose start (From) is on or after this datetime.
'''</Summary>
<ApiMember(Description:="Only holds whose start (From) is on or after this datetime.")>
Public Overridable Property From As Date?
'''<Summary>
'''Only holds whose start (From) is on or before this datetime.
'''</Summary>
<ApiMember(Description:="Only holds whose start (From) is on or before this datetime.")>
Public Overridable Property [To] As Date?
'''<Summary>
'''Filter by BookingReservationStatus value. When omitted, the spot-holding statuses (Selecting=1, AwaitingPayment=2) are returned.
'''</Summary>
<ApiMember(Description:="Filter by BookingReservationStatus value. When omitted, the spot-holding statuses (Selecting=1, AwaitingPayment=2) are returned.")>
Public Overridable Property StatusCode As Integer?
End Class
Public Partial Class QueryBookingReservationsResponse
'''<Summary>
'''The matching reservation holds.
'''</Summary>
<ApiMember(Description:="The matching reservation holds.")>
Public Overridable Property Results As List(Of AdminBookingReservationResult) = New List(Of AdminBookingReservationResult)
Public Overridable Property ResponseStatus As ResponseStatus
End Class
End Namespace
End Namespace
VB.NET 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
}
}
}