BokaMera.API.Host

GetMyBookingReservations

The following routes are available for this service:
GET	/bookingreservations/mine	List the caller's own awaiting-payment reservations	Returns 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.

// @ts-nocheck

export class MyBookingReservationResult
{
    /** @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 reserved service name. */
    // @ApiMember(Description="The reserved service name.")
    public ServiceName: string;

    /** @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 company's current time, in the same frame as ExpirationDatetime. */
    // @ApiMember(Description="The company's current time, in the same frame as ExpirationDatetime.")
    public ServerTime: string;

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

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

    /** @description The currency of the reservation, if resolved. */
    // @ApiMember(Description="The currency of the reservation, if resolved.")
    public CurrencyId: string;

    /** @description The payable reference to use as the checkout InternalReferenceId when resuming payment. */
    // @ApiMember(Description="The payable reference to use as the checkout InternalReferenceId when resuming payment.")
    public InternalReferenceId: string;

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

export class MyBookingReservationsResponse
{
    /** @description The caller's awaiting-payment reservations. */
    // @ApiMember(Description="The caller's awaiting-payment reservations.")
    public Results: MyBookingReservationResult[] = [];

    public ResponseStatus: ResponseStatus;

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

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
export class GetMyBookingReservations 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;

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

TypeScript 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
		}
	}
}