BokaMera.API.Host

<back to all web services

GetMyBookingReservations

Requires Authentication
The following routes are available for this service:
GET/bookingreservations/mineList the caller's own awaiting-payment reservationsReturns the logged-in customer's reservations that are still awaiting payment (committed but not yet paid/converted) so they can resume payment from their bookings list. Scoped to the caller's customer within the company; expired holds are excluded.
"use strict";
export class MyBookingReservationResult {
    /** @param {{SessionKey?:string,ServiceId?:number,ServiceName?:string,From?:string,To?:string,NumberOfBookedSpots?:number,ExpirationDatetime?:string,ServerTime?:string,StatusCode?:number,StatusName?:string,CurrencyId?:string,InternalReferenceId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The opaque session key that identifies the reservation. */
    SessionKey;
    /**
     * @type {number}
     * @description The reserved service id. */
    ServiceId;
    /**
     * @type {string}
     * @description The reserved service name. */
    ServiceName;
    /**
     * @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 {string}
     * @description The company's current time, in the same frame as ExpirationDatetime. */
    ServerTime;
    /**
     * @type {number}
     * @description The BookingReservationStatus value (AwaitingPayment). */
    StatusCode;
    /**
     * @type {string}
     * @description The BookingReservationStatus name. */
    StatusName;
    /**
     * @type {string}
     * @description The currency of the reservation, if resolved. */
    CurrencyId;
    /**
     * @type {string}
     * @description The payable reference to use as the checkout InternalReferenceId when resuming payment. */
    InternalReferenceId;
}
export class MyBookingReservationsResponse {
    /** @param {{Results?:MyBookingReservationResult[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {MyBookingReservationResult[]}
     * @description The caller's awaiting-payment reservations. */
    Results = [];
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class GetMyBookingReservations {
    /** @param {{CompanyId?:string}} [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;
}

JavaScript GetMyBookingReservations 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 /bookingreservations/mine HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Results: 
	[
		{
			ServiceId: 0,
			ServiceName: String,
			NumberOfBookedSpots: 0,
			StatusCode: 0,
			StatusName: String,
			CurrencyId: String,
			InternalReferenceId: String
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}