| GET | /news | Find news items for a company |
|---|
// @DataContract
export class QueryBase
{
/** @description 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> */
// @DataMember(Order=1)
public Skip?: number;
/** @description 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> */
// @DataMember(Order=2)
public Take?: number;
/** @description 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> */
// @DataMember(Order=3)
public OrderBy: string;
/** @description 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> */
// @DataMember(Order=4)
public OrderByDesc: string;
/** @description 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> */
// @DataMember(Order=5)
public Include: string;
// @DataMember(Order=6)
public Fields: string;
// @DataMember(Order=7)
public Meta: { [index: string]: string; };
public constructor(init?: Partial<QueryBase>) { (Object as any).assign(this, init); }
}
export class QueryDb<From, Into> extends QueryBase
{
public constructor(init?: Partial<QueryDb<From, Into>>) { super(init); (Object as any).assign(this, init); }
}
export class NewsItemQueryResponse
{
/** @description The news item id */
// @ApiMember(Description="The news item id")
public Id: number;
/** @description Heading of the news item */
// @ApiMember(Description="Heading of the news item")
public Heading: string;
/** @description Body of the news item */
// @ApiMember(Description="Body of the news item")
public Body: string;
/** @description Url to a image associated with the news */
// @ApiMember(Description="Url to a image associated with the news")
public ImageUrl: string;
/** @description The timestamp from which the newsitem should be visible from */
// @ApiMember(Description="The timestamp from which the newsitem should be visible from", IsRequired=true)
public From: string;
/** @description The timestamp to which the newsitem should be visible to */
// @ApiMember(Description="The timestamp to which the newsitem should be visible to", IsRequired=true)
public To: string;
/** @description The timestamp when news was created */
// @ApiMember(Description="The timestamp when news was created", IsRequired=true)
public Created: string;
public ResponseStatus: ResponseStatus;
public constructor(init?: Partial<NewsItemQueryResponse>) { (Object as any).assign(this, init); }
}
export class BaseModel
{
public constructor(init?: Partial<BaseModel>) { (Object as any).assign(this, init); }
}
export class NewsItem extends BaseModel implements IInterval
{
// @Ignore()
public Active: boolean;
// @Required()
public CompanyId: string;
public Id: number;
// @Required()
public Heading: string;
// @Required()
public Body: string;
public ImageUrl: string;
// @Required()
public Updated: string;
// @Required()
public Created: string;
public ModifiedDate?: string;
// @Required()
public From: string;
// @Required()
public To: string;
public constructor(init?: Partial<NewsItem>) { super(init); (Object as any).assign(this, init); }
}
export class NewsItemQuery extends QueryDb<NewsItem, NewsItemQueryResponse>
{
/** @description Enter the company you want to see news for, if blank and you are an admin, your company id will be used */
// @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 CompanyId?: string;
/** @description Enter the From Date you want to see news from, only allowed if admin */
// @ApiMember(DataType="dateTime", Description="Enter the From Date you want to see news from, only allowed if admin", ParameterType="query")
public From?: string;
/** @description Enter the To Date you want to see news to, only allowed if admin */
// @ApiMember(DataType="dateTime", Description="Enter the To Date you want to see news to, only allowed if admin", ParameterType="query")
public To?: string;
/** @description Use this parameter if you want to only show active news */
// @ApiMember(DataType="boolean", Description="Use this parameter if you want to only show active news")
public Active?: boolean;
/** @description The homeage sitepath. */
// @ApiMember(Description="The homeage sitepath.")
public SitePath: string;
/** @description If you want to remove Html tags from newsbody and show as plain text. */
// @ApiMember(Description="If you want to remove Html tags from newsbody and show as plain text.")
public PlainText: boolean;
public constructor(init?: Partial<NewsItemQuery>) { super(init); (Object as any).assign(this, init); }
}
export class AccessKeyTypeResponse
{
public Id: number;
public KeyType: string;
public Description: string;
public constructor(init?: Partial<AccessKeyTypeResponse>) { (Object as any).assign(this, init); }
}
// @DataContract
export class QueryResponse<AccessKeyTypeResponse>
{
// @DataMember(Order=1)
public Offset: number;
// @DataMember(Order=2)
public Total: number;
// @DataMember(Order=3)
public Results: AccessKeyTypeResponse[];
// @DataMember(Order=4)
public Meta: { [index: string]: string; };
// @DataMember(Order=5)
public ResponseStatus: ResponseStatus;
public constructor(init?: Partial<QueryResponse<AccessKeyTypeResponse>>) { (Object as any).assign(this, init); }
}
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: 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,"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"}}}