| Requires any of the roles: | bookingsupplier-administrator-write, bookingsupplier-administrator-read, superadmin |
| GET | /bookings/reports/ | Get all reports | Get a list of all existing reports. |
|---|
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 BookingPrintout
Inherits BaseModel
<Required>
Public Overridable Property CompanyId As Guid
Public Overridable Property Id As Integer
<Required>
Public Overridable Property Name As String
Public Overridable Property HeaderLeftCell As String
Public Overridable Property HeaderMiddleCell As String
Public Overridable Property HeaderRightCell As String
<Required>
Public Overridable Property BodyCell As String
Public Overridable Property FooterLeftCell As String
Public Overridable Property FooterMiddleCell As String
Public Overridable Property FooterRightCell As String
Public Overridable Property ModifiedDate As Nullable(Of DateTimeOffset)
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 BookingPrintoutQueryResponse
'''<Summary>
'''Report id
'''</Summary>
<ApiMember(Description:="Report id")>
Public Overridable Property Id As Integer
'''<Summary>
'''Report Name
'''</Summary>
<ApiMember(Description:="Report Name")>
Public Overridable Property Name As String
'''<Summary>
'''Report header left cell content
'''</Summary>
<ApiMember(Description:="Report header left cell content", IsRequired:=true)>
Public Overridable Property HeaderLeftCell As String
'''<Summary>
'''Report header middle cell content
'''</Summary>
<ApiMember(Description:="Report header middle cell content", IsRequired:=true)>
Public Overridable Property HeaderMiddleCell As String
'''<Summary>
'''Report header right cell content
'''</Summary>
<ApiMember(Description:="Report header right cell content", IsRequired:=true)>
Public Overridable Property HeaderRightCell As String
'''<Summary>
'''Report body cell content
'''</Summary>
<ApiMember(Description:="Report body cell content", IsRequired:=true)>
Public Overridable Property BodyCell As String
'''<Summary>
'''Report footer left cell content
'''</Summary>
<ApiMember(Description:="Report footer left cell content", IsRequired:=true)>
Public Overridable Property FooterLeftCell As String
'''<Summary>
'''Report footer middle cell content
'''</Summary>
<ApiMember(Description:="Report footer middle cell content", IsRequired:=true)>
Public Overridable Property FooterMiddleCell As String
'''<Summary>
'''Report footer right cell content
'''</Summary>
<ApiMember(Description:="Report footer right cell content", IsRequired:=true)>
Public Overridable Property FooterRightCell As String
End Class
<ValidateRequest(Validator:="IsAuthenticated")>
Public Partial Class ReportQuery
Inherits QueryDb(Of BookingPrintout, BookingPrintoutQueryResponse)
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 Nullable(Of Guid)
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
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /bookings/reports/ 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,"Name":"String","HeaderLeftCell":"String","HeaderMiddleCell":"String","HeaderRightCell":"String","BodyCell":"String","FooterLeftCell":"String","FooterMiddleCell":"String","FooterRightCell":"String"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}