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

{"supportItems":[{"id":0,"isActive":false,"category":1,"type":1,"position":0,"title":"String","url":"String"}],"totalEntities":0,"page":0,"pageSize":0,"property":"String","isAscending":false}