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.
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BokaMera.API.ServiceModel.Dtos;

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 virtual Guid SessionKey { get; set; }

        ///<summary>
        ///The company id.
        ///</summary>
        [ApiMember(Description="The company id.")]
        public virtual Guid CompanyId { get; set; }

        ///<summary>
        ///The reserved service id.
        ///</summary>
        [ApiMember(Description="The reserved service id.")]
        public virtual int ServiceId { get; set; }

        ///<summary>
        ///The reservation start.
        ///</summary>
        [ApiMember(Description="The reservation start.")]
        public virtual DateTime From { get; set; }

        ///<summary>
        ///The reservation end.
        ///</summary>
        [ApiMember(Description="The reservation end.")]
        public virtual DateTime To { get; set; }

        ///<summary>
        ///The BookingReservationStatus value.
        ///</summary>
        [ApiMember(Description="The BookingReservationStatus value.")]
        public virtual int StatusCode { get; set; }

        ///<summary>
        ///The BookingReservationStatus name.
        ///</summary>
        [ApiMember(Description="The BookingReservationStatus name.")]
        public virtual string StatusName { get; set; }

        ///<summary>
        ///When the hold expires (company-local time).
        ///</summary>
        [ApiMember(Description="When the hold expires (company-local time).")]
        public virtual DateTime ExpirationDatetime { get; set; }

        ///<summary>
        ///Number of reserved spots.
        ///</summary>
        [ApiMember(Description="Number of reserved spots.")]
        public virtual int NumberOfBookedSpots { get; set; }

        ///<summary>
        ///The computed price of the reservation, if any.
        ///</summary>
        [ApiMember(Description="The computed price of the reservation, if any.")]
        public virtual decimal? Price { get; set; }

        ///<summary>
        ///The currency of the price, if any.
        ///</summary>
        [ApiMember(Description="The currency of the price, if any.")]
        public virtual string CurrencyId { get; set; }

        ///<summary>
        ///Ids of the resources held by the reservation.
        ///</summary>
        [ApiMember(Description="Ids of the resources held by the reservation.")]
        public virtual List<int> ResourceIds { 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.")]
        public virtual string SelectionPayload { get; set; }

        public virtual ResponseStatus ResponseStatus { 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)]
    public partial class GetBookingReservation
        : 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 virtual Guid SessionKey { 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.")]
        public virtual Guid? CompanyId { get; set; }
    }

}

C# GetBookingReservation DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
HTTP/1.1 200 OK
Content-Type: application/json
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"}}}