BokaMera.API.Host

CommitBookingReservation

The following routes are available for this service:
POST	/bookingreservations/{SessionKey}/commit	Commit a booking reservation	Commits a reservation. If the service has no payment or the final price is zero the reservation is converted to a real booking synchronously and PaymentRequired is false. Otherwise the reservation is moved to AwaitingPayment and PaymentRequired is true.

"use strict";
export class CommitBookingReservationResponse {
    /** @param {{SessionKey?:string,StatusCode?:number,StatusName?:string,PaymentRequired?:boolean,BookingId?:number,Price?:number,InternalReferenceId?:string,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The opaque session key that identifies the reservation. */
    SessionKey;
    /**
     * @type {number}
     * @description The BookingReservationStatus value after commit. */
    StatusCode;
    /**
     * @type {string}
     * @description The BookingReservationStatus name after commit. */
    StatusName;
    /**
     * @type {boolean}
     * @description True when the customer still needs to pay (reservation moved to AwaitingPayment). */
    PaymentRequired;
    /**
     * @type {?number}
     * @description The created booking id, set when the reservation was converted without payment. */
    BookingId;
    /**
     * @type {?number}
     * @description The computed final price of the reservation, if any. */
    Price;
    /**
     * @type {string}
     * @description The reservation payable reference to use as the checkout InternalReferenceId when PaymentRequired is true. */
    InternalReferenceId;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class CommitBookingReservation {
    /** @param {{SessionKey?:string,CompanyId?:string,RebateCodeIds?:number[]}} [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;
    /**
     * @type {number[]}
     * @description Rebate codes to apply when computing the final price. */
    RebateCodeIds = [];
}

JavaScript CommitBookingReservation 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.

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

{
	CompanyId: 00000000-0000-0000-0000-000000000000,
	RebateCodeIds: 
	[
		0
	]
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	StatusCode: 0,
	StatusName: String,
	PaymentRequired: False,
	BookingId: 0,
	Price: 0,
	InternalReferenceId: String,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}