BokaMera.API.Host

<back to all web services

GetBookingReservation

The following routes are available for this service:
GET/bookingreservations/{SessionKey}Get a booking reservationReturns the current state of a reservation identified by its opaque session key.
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


@ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ApiResponse(Description="No reservation found for the given session key", StatusCode=404)
open class GetBookingReservation : ICompany
{
    /**
    * The opaque session key that identifies the reservation.
    */
    @ApiMember(Description="The opaque session key that identifies the reservation.", IsRequired=true, ParameterType="path")
    open var SessionKey:UUID? = null

    /**
    * 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.")
    override var CompanyId:UUID? = null
}

open class BookingReservationResponse
{
    /**
    * The opaque session key that identifies the reservation.
    */
    @ApiMember(Description="The opaque session key that identifies the reservation.")
    open var SessionKey:UUID? = null

    /**
    * The company id.
    */
    @ApiMember(Description="The company id.")
    open var CompanyId:UUID? = null

    /**
    * The reserved service id.
    */
    @ApiMember(Description="The reserved service id.")
    open var ServiceId:Int? = null

    /**
    * The reservation start.
    */
    @ApiMember(Description="The reservation start.")
    open var From:Date? = null

    /**
    * The reservation end.
    */
    @ApiMember(Description="The reservation end.")
    open var To:Date? = null

    /**
    * The BookingReservationStatus value.
    */
    @ApiMember(Description="The BookingReservationStatus value.")
    open var StatusCode:Int? = null

    /**
    * The BookingReservationStatus name.
    */
    @ApiMember(Description="The BookingReservationStatus name.")
    open var StatusName:String? = null

    /**
    * When the hold expires (company-local time).
    */
    @ApiMember(Description="When the hold expires (company-local time).")
    open var ExpirationDatetime:Date? = null

    /**
    * Number of reserved spots.
    */
    @ApiMember(Description="Number of reserved spots.")
    open var NumberOfBookedSpots:Int? = null

    /**
    * The computed price of the reservation, if any.
    */
    @ApiMember(Description="The computed price of the reservation, if any.")
    open var Price:BigDecimal? = null

    /**
    * The currency of the price, if any.
    */
    @ApiMember(Description="The currency of the price, if any.")
    open var CurrencyId:String? = null

    /**
    * Ids of the resources held by the reservation.
    */
    @ApiMember(Description="Ids of the resources held by the reservation.")
    open var ResourceIds:ArrayList<Int> = ArrayList<Int>()

    /**
    * The full in-progress selection payload (wizard/session state) as JSON.
    */
    @ApiMember(Description="The full in-progress selection payload (wizard/session state) as JSON.")
    open var SelectionPayload:String? = null

    open var ResponseStatus:ResponseStatus? = null
}

Kotlin GetBookingReservation 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.

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

{
	ServiceId: 0,
	StatusCode: 0,
	StatusName: String,
	NumberOfBookedSpots: 0,
	Price: 0,
	CurrencyId: String,
	ResourceIds: 
	[
		0
	],
	SelectionPayload: String,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}