| GET | /news | Find news items for a company |
|---|
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 NewsItem
Inherits BaseModel
Implements IInterval
<Ignore>
Public Overridable Property Active As Boolean
<Required>
Public Overridable Property CompanyId As Guid
Public Overridable Property Id As Integer
<Required>
Public Overridable Property Heading As String
<Required>
Public Overridable Property Body As String
Public Overridable Property ImageUrl As String
<Required>
Public Overridable Property Updated As Date
<Required>
Public Overridable Property Created As Date
Public Overridable Property ModifiedDate As Nullable(Of DateTimeOffset)
<Required>
Public Overridable Property From As Date
<Required>
Public Overridable Property To As Date
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 NewsItemQuery
Inherits QueryDb(Of NewsItem, NewsItemQueryResponse)
'''<Summary>
'''Enter the company you want to see news for, if blank and you are an admin, your company id will be used
'''</Summary>
<ApiMember(Description:="Enter the company you want to see news for, if blank and you are an admin, your company id will be used", ParameterType:="query")>
Public Overridable Property CompanyId As Nullable(Of Guid)
'''<Summary>
'''Enter the From Date you want to see news from, only allowed if admin
'''</Summary>
<ApiMember(DataType:="dateTime", Description:="Enter the From Date you want to see news from, only allowed if admin", ParameterType:="query")>
Public Overridable Property From As Nullable(Of Date)
'''<Summary>
'''Enter the To Date you want to see news to, only allowed if admin
'''</Summary>
<ApiMember(DataType:="dateTime", Description:="Enter the To Date you want to see news to, only allowed if admin", ParameterType:="query")>
Public Overridable Property To As Nullable(Of Date)
'''<Summary>
'''Use this parameter if you want to only show active news
'''</Summary>
<ApiMember(DataType:="boolean", Description:="Use this parameter if you want to only show active news")>
Public Overridable Property Active As Nullable(Of Boolean)
'''<Summary>
'''The homeage sitepath.
'''</Summary>
<ApiMember(Description:="The homeage sitepath.")>
Public Overridable Property SitePath As String
'''<Summary>
'''If you want to remove Html tags from newsbody and show as plain text.
'''</Summary>
<ApiMember(Description:="If you want to remove Html tags from newsbody and show as plain text.")>
Public Overridable Property PlainText As Boolean
End Class
Public Partial Class NewsItemQueryResponse
'''<Summary>
'''The news item id
'''</Summary>
<ApiMember(Description:="The news item id")>
Public Overridable Property Id As Integer
'''<Summary>
'''Heading of the news item
'''</Summary>
<ApiMember(Description:="Heading of the news item")>
Public Overridable Property Heading As String
'''<Summary>
'''Body of the news item
'''</Summary>
<ApiMember(Description:="Body of the news item")>
Public Overridable Property Body As String
'''<Summary>
'''Url to a image associated with the news
'''</Summary>
<ApiMember(Description:="Url to a image associated with the news")>
Public Overridable Property ImageUrl As Uri
'''<Summary>
'''The timestamp from which the newsitem should be visible from
'''</Summary>
<ApiMember(Description:="The timestamp from which the newsitem should be visible from", IsRequired:=true)>
Public Overridable Property From As Date
'''<Summary>
'''The timestamp to which the newsitem should be visible to
'''</Summary>
<ApiMember(Description:="The timestamp to which the newsitem should be visible to", IsRequired:=true)>
Public Overridable Property To As Date
'''<Summary>
'''The timestamp when news was created
'''</Summary>
<ApiMember(Description:="The timestamp when news was created", IsRequired:=true)>
Public Overridable Property Created As Date
Public Overridable Property ResponseStatus As ResponseStatus
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 /news HTTP/1.1 Host: testapi.bokamera.se Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"Offset":0,"Total":0,"Results":[{"Id":0,"Heading":"String","Body":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}