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.
GetBookingReservation Parameters:
NameParameterData TypeRequiredDescription
SessionKeypathGuidYesThe opaque session key that identifies the reservation.
CompanyIdqueryGuid?NoThe company id, if empty will use the company id for the user you are logged in with.
BookingReservationResponse Parameters:
NameParameterData TypeRequiredDescription
SessionKeyformGuidNoThe opaque session key that identifies the reservation.
CompanyIdformGuidNoThe company id.
ServiceIdformintNoThe reserved service id.
FromformDateTimeNoThe reservation start.
ToformDateTimeNoThe reservation end.
StatusCodeformintNoThe BookingReservationStatus value.
StatusNameformstringYesThe BookingReservationStatus name.
ExpirationDatetimeformDateTimeNoWhen the hold expires (company-local time).
NumberOfBookedSpotsformintNoNumber of reserved spots.
Priceformdecimal?NoThe computed price of the reservation, if any.
CurrencyIdformstringYesThe currency of the price, if any.
ResourceIdsformList<int>YesIds of the resources held by the reservation.
SelectionPayloadformstringYesThe full in-progress selection payload (wizard/session state) as JSON.
ResponseStatusformResponseStatusYes

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"}}}