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.
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
{
    [ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)]
    public partial class GetMyBookingReservations
        : 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; }
    }

    public partial class MyBookingReservationResult
    {
        ///<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 reserved service name.
        ///</summary>
        [ApiMember(Description="The reserved service name.")]
        public virtual string ServiceName { 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 company's current time, in the same frame as ExpirationDatetime.
        ///</summary>
        [ApiMember(Description="The company's current time, in the same frame as ExpirationDatetime.")]
        public virtual DateTime ServerTime { get; set; }

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

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

        ///<summary>
        ///The currency of the reservation, if resolved.
        ///</summary>
        [ApiMember(Description="The currency of the reservation, if resolved.")]
        public virtual string CurrencyId { get; set; }

        ///<summary>
        ///The payable reference to use as the checkout InternalReferenceId when resuming payment.
        ///</summary>
        [ApiMember(Description="The payable reference to use as the checkout InternalReferenceId when resuming payment.")]
        public virtual string InternalReferenceId { get; set; }
    }

    public partial class MyBookingReservationsResponse
    {
        ///<summary>
        ///The caller's awaiting-payment reservations.
        ///</summary>
        [ApiMember(Description="The caller's awaiting-payment reservations.")]
        public virtual List<MyBookingReservationResult> Results { get; set; } = [];

        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# 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
		}
	}
}