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.

// @ts-nocheck

export class AdminBookingReservationResult
{
    /** @description The internal reservation id (target for the release endpoint). */
    // @ApiMember(Description="The internal reservation id (target for the release endpoint).")
    public Id: number;

    /** @description The opaque session key that identifies the reservation. */
    // @ApiMember(Description="The opaque session key that identifies the reservation.")
    public SessionKey: string;

    /** @description The reserved service id. */
    // @ApiMember(Description="The reserved service id.")
    public ServiceId: number;

    /** @description The reservation start. */
    // @ApiMember(Description="The reservation start.")
    public From: string;

    /** @description The reservation end. */
    // @ApiMember(Description="The reservation end.")
    public To: string;

    /** @description Number of reserved spots. */
    // @ApiMember(Description="Number of reserved spots.")
    public NumberOfBookedSpots: number;

    /** @description When the hold expires (company-local time). */
    // @ApiMember(Description="When the hold expires (company-local time).")
    public ExpirationDatetime: string;

    /** @description The BookingReservationStatus value. */
    // @ApiMember(Description="The BookingReservationStatus value.")
    public StatusCode: number;

    /** @description The BookingReservationStatus name. */
    // @ApiMember(Description="The BookingReservationStatus name.")
    public StatusName: string;

    /** @description The customer id holding the reservation, if any. */
    // @ApiMember(Description="The customer id holding the reservation, if any.")
    public CustomerId?: string;

    /** @description The customer's full name, when a customer is attached. */
    // @ApiMember(Description="The customer's full name, when a customer is attached.")
    public CustomerName: string;

    /** @description 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 CustomerEmail: string;

    public constructor(init?: Partial<AdminBookingReservationResult>) { (Object as any).assign(this, init); }
}

export class QueryBookingReservationsResponse
{
    /** @description The matching reservation holds. */
    // @ApiMember(Description="The matching reservation holds.")
    public Results: AdminBookingReservationResult[] = [];

    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<QueryBookingReservationsResponse>) { (Object as any).assign(this, init); }
}

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ApiResponse(Description="You are not an administrator for the requested company", StatusCode=403)
export class QueryBookingReservations implements ICompany
{
    /** @description 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 CompanyId?: string;

    /** @description Only holds for this service id. */
    // @ApiMember(Description="Only holds for this service id.")
    public ServiceId?: number;

    /** @description 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 From?: string;

    /** @description 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 To?: string;

    /** @description 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 StatusCode?: number;

    public constructor(init?: Partial<QueryBookingReservations>) { (Object as any).assign(this, init); }
}

TypeScript QueryBookingReservations DTOs

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

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