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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<CommitBookingReservation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <RebateCodeIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </RebateCodeIds>
  <SessionKey>00000000-0000-0000-0000-000000000000</SessionKey>
</CommitBookingReservation>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CommitBookingReservationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <BookingId>0</BookingId>
  <InternalReferenceId>String</InternalReferenceId>
  <PaymentRequired>false</PaymentRequired>
  <Price>0</Price>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <SessionKey>00000000-0000-0000-0000-000000000000</SessionKey>
  <StatusCode>0</StatusCode>
  <StatusName>String</StatusName>
</CommitBookingReservationResponse>