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.
"use strict";
export class BookingReservationResponse {
    /** @param {{SessionKey?:string,CompanyId?:string,ServiceId?:number,From?:string,To?:string,StatusCode?:number,StatusName?:string,ExpirationDatetime?:string,NumberOfBookedSpots?:number,Price?:number,CurrencyId?:string,ResourceIds?:number[],SelectionPayload?:string,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The opaque session key that identifies the reservation. */
    SessionKey;
    /**
     * @type {string}
     * @description The company id. */
    CompanyId;
    /**
     * @type {number}
     * @description The reserved service id. */
    ServiceId;
    /**
     * @type {string}
     * @description The reservation start. */
    From;
    /**
     * @type {string}
     * @description The reservation end. */
    To;
    /**
     * @type {number}
     * @description The BookingReservationStatus value. */
    StatusCode;
    /**
     * @type {string}
     * @description The BookingReservationStatus name. */
    StatusName;
    /**
     * @type {string}
     * @description When the hold expires (company-local time). */
    ExpirationDatetime;
    /**
     * @type {number}
     * @description Number of reserved spots. */
    NumberOfBookedSpots;
    /**
     * @type {?number}
     * @description The computed price of the reservation, if any. */
    Price;
    /**
     * @type {string}
     * @description The currency of the price, if any. */
    CurrencyId;
    /**
     * @type {number[]}
     * @description Ids of the resources held by the reservation. */
    ResourceIds = [];
    /**
     * @type {string}
     * @description The full in-progress selection payload (wizard/session state) as JSON. */
    SelectionPayload;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class ExtendBookingReservation {
    /** @param {{SessionKey?:string,CompanyId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The opaque session key that identifies the reservation. */
    SessionKey;
    /**
     * @type {?string}
     * @description The company id, if empty will use the company id for the user you are logged in with. */
    CompanyId;
}

JavaScript ExtendBookingReservation DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

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/jsonl
Content-Type: text/jsonl
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}}