BokaMera.API.Host

<back to all web services

GetMyBookingReservations

Requires Authentication
The following routes are available for this service:
GET/bookingreservations/mineList the caller's own awaiting-payment reservationsReturns the logged-in customer's reservations that are still awaiting payment (committed but not yet paid/converted) so they can resume payment from their bookings list. Scoped to the caller's customer within the company; expired holds are excluded.
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BokaMera.API.ServiceModel.Dtos

Namespace Global

    Namespace BokaMera.API.ServiceModel.Dtos

        <ApiResponse(Description:="You were unauthorized to call this service", StatusCode:=401)>
        Public Partial Class GetMyBookingReservations
            Implements ICompany
            '''<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 Overridable Property CompanyId As Guid? Implements ICompany.CompanyId
        End Class

        Public Partial Class MyBookingReservationResult
            '''<Summary>
            '''The opaque session key that identifies the reservation.
            '''</Summary>
            <ApiMember(Description:="The opaque session key that identifies the reservation.")>
            Public Overridable Property SessionKey As Guid

            '''<Summary>
            '''The reserved service id.
            '''</Summary>
            <ApiMember(Description:="The reserved service id.")>
            Public Overridable Property ServiceId As Integer

            '''<Summary>
            '''The reserved service name.
            '''</Summary>
            <ApiMember(Description:="The reserved service name.")>
            Public Overridable Property ServiceName As String

            '''<Summary>
            '''The reservation start.
            '''</Summary>
            <ApiMember(Description:="The reservation start.")>
            Public Overridable Property From As Date

            '''<Summary>
            '''The reservation end.
            '''</Summary>
            <ApiMember(Description:="The reservation end.")>
            Public Overridable Property [To] As Date

            '''<Summary>
            '''Number of reserved spots.
            '''</Summary>
            <ApiMember(Description:="Number of reserved spots.")>
            Public Overridable Property NumberOfBookedSpots As Integer

            '''<Summary>
            '''When the hold expires (company-local time).
            '''</Summary>
            <ApiMember(Description:="When the hold expires (company-local time).")>
            Public Overridable Property ExpirationDatetime As Date

            '''<Summary>
            '''The company's current time, in the same frame as ExpirationDatetime.
            '''</Summary>
            <ApiMember(Description:="The company's current time, in the same frame as ExpirationDatetime.")>
            Public Overridable Property ServerTime As Date

            '''<Summary>
            '''The BookingReservationStatus value (AwaitingPayment).
            '''</Summary>
            <ApiMember(Description:="The BookingReservationStatus value (AwaitingPayment).")>
            Public Overridable Property StatusCode As Integer

            '''<Summary>
            '''The BookingReservationStatus name.
            '''</Summary>
            <ApiMember(Description:="The BookingReservationStatus name.")>
            Public Overridable Property StatusName As String

            '''<Summary>
            '''The currency of the reservation, if resolved.
            '''</Summary>
            <ApiMember(Description:="The currency of the reservation, if resolved.")>
            Public Overridable Property CurrencyId As String

            '''<Summary>
            '''The payable reference to use as the checkout InternalReferenceId when resuming payment.
            '''</Summary>
            <ApiMember(Description:="The payable reference to use as the checkout InternalReferenceId when resuming payment.")>
            Public Overridable Property InternalReferenceId As String
        End Class

        Public Partial Class MyBookingReservationsResponse
            '''<Summary>
            '''The caller's awaiting-payment reservations.
            '''</Summary>
            <ApiMember(Description:="The caller's awaiting-payment reservations.")>
            Public Overridable Property Results As List(Of MyBookingReservationResult) = New List(Of MyBookingReservationResult)

            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET GetMyBookingReservations DTOs

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

HTTP + XML

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

GET /bookingreservations/mine HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<MyBookingReservationsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <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>
  <Results>
    <MyBookingReservationResult>
      <CurrencyId>String</CurrencyId>
      <ExpirationDatetime>0001-01-01T00:00:00</ExpirationDatetime>
      <From>0001-01-01T00:00:00</From>
      <InternalReferenceId>String</InternalReferenceId>
      <NumberOfBookedSpots>0</NumberOfBookedSpots>
      <ServerTime>0001-01-01T00:00:00</ServerTime>
      <ServiceId>0</ServiceId>
      <ServiceName>String</ServiceName>
      <SessionKey>00000000-0000-0000-0000-000000000000</SessionKey>
      <StatusCode>0</StatusCode>
      <StatusName>String</StatusName>
      <To>0001-01-01T00:00:00</To>
    </MyBookingReservationResult>
  </Results>
</MyBookingReservationsResponse>