heilog.ch.Api

<back to all web services

GetNewsRequest

The following routes are available for this service:
GET/news
GetNewsRequest Parameters:
NameParameterData TypeRequiredDescription
SearchStringquerystringNo
IsActivequerybool?No
PropertyquerystringNo
IsAscendingqueryboolNo
PageSizequeryintNo
PagequeryintNo
GetNewsResponse Parameters:
NameParameterData TypeRequiredDescription
NewsformList<NewsListItemDto>No
TotalEntitiesformlongNo
PageformintNo
PageSizeformintNo
PropertyformstringNo
IsAscendingformboolNo
NewsListItemDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
ValidFromformDateTimeNo
TitleformstringNo
IsActiveformboolNo

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: heidak-api.test.exanic.ch 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	news: 
	[
		{
			id: 0,
			validFrom: 0001-01-01,
			title: String,
			isActive: False
		}
	],
	totalEntities: 0,
	page: 0,
	pageSize: 0,
	property: String,
	isAscending: False
}