BokaMera.API.Host

NewsItemQuery

The following routes are available for this service:
GET	/news	Find news items for a company

**NewsItemQuery** Parameters:
Name	Parameter	Data Type	Required	Description
CompanyId	query	Guid?	No	Enter the company you want to see news for, if blank and you are an admin, your company id will be used
From	query	dateTime	No	Enter the From Date you want to see news from, only allowed if admin
To	query	dateTime	No	Enter the To Date you want to see news to, only allowed if admin
Active	query	boolean	No	Use this parameter if you want to only show active news
SitePath	query	string	No	The homeage sitepath.
PlainText	query	bool	No	If you want to remove Html tags from newsbody and show as plain text.

**QueryBase** Parameters:
Name	Parameter	Data Type	Required	Description
Skip	query	int	No	Skip over a given number of elements in a sequence and then return the remainder. Use this when you need paging. Example: `?skip=10&orderBy=Id`
Take	query	int	No	Return a given number of elements in a sequence and then skip over the remainder. Use this when you need paging. Example: `?take=20`
OrderBy	query	string	No	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. Example: `?orderBy=Id,-Age,FirstName`
OrderByDesc	query	string	No	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. Example: `?orderByDesc=Id,-Age,FirstName`
Include	query	string	No	Include any of the aggregates `AVG, COUNT, FIRST, LAST, MAX, MIN, SUM` in your result set. The results will be returned in the meta field. Example: `?include=COUNT() as Total` or multiple fields with `?include=Count() Total, Min(Age), AVG(Age) AverageAge` or unique with `?include=COUNT(DISTINCT LivingStatus) as UniqueStatus`
Fields	form	string	No
Meta	form	Dictionary<string, string>	No

**NewsItem** Parameters:
Name	Parameter	Data Type	Required
Active	form	bool	No
CompanyId	form	Guid	Yes
Id	form	int	No
Heading	form	string	Yes
Body	form	string	Yes
ImageUrl	form	string	No
Updated	form	DateTime	Yes
Created	form	DateTime	Yes
ModifiedDate	form	DateTimeOffset?	No
From	form	DateTime	Yes
To	form	DateTime	Yes

**NewsItemQueryResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	int	No	The news item id
Heading	form	string	No	Heading of the news item
Body	form	string	No	Body of the news item
ImageUrl	form	Uri	No	Url to a image associated with the news
From	form	DateTime	Yes	The timestamp from which the newsitem should be visible from
To	form	DateTime	Yes	The timestamp to which the newsitem should be visible to
Created	form	DateTime	Yes	The timestamp when news was created
ResponseStatus	form	ResponseStatus	No

**QueryResponse<AccessKeyTypeResponse>** Parameters:
Name	Parameter	Data Type	Required
Offset	form	int	No
Total	form	int	No
Results	form	List<AccessKeyTypeResponse>	No
Meta	form	Dictionary<string, string>	No
ResponseStatus	form	ResponseStatus	No

**AccessKeyTypeResponse** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
KeyType	form	string	No
Description	form	string	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + 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
		}
	}
}