| GET | /news | Find news items for a company |
|---|
namespace BokaMera.API.ServiceModel.Db
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type NewsItemQueryResponse() =
///<summary>
///The news item id
///</summary>
[<ApiMember(Description="The news item id")>]
member val Id:Int32 = new Int32() with get,set
///<summary>
///Heading of the news item
///</summary>
[<ApiMember(Description="Heading of the news item")>]
member val Heading:String = null with get,set
///<summary>
///Body of the news item
///</summary>
[<ApiMember(Description="Body of the news item")>]
member val Body:String = null with get,set
///<summary>
///Url to a image associated with the news
///</summary>
[<ApiMember(Description="Url to a image associated with the news")>]
member val ImageUrl:Uri = null with get,set
///<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)>]
member val From:DateTime = new DateTime() with get,set
///<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)>]
member val To:DateTime = new DateTime() with get,set
///<summary>
///The timestamp when news was created
///</summary>
[<ApiMember(Description="The timestamp when news was created", IsRequired=true)>]
member val Created:DateTime = new DateTime() with get,set
member val ResponseStatus:ResponseStatus = null with get,set
[<AllowNullLiteral>]
type BaseModel() =
class end
[<AllowNullLiteral>]
type NewsItem() =
inherit BaseModel()
[<Ignore>]
member val Active:Boolean = new Boolean() with get,set
[<Required>]
member val CompanyId:Guid = new Guid() with get,set
member val Id:Int32 = new Int32() with get,set
[<Required>]
member val Heading:String = null with get,set
[<Required>]
member val Body:String = null with get,set
member val ImageUrl:String = null with get,set
[<Required>]
member val Updated:DateTime = new DateTime() with get,set
[<Required>]
member val Created:DateTime = new DateTime() with get,set
member val ModifiedDate:Nullable<DateTimeOffset> = new Nullable<DateTimeOffset>() with get,set
[<Required>]
member val From:DateTime = new DateTime() with get,set
[<Required>]
member val To:DateTime = new DateTime() with get,set
[<AllowNullLiteral>]
type NewsItemQuery() =
inherit QueryDb<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")>]
member val CompanyId:Nullable<Guid> = new Nullable<Guid>() with get,set
///<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")>]
member val From:Nullable<DateTime> = new Nullable<DateTime>() with get,set
///<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")>]
member val To:Nullable<DateTime> = new Nullable<DateTime>() with get,set
///<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")>]
member val Active:Nullable<Boolean> = new Nullable<Boolean>() with get,set
///<summary>
///The homeage sitepath.
///</summary>
[<ApiMember(Description="The homeage sitepath.")>]
member val SitePath:String = null with get,set
///<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.")>]
member val PlainText:Boolean = new Boolean() with get,set
[<DataContract>]
[<AllowNullLiteral>]
type QueryBase() =
///<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)>]
member val Skip:Nullable<Int32> = new Nullable<Int32>() with get,set
///<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)>]
member val Take:Nullable<Int32> = new Nullable<Int32>() with get,set
///<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)>]
member val OrderBy:String = null with get,set
///<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)>]
member val OrderByDesc:String = null with get,set
///<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)>]
member val Include:String = null with get,set
[<DataMember(Order=6)>]
member val Fields:String = null with get,set
[<DataMember(Order=7)>]
member val Meta:Dictionary<String, String> = new Dictionary<String, String>() with get,set
[<AllowNullLiteral>]
type QueryDb<From, Into>() =
inherit QueryBase()
[<AllowNullLiteral>]
type AccessKeyTypeResponse() =
member val Id:Int32 = new Int32() with get,set
member val KeyType:String = null with get,set
member val Description:String = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type QueryResponse<AccessKeyTypeResponse>() =
[<DataMember(Order=1)>]
member val Offset:Int32 = new Int32() with get,set
[<DataMember(Order=2)>]
member val Total:Int32 = new Int32() with get,set
[<DataMember(Order=3)>]
member val Results:ResizeArray<AccessKeyTypeResponse> = new ResizeArray<AccessKeyTypeResponse>() with get,set
[<DataMember(Order=4)>]
member val Meta:Dictionary<String, String> = new Dictionary<String, String>() with get,set
[<DataMember(Order=5)>]
member val ResponseStatus:ResponseStatus = null with get,set
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 /news 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,
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
}
}
}