BokaMera.API.Host

ExtendBookingReservation

The following routes are available for this service:
PUT	/bookingreservations/{SessionKey}/extend	Extend a booking reservation hold	Pushes 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.

// @ts-nocheck

export class BookingReservationResponse
{
    /** @description The opaque session key that identifies the reservation. */
    // @ApiMember(Description="The opaque session key that identifies the reservation.")
    public SessionKey: string;

    /** @description The company id. */
    // @ApiMember(Description="The company id.")
    public CompanyId: string;

    /** @description The reserved service id. */
    // @ApiMember(Description="The reserved service id.")
    public ServiceId: number;

    /** @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 The BookingReservationStatus value. */
    // @ApiMember(Description="The BookingReservationStatus value.")
    public StatusCode: number;

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

    /** @description When the hold expires (company-local time). */
    // @ApiMember(Description="When the hold expires (company-local time).")
    public ExpirationDatetime: string;

    /** @description Number of reserved spots. */
    // @ApiMember(Description="Number of reserved spots.")
    public NumberOfBookedSpots: number;

    /** @description The computed price of the reservation, if any. */
    // @ApiMember(Description="The computed price of the reservation, if any.")
    public Price?: number;

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

    /** @description Ids of the resources held by the reservation. */
    // @ApiMember(Description="Ids of the resources held by the reservation.")
    public ResourceIds: number[] = [];

    /** @description 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 SelectionPayload: string;

    public ResponseStatus: ResponseStatus;

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

// @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)
export class ExtendBookingReservation implements ICompany
{
    /** @description The opaque session key that identifies the reservation. */
    // @ApiMember(Description="The opaque session key that identifies the reservation.", IsRequired=true, ParameterType="path")
    public SessionKey: string;

    /** @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<ExtendBookingReservation>) { (Object as any).assign(this, init); }
}

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