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

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

<BookingReservationResponse 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>
  <CurrencyId>String</CurrencyId>
  <ExpirationDatetime>0001-01-01T00:00:00</ExpirationDatetime>
  <From>0001-01-01T00:00:00</From>
  <NumberOfBookedSpots>0</NumberOfBookedSpots>
  <Price>0</Price>
  <ResourceIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </ResourceIds>
  <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>
  <SelectionPayload>String</SelectionPayload>
  <ServiceId>0</ServiceId>
  <SessionKey>00000000-0000-0000-0000-000000000000</SessionKey>
  <StatusCode>0</StatusCode>
  <StatusName>String</StatusName>
  <To>0001-01-01T00:00:00</To>
</BookingReservationResponse>