BokaMera.API.Host

<back to all web services

CommitBookingReservation

The following routes are available for this service:
POST/bookingreservations/{SessionKey}/commitCommit a booking reservationCommits 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.
CommitBookingReservation Parameters:
NameParameterData TypeRequiredDescription
SessionKeypathGuidYesThe opaque session key that identifies the reservation.
CompanyIdbodyGuid?NoThe company id, if empty will use the company id for the user you are logged in with.
RebateCodeIdsbodyList<int>YesRebate codes to apply when computing the final price.
CommitBookingReservationResponse Parameters:
NameParameterData TypeRequiredDescription
SessionKeyformGuidNoThe opaque session key that identifies the reservation.
StatusCodeformintNoThe BookingReservationStatus value after commit.
StatusNameformstringYesThe BookingReservationStatus name after commit.
PaymentRequiredformboolNoTrue when the customer still needs to pay (reservation moved to AwaitingPayment).
BookingIdformint?NoThe created booking id, set when the reservation was converted without payment.
Priceformdecimal?NoThe computed final price of the reservation, if any.
InternalReferenceIdformstringYesThe reservation payable reference to use as the checkout InternalReferenceId when PaymentRequired is true.
ResponseStatusformResponseStatusYes

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

{"CompanyId":"00000000-0000-0000-0000-000000000000","RebateCodeIds":[0]}
HTTP/1.1 200 OK
Content-Type: application/json
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"}}}