BokaMera.API.Host

<back to all web services

BookingLogQuery

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, bookingsupplier-administrator-read, superadmin
The following routes are available for this service:
GET/bookinglogFind booking log for booking.
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BokaMera.API.ServiceModel.Dtos
Imports BokaMera.API.ServiceModel.Db

Namespace Global

    Namespace BokaMera.API.ServiceModel.Db

        Public Partial Class BaseModel
        End Class

        Public Partial Class BookingLog
            Inherits BaseModel
            <References(GetType(BookingLogEventType))>
            Public Overridable Property EventTypeId As Integer

            Public Overridable Property EventType As BookingLogEventType
            <Required>
            Public Overridable Property CompanyId As Guid

            <Required>
            Public Overridable Property BookingId As Integer

            Public Overridable Property Id As Integer
            Public Overridable Property Comments As String
            Public Overridable Property UserId As String
            <Required>
            Public Overridable Property Created As Date

            Public Overridable Property ModifiedDate As Nullable(Of DateTimeOffset)
        End Class

        Public Partial Class BookingLogEventType
            Inherits BaseModel
            <Required>
            Public Overridable Property Name As String

            <Required>
            Public Overridable Property Description As String

            Public Overridable Property ModifiedDate As Nullable(Of DateTimeOffset)
            <Required>
            Public Overridable Property Id As Integer
        End Class
    End Namespace

    Namespace BokaMera.API.ServiceModel.Dtos

        Public Partial Class AccessKeyTypeResponse
            Public Overridable Property Id As Integer
            Public Overridable Property KeyType As String
            Public Overridable Property Description As String
        End Class

        Public Partial Class BookingLogEventTypeResponse
            '''<Summary>
            '''The event type id
            '''</Summary>
            <ApiMember(Description:="The event type id")>
            Public Overridable Property Id As Integer

            '''<Summary>
            '''The event type name
            '''</Summary>
            <ApiMember(Description:="The event type name")>
            Public Overridable Property Name As String

            '''<Summary>
            '''The event type description
            '''</Summary>
            <ApiMember(Description:="The event type description")>
            Public Overridable Property Description As String
        End Class

        <ApiResponse(Description:="You were unauthorized to call this service", StatusCode:=401)>
        <ApiResponse(Description:="You have too low privilegies to call this service", StatusCode:=403)>
        <ValidateRequest(Validator:="IsAuthenticated")>
        Public Partial Class BookingLogQuery
            Inherits QueryDb(Of BookingLog, BookingLogQueryResponse)
            '''<Summary>
            '''Enter the company and booking id you want to see log for, if blank company id and you are an admin, your company id will be used
            '''</Summary>
            <ApiMember(Description:="Enter the company and booking id you want to see log for, if blank company id and you are an admin, your company id will be used", IsRequired:=true, ParameterType:="query")>
            Public Overridable Property CompanyId As Nullable(Of Guid)

            '''<Summary>
            '''Enter the booking id you want to get the log
            '''</Summary>
            <ApiMember(Description:="Enter the booking id you want to get the log", IsRequired:=true, ParameterType:="query")>
            Public Overridable Property BookingId As Integer
        End Class

        Public Partial Class BookingLogQueryResponse
            '''<Summary>
            '''The booking log id
            '''</Summary>
            <ApiMember(Description:="The booking log id")>
            Public Overridable Property Id As Integer

            '''<Summary>
            '''The booking id
            '''</Summary>
            <ApiMember(Description:="The booking id")>
            Public Overridable Property BookingId As Integer

            '''<Summary>
            '''The type of event
            '''</Summary>
            <ApiMember(Description:="The type of event")>
            Public Overridable Property EventTypeId As Integer

            '''<Summary>
            '''The type of event
            '''</Summary>
            <ApiMember(Description:="The type of event")>
            Public Overridable Property EventType As BookingLogEventTypeResponse

            '''<Summary>
            '''Comments that could be added to the event log item
            '''</Summary>
            <ApiMember(Description:="Comments that could be added to the event log item")>
            Public Overridable Property Comments As String

            '''<Summary>
            '''The user created the event
            '''</Summary>
            <ApiMember(Description:="The user created the event")>
            Public Overridable Property UserName As String

            '''<Summary>
            '''Then date when the event occured
            '''</Summary>
            <ApiMember(Description:="Then date when the event occured")>
            Public Overridable Property Created As Date
        End Class
    End Namespace

    Namespace ServiceStack

        <DataContract>
        Public Partial Class QueryBase
            Public Sub New()
                Meta = New Dictionary(Of String, String)
            End Sub

            '''<Summary>
            '''Skip over a given number of elements in a sequence and then return the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?skip=10&orderBy=Id</code>
            '''</Summary>
            <DataMember(Order:=1)>
            Public Overridable Property Skip As Nullable(Of Integer)

            '''<Summary>
            '''Return a given number of elements in a sequence and then skip over the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?take=20</code>
            '''</Summary>
            <DataMember(Order:=2)>
            Public Overridable Property Take As Nullable(Of Integer)

            '''<Summary>
            '''Comma separated list of fields to order by. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderBy=Id,-Age,FirstName</code>
            '''</Summary>
            <DataMember(Order:=3)>
            Public Overridable Property OrderBy As String

            '''<Summary>
            '''Comma separated list of fields to order by in descending order. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderByDesc=Id,-Age,FirstName</code>
            '''</Summary>
            <DataMember(Order:=4)>
            Public Overridable Property OrderByDesc As String

            '''<Summary>
            '''Include any of the aggregates <code>AVG, COUNT, FIRST, LAST, MAX, MIN, SUM</code> in your result set. The results will be returned in the meta field.<br/><br/><strong>Example:</strong><br/><code>?include=COUNT(*) as Total</code><br/><br/>or multiple fields with<br/><code>?include=Count(*) Total, Min(Age), AVG(Age) AverageAge</code><br/></br>or unique with<br/><code>?include=COUNT(DISTINCT LivingStatus) as UniqueStatus</code>
            '''</Summary>
            <DataMember(Order:=5)>
            Public Overridable Property Include As String

            <DataMember(Order:=6)>
            Public Overridable Property Fields As String

            <DataMember(Order:=7)>
            Public Overridable Property Meta As Dictionary(Of String, String)
        End Class

        Public Partial Class QueryDb(Of From, Into)
            Inherits QueryBase
        End Class

        <DataContract>
        Public Partial Class QueryResponse(Of AccessKeyTypeResponse)
            Public Sub New()
                Results = New List(Of AccessKeyTypeResponse)
                Meta = New Dictionary(Of String, String)
            End Sub

            <DataMember(Order:=1)>
            Public Overridable Property Offset As Integer

            <DataMember(Order:=2)>
            Public Overridable Property Total As Integer

            <DataMember(Order:=3)>
            Public Overridable Property Results As List(Of AccessKeyTypeResponse)

            <DataMember(Order:=4)>
            Public Overridable Property Meta As Dictionary(Of String, String)

            <DataMember(Order:=5)>
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET BookingLogQuery 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.

GET /bookinglog HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Offset":0,"Total":0,"Results":[{"Id":0,"BookingId":0,"EventTypeId":0,"EventType":{"Id":0,"Name":"String","Description":"String"},"Comments":"String","UserName":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}