| GET | /bookingreservations/{SessionKey} | Get a booking reservation | Returns the current state of a reservation identified by its opaque session key. |
|---|
// @ts-nocheck
export class BookingReservationResponse
{
/** @description The opaque session key that identifies the reservation. */
// @ApiMember(Description="The opaque session key that identifies the reservation.")
public SessionKey: string;
/** @description The company id. */
// @ApiMember(Description="The company id.")
public CompanyId: string;
/** @description The reserved service id. */
// @ApiMember(Description="The reserved service id.")
public ServiceId: number;
/** @description The reservation start. */
// @ApiMember(Description="The reservation start.")
public From: string;
/** @description The reservation end. */
// @ApiMember(Description="The reservation end.")
public To: string;
/** @description The BookingReservationStatus value. */
// @ApiMember(Description="The BookingReservationStatus value.")
public StatusCode: number;
/** @description The BookingReservationStatus name. */
// @ApiMember(Description="The BookingReservationStatus name.")
public StatusName: string;
/** @description When the hold expires (company-local time). */
// @ApiMember(Description="When the hold expires (company-local time).")
public ExpirationDatetime: string;
/** @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. */
// @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 ServerTime: string;
/** @description Number of reserved spots. */
// @ApiMember(Description="Number of reserved spots.")
public NumberOfBookedSpots: number;
/** @description The computed price of the reservation, if any. */
// @ApiMember(Description="The computed price of the reservation, if any.")
public Price?: number;
/** @description The currency of the price, if any. */
// @ApiMember(Description="The currency of the price, if any.")
public CurrencyId: string;
/** @description Ids of the resources held by the reservation. */
// @ApiMember(Description="Ids of the resources held by the reservation.")
public ResourceIds: number[] = [];
/** @description The full in-progress selection payload (wizard/session state) as JSON. */
// @ApiMember(Description="The full in-progress selection payload (wizard/session state) as JSON.")
public SelectionPayload: string;
public ResponseStatus: ResponseStatus;
public constructor(init?: Partial<BookingReservationResponse>) { (Object as any).assign(this, init); }
}
// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ApiResponse(Description="No reservation found for the given session key", StatusCode=404)
export class GetBookingReservation implements ICompany
{
/** @description The opaque session key that identifies the reservation. */
// @ApiMember(Description="The opaque session key that identifies the reservation.", IsRequired=true, ParameterType="path")
public SessionKey: string;
/** @description 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.")
public CompanyId?: string;
public constructor(init?: Partial<GetBookingReservation>) { (Object as any).assign(this, init); }
}
TypeScript 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>