BokaMera.API.Host

<back to all web services

ExtendBookingReservation

The following routes are available for this service:
PUT/bookingreservations/{SessionKey}/extendExtend a booking reservation holdPushes the hold expiration of an AwaitingPayment reservation forward (bounded, never past the slot start) so the customer can retry a failed Stripe payment without losing the slot. The slot availability is re-checked; if it was taken in the meantime the request is rejected with Conflict.
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>
        ///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)>]
    [<ApiResponse(Description="The reservation is not awaiting payment or the selected slot is no longer available", StatusCode=409)>]
    [<AllowNullLiteral>]
    type ExtendBookingReservation() = 
        ///<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

F# ExtendBookingReservation DTOs

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

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /bookingreservations/{SessionKey}/extend HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}}