BokaMera.API.Host

QueryBookingReservations

**Requires Authentication**
Requires any of the roles:	bookingsupplier-administrator-write, bookingsupplier-administrator-read, superadmin

The following routes are available for this service:
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.

**QueryBookingReservations** Parameters:
Name	Parameter	Data Type	Required	Description
CompanyId	query	Guid?	No	The company id, if empty will use the company id for the user you are logged in with.
ServiceId	query	int?	No	Only holds for this service id.
From	query	DateTime?	No	Only holds whose start (From) is on or after this datetime.
To	query	DateTime?	No	Only holds whose start (From) is on or before this datetime.
StatusCode	query	int?	No	Filter by BookingReservationStatus value. When omitted, the spot-holding statuses (Selecting=1, AwaitingPayment=2) are returned.

**QueryBookingReservationsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Results	form	List<AdminBookingReservationResult>	Yes	The matching reservation holds.
ResponseStatus	form	ResponseStatus	Yes

**AdminBookingReservationResult** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	int	No	The internal reservation id (target for the release endpoint).
SessionKey	form	Guid	No	The opaque session key that identifies the reservation.
ServiceId	form	int	No	The reserved service id.
From	form	DateTime	No	The reservation start.
To	form	DateTime	No	The reservation end.
NumberOfBookedSpots	form	int	No	Number of reserved spots.
ExpirationDatetime	form	DateTime	No	When the hold expires (company-local time).
StatusCode	form	int	No	The BookingReservationStatus value.
StatusName	form	string	Yes	The BookingReservationStatus name.
CustomerId	form	Guid?	No	The customer id holding the reservation, if any.
CustomerName	form	string	Yes	The customer's full name, when a customer is attached.
CustomerEmail	form	string	Yes	The customer email (falls back to the BookedBy email when no customer is attached).

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + 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>