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.
import Foundation
import ServiceStack

// @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 selected slot is no longer available", StatusCode=409)
public class CommitBookingReservation : ICompany, Codable
{
    /**
    * The opaque session key that identifies the reservation.
    */
    // @ApiMember(Description="The opaque session key that identifies the reservation.", IsRequired=true, ParameterType="path")
    public var sessionKey:String

    /**
    * 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 var companyId:String?

    /**
    * Rebate codes to apply when computing the final price.
    */
    // @ApiMember(Description="Rebate codes to apply when computing the final price.")
    public var rebateCodeIds:[Int] = []

    required public init(){}
}

public class CommitBookingReservationResponse : Codable
{
    /**
    * The opaque session key that identifies the reservation.
    */
    // @ApiMember(Description="The opaque session key that identifies the reservation.")
    public var sessionKey:String

    /**
    * The BookingReservationStatus value after commit.
    */
    // @ApiMember(Description="The BookingReservationStatus value after commit.")
    public var statusCode:Int

    /**
    * The BookingReservationStatus name after commit.
    */
    // @ApiMember(Description="The BookingReservationStatus name after commit.")
    public var statusName:String

    /**
    * True when the customer still needs to pay (reservation moved to AwaitingPayment).
    */
    // @ApiMember(Description="True when the customer still needs to pay (reservation moved to AwaitingPayment).")
    public var paymentRequired:Bool

    /**
    * The created booking id, set when the reservation was converted without payment.
    */
    // @ApiMember(Description="The created booking id, set when the reservation was converted without payment.")
    public var bookingId:Int?

    /**
    * The computed final price of the reservation, if any.
    */
    // @ApiMember(Description="The computed final price of the reservation, if any.")
    public var price:Double?

    /**
    * The reservation payable reference to use as the checkout InternalReferenceId when PaymentRequired is true.
    */
    // @ApiMember(Description="The reservation payable reference to use as the checkout InternalReferenceId when PaymentRequired is true.")
    public var internalReferenceId:String

    public var responseStatus:ResponseStatus

    required public init(){}
}


Swift CommitBookingReservation DTOs

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