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.

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BokaMera.API.ServiceModel.Dtos;

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 virtual int Id { get; set; }

        ///<summary>
        ///The opaque session key that identifies the reservation.
        ///</summary>
        [ApiMember(Description="The opaque session key that identifies the reservation.")]
        public virtual Guid SessionKey { get; set; }

        ///<summary>
        ///The reserved service id.
        ///</summary>
        [ApiMember(Description="The reserved service id.")]
        public virtual int ServiceId { get; set; }

        ///<summary>
        ///The reservation start.
        ///</summary>
        [ApiMember(Description="The reservation start.")]
        public virtual DateTime From { get; set; }

        ///<summary>
        ///The reservation end.
        ///</summary>
        [ApiMember(Description="The reservation end.")]
        public virtual DateTime To { get; set; }

        ///<summary>
        ///Number of reserved spots.
        ///</summary>
        [ApiMember(Description="Number of reserved spots.")]
        public virtual int NumberOfBookedSpots { get; set; }

        ///<summary>
        ///When the hold expires (company-local time).
        ///</summary>
        [ApiMember(Description="When the hold expires (company-local time).")]
        public virtual DateTime ExpirationDatetime { get; set; }

        ///<summary>
        ///The BookingReservationStatus value.
        ///</summary>
        [ApiMember(Description="The BookingReservationStatus value.")]
        public virtual int StatusCode { get; set; }

        ///<summary>
        ///The BookingReservationStatus name.
        ///</summary>
        [ApiMember(Description="The BookingReservationStatus name.")]
        public virtual string StatusName { get; set; }

        ///<summary>
        ///The customer id holding the reservation, if any.
        ///</summary>
        [ApiMember(Description="The customer id holding the reservation, if any.")]
        public virtual Guid? CustomerId { get; set; }

        ///<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 virtual string CustomerName { get; set; }

        ///<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 virtual string CustomerEmail { get; set; }
    }

    [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
        : 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 virtual Guid? CompanyId { get; set; }

        ///<summary>
        ///Only holds for this service id.
        ///</summary>
        [ApiMember(Description="Only holds for this service id.")]
        public virtual int? ServiceId { get; set; }

        ///<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 virtual DateTime? From { get; set; }

        ///<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 virtual DateTime? To { get; set; }

        ///<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 virtual int? StatusCode { get; set; }
    }

    public partial class QueryBookingReservationsResponse
    {
        ///<summary>
        ///The matching reservation holds.
        ///</summary>
        [ApiMember(Description="The matching reservation holds.")]
        public virtual List<AdminBookingReservationResult> Results { get; set; } = [];

        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# QueryBookingReservations DTOs

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>