| GET | /bookingreservations/{SessionKey} | Get a booking reservation | Returns the current state of a reservation identified by its opaque session key. |
|---|
namespace BokaMera.API.ServiceModel.Dtos
open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type BookingReservationResponse() =
///<summary>
///The opaque session key that identifies the reservation.
///</summary>
[<ApiMember(Description="The opaque session key that identifies the reservation.")>]
member val SessionKey:Guid = new Guid() with get,set
///<summary>
///The company id.
///</summary>
[<ApiMember(Description="The company id.")>]
member val CompanyId:Guid = new Guid() with get,set
///<summary>
///The reserved service id.
///</summary>
[<ApiMember(Description="The reserved service id.")>]
member val ServiceId:Int32 = new Int32() with get,set
///<summary>
///The reservation start.
///</summary>
[<ApiMember(Description="The reservation start.")>]
member val From:DateTime = new DateTime() with get,set
///<summary>
///The reservation end.
///</summary>
[<ApiMember(Description="The reservation end.")>]
member val To:DateTime = new DateTime() with get,set
///<summary>
///The BookingReservationStatus value.
///</summary>
[<ApiMember(Description="The BookingReservationStatus value.")>]
member val StatusCode:Int32 = new Int32() with get,set
///<summary>
///The BookingReservationStatus name.
///</summary>
[<ApiMember(Description="The BookingReservationStatus name.")>]
member val StatusName:String = null with get,set
///<summary>
///When the hold expires (company-local time).
///</summary>
[<ApiMember(Description="When the hold expires (company-local time).")>]
member val ExpirationDatetime:DateTime = new DateTime() with get,set
///<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.")>]
member val ServerTime:DateTime = new DateTime() with get,set
///<summary>
///Number of reserved spots.
///</summary>
[<ApiMember(Description="Number of reserved spots.")>]
member val NumberOfBookedSpots:Int32 = new Int32() with get,set
///<summary>
///The computed price of the reservation, if any.
///</summary>
[<ApiMember(Description="The computed price of the reservation, if any.")>]
member val Price:Nullable<Decimal> = new Nullable<Decimal>() with get,set
///<summary>
///The currency of the price, if any.
///</summary>
[<ApiMember(Description="The currency of the price, if any.")>]
member val CurrencyId:String = null with get,set
///<summary>
///Ids of the resources held by the reservation.
///</summary>
[<ApiMember(Description="Ids of the resources held by the reservation.")>]
member val ResourceIds:ResizeArray<Int32> = null with get,set
///<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.")>]
member val SelectionPayload:String = null with get,set
member val ResponseStatus:ResponseStatus = null with get,set
[<ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)>]
[<ApiResponse(Description="No reservation found for the given session key", StatusCode=404)>]
[<AllowNullLiteral>]
type GetBookingReservation() =
///<summary>
///The opaque session key that identifies the reservation.
///</summary>
[<ApiMember(Description="The opaque session key that identifies the reservation.", IsRequired=true, ParameterType="path")>]
member val SessionKey:Guid = new Guid() with 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.")>]
member val CompanyId:Nullable<Guid> = new Nullable<Guid>() with get,set
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>