heilog.ch.Api

<back to all web services

GetSupportItemsRequest

The following routes are available for this service:
GET/support-item
GetSupportItemsRequest Parameters:
NameParameterData TypeRequiredDescription
SupportCategoryquerySupportCategoryNo
UseIsActivequeryboolNo
UseUserLanguagequeryboolNo
PageSizequeryintNo
PagequeryintNo
PropertyquerystringNo
IsAscendingqueryboolNo
SupportCategory Enum:
NameValue
QSS1
Flyer2
Manual3
GetSupportItemsResponse Parameters:
NameParameterData TypeRequiredDescription
SupportItemsformList<SupportItemDto>No
TotalEntitiesformlongNo
PageformintNo
PageSizeformintNo
PropertyformstringNo
IsAscendingformboolNo
SupportItemDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
IsActiveformboolNo
CategoryformSupportCategoryNo
TypeformSupportTypeNo
PositionformuintNo
TitleformstringNo
URLformstringNo
SupportType Enum:
NameValue
Document1
Video2

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 /support-item HTTP/1.1 
Host: heidak-api.test.exanic.ch 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetSupportItemsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/heilog.ch.Api.ServiceModel.SupportItem">
  <IsAscending>false</IsAscending>
  <Page>0</Page>
  <PageSize>0</PageSize>
  <Property>String</Property>
  <SupportItems xmlns:d2p1="http://schemas.datacontract.org/2004/07/heilog.ch.Api.Dto.Support">
    <d2p1:SupportItemDto>
      <d2p1:Category>QSS</d2p1:Category>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:IsActive>false</d2p1:IsActive>
      <d2p1:Position>0</d2p1:Position>
      <d2p1:Title>String</d2p1:Title>
      <d2p1:Type>Document</d2p1:Type>
      <d2p1:URL>String</d2p1:URL>
    </d2p1:SupportItemDto>
  </SupportItems>
  <TotalEntities>0</TotalEntities>
</GetSupportItemsResponse>