BokaMera.API.Host

<back to all web services

GetBookingUserQueue

Requires Authentication
The following routes are available for this service:
GET/bookinguserqueue/{Id}Get queue item by Id
Imports System
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

        Public Partial Class BookingUserQueueItemResponse
            Public Sub New()
                Quantities = New List(Of BookingUserQueuePriceResponse)
            End Sub

            Public Overridable Property BookingUserQueueId As Integer
            Public Overridable Property CompanyId As Guid
            Public Overridable Property CustomerId As Guid
            Public Overridable Property ServiceId As Integer
            Public Overridable Property From As Date
            Public Overridable Property To As Date
            Public Overridable Property StatusCode As Integer
            Public Overridable Property StatusName As String
            Public Overridable Property SendConfirmationTime As Nullable(Of Date)
            Public Overridable Property Quantities As List(Of BookingUserQueuePriceResponse)
            Public Overridable Property Service As ServiceInfoResponse
            Public Overridable Property Company As CompanyInfoResponse
        End Class

        Public Partial Class BookingUserQueuePriceResponse
            Public Overridable Property CompanyId As Guid
            Public Overridable Property Id As Integer
            Public Overridable Property BookingUserQueueId As Integer
            Public Overridable Property ServicePriceId As Nullable(Of Integer)
            Public Overridable Property Quantity As Nullable(Of Integer)
        End Class

        Public Partial Class CompanyInfoResponse
            Public Overridable Property Id As Guid
            Public Overridable Property Name As String
            Public Overridable Property LogoType As Uri
            Public Overridable Property Category As String
            Public Overridable Property Street1 As String
            Public Overridable Property Street2 As String
            Public Overridable Property ZipCode As String
            Public Overridable Property City As String
            Public Overridable Property CountryId As String
            Public Overridable Property Longitude As String
            Public Overridable Property Latitude As String
            Public Overridable Property Phone As String
            Public Overridable Property Email As String
            Public Overridable Property HomePage As String
            Public Overridable Property SitePath As String
        End Class

        <ApiResponse(Description:="You were unauthorized to call this service", StatusCode:=401)>
        <ValidateRequest(Validator:="IsAuthenticated")>
        Public Partial Class GetBookingUserQueue
            '''<Summary>
            '''Id of the booking user queue
            '''</Summary>
            <ApiMember(Description:="Id of the booking user queue", IsRequired:=true, ParameterType:="path")>
            Public Overridable Property Id As Integer

            '''<Summary>
            '''
            '''</Summary>
            <ApiMember(Description:="", IsRequired:=true)>
            Public Overridable Property CompanyId As Guid

            '''<Summary>
            '''
            '''</Summary>
            <ApiMember(Description:="", IsRequired:=true)>
            Public Overridable Property CustomerId As Guid

            '''<Summary>
            '''If you want to include the service information for the booking
            '''</Summary>
            <ApiMember(DataType:="boolean", Description:="If you want to include the service information for the booking", ParameterType:="query")>
            Public Overridable Property IncludeServiceInformation As Boolean

            '''<Summary>
            '''If you want to include the company information for the booking
            '''</Summary>
            <ApiMember(DataType:="boolean", Description:="If you want to include the company information for the booking", ParameterType:="query")>
            Public Overridable Property IncludeCompanyInformation As Boolean
        End Class

        Public Partial Class GroupBookingSettings
            Public Overridable Property Active As Boolean
            Public Overridable Property Min As Integer
            Public Overridable Property Max As Integer
        End Class

        Public Partial Class MultipleResourceSettings
            Public Overridable Property Active As Boolean
            Public Overridable Property Min As Integer
            Public Overridable Property Max As Integer
        End Class

        Public Partial Class ServiceInfoResponse
            Public Overridable Property Id As Integer
            Public Overridable Property Name As String
            Public Overridable Property Description As String
            Public Overridable Property ImageUrl As Uri
            Public Overridable Property LengthInMinutes As Nullable(Of Integer)
            Public Overridable Property MaxNumberOfSpotsPerBooking As Integer
            Public Overridable Property GroupBooking As GroupBookingSettings
            Public Overridable Property MultipleResource As MultipleResourceSettings
            Public Overridable Property IsGroupBooking As Boolean
            Public Overridable Property IsPaymentEnabled As Boolean
        End Class
    End Namespace
End Namespace

VB.NET GetBookingUserQueue 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 /bookinguserqueue/{Id} HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"BookingUserQueueId":0,"ServiceId":0,"StatusCode":0,"StatusName":"String","SendConfirmationTime":"0001-01-01T00:00:00","Quantities":[{"Id":0,"BookingUserQueueId":0,"ServicePriceId":0,"Quantity":0}],"Service":{"Id":0,"Name":"String","Description":"String","LengthInMinutes":0,"MaxNumberOfSpotsPerBooking":0,"GroupBooking":{"Active":false,"Min":0,"Max":0},"MultipleResource":{"Active":false,"Min":0,"Max":0},"IsGroupBooking":false,"IsPaymentEnabled":false},"Company":{"Name":"String","Category":"String","Street1":"String","Street2":"String","ZipCode":"String","City":"String","CountryId":"String","Longitude":"String","Latitude":"String","Phone":"String","Email":"String","HomePage":"String","SitePath":"String"}}