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.
namespace BokaMera.API.ServiceModel.Dtos

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type MyBookingReservationResult() = 
        ///<summary>
        ///The opaque session key that identifies the reservation.
        ///</summary>
        [<ApiMember(Description="The opaque session key that identifies the reservation.")>]
        member val SessionKey:Guid = new Guid() with get,set

        ///<summary>
        ///The reserved service id.
        ///</summary>
        [<ApiMember(Description="The reserved service id.")>]
        member val ServiceId:Int32 = new Int32() with get,set

        ///<summary>
        ///The reserved service name.
        ///</summary>
        [<ApiMember(Description="The reserved service name.")>]
        member val ServiceName:String = null with get,set

        ///<summary>
        ///The reservation start.
        ///</summary>
        [<ApiMember(Description="The reservation start.")>]
        member val From:DateTime = new DateTime() with get,set

        ///<summary>
        ///The reservation end.
        ///</summary>
        [<ApiMember(Description="The reservation end.")>]
        member val To:DateTime = new DateTime() with get,set

        ///<summary>
        ///Number of reserved spots.
        ///</summary>
        [<ApiMember(Description="Number of reserved spots.")>]
        member val NumberOfBookedSpots:Int32 = new Int32() with get,set

        ///<summary>
        ///When the hold expires (company-local time).
        ///</summary>
        [<ApiMember(Description="When the hold expires (company-local time).")>]
        member val ExpirationDatetime:DateTime = new DateTime() with 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.")>]
        member val ServerTime:DateTime = new DateTime() with get,set

        ///<summary>
        ///The BookingReservationStatus value (AwaitingPayment).
        ///</summary>
        [<ApiMember(Description="The BookingReservationStatus value (AwaitingPayment).")>]
        member val StatusCode:Int32 = new Int32() with get,set

        ///<summary>
        ///The BookingReservationStatus name.
        ///</summary>
        [<ApiMember(Description="The BookingReservationStatus name.")>]
        member val StatusName:String = null with get,set

        ///<summary>
        ///The currency of the reservation, if resolved.
        ///</summary>
        [<ApiMember(Description="The currency of the reservation, if resolved.")>]
        member val CurrencyId:String = null with 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.")>]
        member val InternalReferenceId:String = null with get,set

    [<AllowNullLiteral>]
    type MyBookingReservationsResponse() = 
        ///<summary>
        ///The caller's awaiting-payment reservations.
        ///</summary>
        [<ApiMember(Description="The caller's awaiting-payment reservations.")>]
        member val Results:ResizeArray<MyBookingReservationResult> = null with get,set

        member val ResponseStatus:ResponseStatus = null with get,set

    [<ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)>]
    [<AllowNullLiteral>]
    type GetMyBookingReservations() = 
        ///<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.")>]
        member val CompanyId:Nullable<Guid> = new Nullable<Guid>() with get,set

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