| GET | /news | Find news items for a company |
|---|
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BokaMera.API.ServiceModel.Dtos;
using BokaMera.API.ServiceModel.Db;
namespace BokaMera.API.ServiceModel.Db
{
public partial class BaseModel
{
}
public partial class NewsItem
: BaseModel, IInterval
{
[Ignore]
public virtual bool Active { get; set; }
[Required]
public virtual Guid CompanyId { get; set; }
public virtual int Id { get; set; }
[Required]
public virtual string Heading { get; set; }
[Required]
public virtual string Body { get; set; }
public virtual string? ImageUrl { get; set; }
[Required]
public virtual DateTime Updated { get; set; }
[Required]
public virtual DateTime Created { get; set; }
public virtual DateTimeOffset? ModifiedDate { get; set; }
[Required]
public virtual DateTime From { get; set; }
[Required]
public virtual DateTime To { get; set; }
}
}
namespace BokaMera.API.ServiceModel.Dtos
{
public partial class AccessKeyTypeResponse
{
public virtual int Id { get; set; }
public virtual string KeyType { get; set; }
public virtual string Description { get; set; }
}
public partial class NewsItemQuery
: 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")]
public virtual Guid? CompanyId { 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")]
public virtual DateTime? From { 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")]
public virtual DateTime? To { 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")]
public virtual bool? Active { get; set; }
///<summary>
///The homeage sitepath.
///</summary>
[ApiMember(Description="The homeage sitepath.")]
public virtual string SitePath { 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.")]
public virtual bool PlainText { get; set; }
}
public partial class NewsItemQueryResponse
{
///<summary>
///The news item id
///</summary>
[ApiMember(Description="The news item id")]
public virtual int Id { get; set; }
///<summary>
///Heading of the news item
///</summary>
[ApiMember(Description="Heading of the news item")]
public virtual string Heading { get; set; }
///<summary>
///Body of the news item
///</summary>
[ApiMember(Description="Body of the news item")]
public virtual string Body { get; set; }
///<summary>
///Url to a image associated with the news
///</summary>
[ApiMember(Description="Url to a image associated with the news")]
public virtual Uri ImageUrl { 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)]
public virtual DateTime From { 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)]
public virtual DateTime To { get; set; }
///<summary>
///The timestamp when news was created
///</summary>
[ApiMember(Description="The timestamp when news was created", IsRequired=true)]
public virtual DateTime Created { get; set; }
public virtual ResponseStatus ResponseStatus { get; set; }
}
}
namespace ServiceStack
{
[DataContract]
public partial class QueryBase
{
[DataMember(Order=1)]
public virtual int? Skip { get; set; }
[DataMember(Order=2)]
public virtual int? Take { get; set; }
[DataMember(Order=3)]
public virtual string? OrderBy { get; set; }
[DataMember(Order=4)]
public virtual string? OrderByDesc { get; set; }
[DataMember(Order=5)]
public virtual string? Include { get; set; }
[DataMember(Order=6)]
public virtual string? Fields { get; set; }
[DataMember(Order=7)]
public virtual Dictionary<string, string>? Meta { get; set; }
}
public partial class QueryDb<From, Into>
: QueryBase
{
}
[DataContract]
public partial class QueryResponse<T>
{
[DataMember(Order=1)]
public virtual int Offset { get; set; }
[DataMember(Order=2)]
public virtual int Total { get; set; }
[DataMember(Order=3)]
public virtual List<AccessKeyTypeResponse> Results { get; set; } = [];
[DataMember(Order=4)]
public virtual Dictionary<string, string>? Meta { get; set; }
[DataMember(Order=5)]
public virtual ResponseStatus? ResponseStatus { get; set; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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: application/json
HTTP/1.1 200 OK
Content-Type: application/json
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"}}}