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 .csv suffix or ?format=csv

HTTP + CSV

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.build.exanic.ch 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"news":[{"id":0,"validFrom":"0001-01-01T00:00:00.0000000","title":"String","isActive":false}],"totalEntities":0,"page":0,"pageSize":0,"property":"String","isAscending":false}