| Requires any of the roles: | bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read |
| GET | /messages/dashboard | Search the dashboard messages for any messages. | Search the dashboard messages for any messages. |
|---|
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 DashboardMessage
Inherits BaseModel
<References(GetType(DashboardMessageType))>
Public Overridable Property MessageTypeId As Integer
Public Overridable Property MessageType As DashboardMessageType
<Required>
Public Overridable Property CompanyId As Guid
Public Overridable Property Id As Integer
<Required>
Public Overridable Property Title As String
<Required>
Public Overridable Property Body As String
<Required>
Public Overridable Property Important As Boolean
<Required>
Public Overridable Property VisibleFrom As Date
<Required>
Public Overridable Property VisibleTo As Date
<Required>
Public Overridable Property Created As Date
Public Overridable Property SupportCaseId As Nullable(Of Integer)
Public Overridable Property ModifiedDate As Nullable(Of DateTimeOffset)
End Class
Public Partial Class DashboardMessageType
Inherits BaseModel
<Required>
Public Overridable Property Name As String
<Required>
Public Overridable Property Description As String
<Required>
Public Overridable Property Image As String
Public Overridable Property ApplicationMessage As Nullable(Of Boolean)
<Required>
Public Overridable Property Color As String
<Required>
Public Overridable Property Icon As String
Public Overridable Property ModifiedDate As Nullable(Of DateTimeOffset)
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 DasboardMessageTypeResponse
'''<Summary>
'''The message type id
'''</Summary>
<ApiMember(Description:="The message type id")>
Public Overridable Property Id As Integer
'''<Summary>
'''The message type name
'''</Summary>
<ApiMember(Description:="The message type name")>
Public Overridable Property Name As String
'''<Summary>
'''The message type description
'''</Summary>
<ApiMember(Description:="The message type description")>
Public Overridable Property Description As String
'''<Summary>
'''The message type image
'''</Summary>
<ApiMember(Description:="The message type image")>
Public Overridable Property ImageUrl As String
'''<Summary>
'''If the message type is a application message
'''</Summary>
<ApiMember(Description:="If the message type is a application message")>
Public Overridable Property ApplicationMessage As Nullable(Of Boolean)
'''<Summary>
'''The message type icon
'''</Summary>
<ApiMember(Description:="The message type icon")>
Public Overridable Property Icon As String
'''<Summary>
'''The message type color
'''</Summary>
<ApiMember(Description:="The message type color")>
Public Overridable Property Color As String
End Class
<ApiResponse(Description:="You were unauthorized to call this service", StatusCode:=401)>
<ValidateRequest(Validator:="IsAuthenticated")>
Public Partial Class DashboardMessageQuery
Inherits QueryDb(Of DashboardMessage, DashboardMessageQueryResponse)
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.", ParameterType:="path")>
Public Overridable Property CompanyId As Nullable(Of Guid)
'''<Summary>
'''If you want to filter on important messages only
'''</Summary>
<ApiMember(DataType:="boolean", Description:="If you want to filter on important messages only", ParameterType:="query")>
Public Overridable Property Important As Nullable(Of Boolean)
'''<Summary>
'''Filter on Message Type Id
'''</Summary>
<ApiMember(DataType:="int", Description:="Filter on Message Type Id", ParameterType:="query")>
Public Overridable Property MessageTypeId As Nullable(Of Integer)
'''<Summary>
'''If you want to include the message type information
'''</Summary>
<ApiMember(DataType:="boolean", Description:="If you want to include the message type information", ParameterType:="query")>
Public Overridable Property IncludeMessageTypeInformation As Boolean
Public Overridable Property ResponseStatus As ResponseStatus
End Class
Public Partial Class DashboardMessageQueryResponse
'''<Summary>
'''The message id
'''</Summary>
<ApiMember(Description:="The message id")>
Public Overridable Property Id As Integer
'''<Summary>
'''The message title.
'''</Summary>
<ApiMember(Description:="The message title.")>
Public Overridable Property Title As String
'''<Summary>
'''The message body.
'''</Summary>
<ApiMember(Description:="The message body.")>
Public Overridable Property Body As String
'''<Summary>
'''If the message is important.
'''</Summary>
<ApiMember(Description:="If the message is important.")>
Public Overridable Property Important As Boolean
'''<Summary>
'''If the message visible from date.
'''</Summary>
<ApiMember(Description:="If the message visible from date.")>
Public Overridable Property VisibleFrom As Date
'''<Summary>
'''If the message visible to date.
'''</Summary>
<ApiMember(Description:="If the message visible to date.")>
Public Overridable Property VisibleTo As Date
'''<Summary>
'''If the message created date.
'''</Summary>
<ApiMember(Description:="If the message created date.")>
Public Overridable Property Created As Date
'''<Summary>
'''If the message type id.
'''</Summary>
<ApiMember(Description:="If the message type id.")>
Public Overridable Property MessageTypeId As Integer
'''<Summary>
'''If the message is connected to a support case.
'''</Summary>
<ApiMember(Description:="If the message is connected to a support case.")>
Public Overridable Property SupportCaseId As Nullable(Of Integer)
'''<Summary>
'''If the message type information.
'''</Summary>
<ApiMember(Description:="If the message type information.")>
Public Overridable Property MessageType As DasboardMessageTypeResponse
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 DashboardMessageQuery DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /messages/dashboard HTTP/1.1 Host: api.bokamera.se Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Offset: 0,
Total: 0,
Results:
[
{
Id: 0,
Title: String,
Body: String,
Important: False,
MessageTypeId: 0,
SupportCaseId: 0,
MessageType:
{
Id: 0,
Name: String,
Description: String,
ImageUrl: String,
ApplicationMessage: False,
Icon: String,
Color: String
}
}
],
Meta:
{
String: String
},
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}