| GET | /bookingreservations/{SessionKey} | Get a booking reservation | Returns the current state of a reservation identified by its opaque session key. |
|---|
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BokaMera.API.ServiceModel.Dtos
Namespace Global
Namespace BokaMera.API.ServiceModel.Dtos
Public Partial Class BookingReservationResponse
'''<Summary>
'''The opaque session key that identifies the reservation.
'''</Summary>
<ApiMember(Description:="The opaque session key that identifies the reservation.")>
Public Overridable Property SessionKey As Guid
'''<Summary>
'''The company id.
'''</Summary>
<ApiMember(Description:="The company id.")>
Public Overridable Property CompanyId As Guid
'''<Summary>
'''The reserved service id.
'''</Summary>
<ApiMember(Description:="The reserved service id.")>
Public Overridable Property ServiceId As Integer
'''<Summary>
'''The reservation start.
'''</Summary>
<ApiMember(Description:="The reservation start.")>
Public Overridable Property From As Date
'''<Summary>
'''The reservation end.
'''</Summary>
<ApiMember(Description:="The reservation end.")>
Public Overridable Property [To] As Date
'''<Summary>
'''The BookingReservationStatus value.
'''</Summary>
<ApiMember(Description:="The BookingReservationStatus value.")>
Public Overridable Property StatusCode As Integer
'''<Summary>
'''The BookingReservationStatus name.
'''</Summary>
<ApiMember(Description:="The BookingReservationStatus name.")>
Public Overridable Property StatusName As String
'''<Summary>
'''When the hold expires (company-local time).
'''</Summary>
<ApiMember(Description:="When the hold expires (company-local time).")>
Public Overridable Property ExpirationDatetime As Date
'''<Summary>
'''The company's current time, in the same company-local frame as ExpirationDatetime. Clients compute the remaining hold as (ExpirationDatetime - ServerTime) so a countdown is correct regardless of the viewer's timezone or clock skew.
'''</Summary>
<ApiMember(Description:="The company's current time, in the same company-local frame as ExpirationDatetime. Clients compute the remaining hold as (ExpirationDatetime - ServerTime) so a countdown is correct regardless of the viewer's timezone or clock skew.")>
Public Overridable Property ServerTime As Date
'''<Summary>
'''Number of reserved spots.
'''</Summary>
<ApiMember(Description:="Number of reserved spots.")>
Public Overridable Property NumberOfBookedSpots As Integer
'''<Summary>
'''The computed price of the reservation, if any.
'''</Summary>
<ApiMember(Description:="The computed price of the reservation, if any.")>
Public Overridable Property Price As Decimal?
'''<Summary>
'''The currency of the price, if any.
'''</Summary>
<ApiMember(Description:="The currency of the price, if any.")>
Public Overridable Property CurrencyId As String
'''<Summary>
'''Ids of the resources held by the reservation.
'''</Summary>
<ApiMember(Description:="Ids of the resources held by the reservation.")>
Public Overridable Property ResourceIds As List(Of Integer) = New List(Of Integer)
'''<Summary>
'''The full in-progress selection payload (wizard/session state) as JSON.
'''</Summary>
<ApiMember(Description:="The full in-progress selection payload (wizard/session state) as JSON.")>
Public Overridable Property SelectionPayload As String
Public Overridable Property ResponseStatus As ResponseStatus
End Class
<ApiResponse(Description:="You were unauthorized to call this service", StatusCode:=401)>
<ApiResponse(Description:="No reservation found for the given session key", StatusCode:=404)>
Public Partial Class GetBookingReservation
Implements 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 Overridable Property SessionKey As Guid
'''<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 Overridable Property CompanyId As Guid? Implements ICompany.CompanyId
End Class
End Namespace
End Namespace
VB.NET GetBookingReservation DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>
<ServerTime>0001-01-01T00:00:00</ServerTime>
<ServiceId>0</ServiceId>
<SessionKey>00000000-0000-0000-0000-000000000000</SessionKey>
<StatusCode>0</StatusCode>
<StatusName>String</StatusName>
<To>0001-01-01T00:00:00</To>
</BookingReservationResponse>