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

HTTP + XML

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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetNewsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/heilog.ch.Api.ServiceModel.News">
  <IsAscending>false</IsAscending>
  <News xmlns:d2p1="http://schemas.datacontract.org/2004/07/heilog.ch.Api.Dto.News">
    <d2p1:NewsListItemDto>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:IsActive>false</d2p1:IsActive>
      <d2p1:Title>String</d2p1:Title>
      <d2p1:ValidFrom>0001-01-01T00:00:00</d2p1:ValidFrom>
    </d2p1:NewsListItemDto>
  </News>
  <Page>0</Page>
  <PageSize>0</PageSize>
  <Property>String</Property>
  <TotalEntities>0</TotalEntities>
</GetNewsResponse>