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