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.
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BokaMera.API.ServiceModel.Dtos;

namespace BokaMera.API.ServiceModel.Dtos
{
    [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 partial class CommitBookingReservation
        : ICompany
    {
        ///<summary>
        ///The opaque session key that identifies the reservation.
        ///</summary>
        [ApiMember(Description="The opaque session key that identifies the reservation.", IsRequired=true, ParameterType="path")]
        public virtual Guid SessionKey { get; set; }

        ///<summary>
        ///The company id, if empty will use the company id for the user you are logged in with.
        ///</summary>
        [ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")]
        public virtual Guid? CompanyId { get; set; }

        ///<summary>
        ///Rebate codes to apply when computing the final price.
        ///</summary>
        [ApiMember(Description="Rebate codes to apply when computing the final price.")]
        public virtual List<int> RebateCodeIds { get; set; } = [];
    }

    public partial class CommitBookingReservationResponse
    {
        ///<summary>
        ///The opaque session key that identifies the reservation.
        ///</summary>
        [ApiMember(Description="The opaque session key that identifies the reservation.")]
        public virtual Guid SessionKey { get; set; }

        ///<summary>
        ///The BookingReservationStatus value after commit.
        ///</summary>
        [ApiMember(Description="The BookingReservationStatus value after commit.")]
        public virtual int StatusCode { get; set; }

        ///<summary>
        ///The BookingReservationStatus name after commit.
        ///</summary>
        [ApiMember(Description="The BookingReservationStatus name after commit.")]
        public virtual string StatusName { get; set; }

        ///<summary>
        ///True when the customer still needs to pay (reservation moved to AwaitingPayment).
        ///</summary>
        [ApiMember(Description="True when the customer still needs to pay (reservation moved to AwaitingPayment).")]
        public virtual bool PaymentRequired { get; set; }

        ///<summary>
        ///The created booking id, set when the reservation was converted without payment.
        ///</summary>
        [ApiMember(Description="The created booking id, set when the reservation was converted without payment.")]
        public virtual int? BookingId { get; set; }

        ///<summary>
        ///The computed final price of the reservation, if any.
        ///</summary>
        [ApiMember(Description="The computed final price of the reservation, if any.")]
        public virtual decimal? Price { get; set; }

        ///<summary>
        ///The reservation payable reference to use as the checkout InternalReferenceId when PaymentRequired is true.
        ///</summary>
        [ApiMember(Description="The reservation payable reference to use as the checkout InternalReferenceId when PaymentRequired is true.")]
        public virtual string InternalReferenceId { get; set; }

        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# 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
		}
	}
}