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.

"use strict";
export class AdminBookingReservationResult {
    /** @param {{Id?:number,SessionKey?:string,ServiceId?:number,From?:string,To?:string,NumberOfBookedSpots?:number,ExpirationDatetime?:string,StatusCode?:number,StatusName?:string,CustomerId?:string,CustomerName?:string,CustomerEmail?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description The internal reservation id (target for the release endpoint). */
    Id;
    /**
     * @type {string}
     * @description The opaque session key that identifies the reservation. */
    SessionKey;
    /**
     * @type {number}
     * @description The reserved service id. */
    ServiceId;
    /**
     * @type {string}
     * @description The reservation start. */
    From;
    /**
     * @type {string}
     * @description The reservation end. */
    To;
    /**
     * @type {number}
     * @description Number of reserved spots. */
    NumberOfBookedSpots;
    /**
     * @type {string}
     * @description When the hold expires (company-local time). */
    ExpirationDatetime;
    /**
     * @type {number}
     * @description The BookingReservationStatus value. */
    StatusCode;
    /**
     * @type {string}
     * @description The BookingReservationStatus name. */
    StatusName;
    /**
     * @type {?string}
     * @description The customer id holding the reservation, if any. */
    CustomerId;
    /**
     * @type {string}
     * @description The customer's full name, when a customer is attached. */
    CustomerName;
    /**
     * @type {string}
     * @description The customer email (falls back to the BookedBy email when no customer is attached). */
    CustomerEmail;
}
export class QueryBookingReservationsResponse {
    /** @param {{Results?:AdminBookingReservationResult[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {AdminBookingReservationResult[]}
     * @description The matching reservation holds. */
    Results = [];
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class QueryBookingReservations {
    /** @param {{CompanyId?:string,ServiceId?:number,From?:string,To?:string,StatusCode?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {?string}
     * @description The company id, if empty will use the company id for the user you are logged in with. */
    CompanyId;
    /**
     * @type {?number}
     * @description Only holds for this service id. */
    ServiceId;
    /**
     * @type {?string}
     * @description Only holds whose start (From) is on or after this datetime. */
    From;
    /**
     * @type {?string}
     * @description Only holds whose start (From) is on or before this datetime. */
    To;
    /**
     * @type {?number}
     * @description Filter by BookingReservationStatus value. When omitted, the spot-holding statuses (Selecting=1, AwaitingPayment=2) are returned. */
    StatusCode;
}

JavaScript 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>