BokaMera.API.Host

<back to all web services

ExtendBookingReservation

The following routes are available for this service:
PUT/bookingreservations/{SessionKey}/extendExtend a booking reservation holdPushes the hold expiration of an AwaitingPayment reservation forward (bounded, never past the slot start) so the customer can retry a failed Stripe payment without losing the slot. The slot availability is re-checked; if it was taken in the meantime the request is rejected with Conflict.
import Foundation
import ServiceStack

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ApiResponse(Description="No reservation found for the given session key", StatusCode=404)
// @ApiResponse(Description="The reservation is not awaiting payment or the selected slot is no longer available", StatusCode=409)
public class ExtendBookingReservation : ICompany, Codable
{
    /**
    * The opaque session key that identifies the reservation.
    */
    // @ApiMember(Description="The opaque session key that identifies the reservation.", IsRequired=true, ParameterType="path")
    public var sessionKey:String

    /**
    * 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 var companyId:String?

    required public init(){}
}

public class BookingReservationResponse : Codable
{
    /**
    * The opaque session key that identifies the reservation.
    */
    // @ApiMember(Description="The opaque session key that identifies the reservation.")
    public var sessionKey:String

    /**
    * The company id.
    */
    // @ApiMember(Description="The company id.")
    public var companyId:String

    /**
    * The reserved service id.
    */
    // @ApiMember(Description="The reserved service id.")
    public var serviceId:Int

    /**
    * The reservation start.
    */
    // @ApiMember(Description="The reservation start.")
    public var from:Date

    /**
    * The reservation end.
    */
    // @ApiMember(Description="The reservation end.")
    public var to:Date

    /**
    * The BookingReservationStatus value.
    */
    // @ApiMember(Description="The BookingReservationStatus value.")
    public var statusCode:Int

    /**
    * The BookingReservationStatus name.
    */
    // @ApiMember(Description="The BookingReservationStatus name.")
    public var statusName:String

    /**
    * When the hold expires (company-local time).
    */
    // @ApiMember(Description="When the hold expires (company-local time).")
    public var expirationDatetime:Date

    /**
    * Number of reserved spots.
    */
    // @ApiMember(Description="Number of reserved spots.")
    public var numberOfBookedSpots:Int

    /**
    * The computed price of the reservation, if any.
    */
    // @ApiMember(Description="The computed price of the reservation, if any.")
    public var price:Double?

    /**
    * The currency of the price, if any.
    */
    // @ApiMember(Description="The currency of the price, if any.")
    public var currencyId:String

    /**
    * Ids of the resources held by the reservation.
    */
    // @ApiMember(Description="Ids of the resources held by the reservation.")
    public var resourceIds:[Int] = []

    /**
    * The full in-progress selection payload (wizard/session state) as JSON.
    */
    // @ApiMember(Description="The full in-progress selection payload (wizard/session state) as JSON.")
    public var selectionPayload:String

    public var responseStatus:ResponseStatus

    required public init(){}
}


Swift ExtendBookingReservation 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.

PUT /bookingreservations/{SessionKey}/extend HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CompanyId: 00000000-0000-0000-0000-000000000000
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ServiceId: 0,
	StatusCode: 0,
	StatusName: String,
	NumberOfBookedSpots: 0,
	Price: 0,
	CurrencyId: String,
	ResourceIds: 
	[
		0
	],
	SelectionPayload: String,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}