heilog.ch.Api

<back to all web services

GetAssortmentRequest

The following routes are available for this service:
GET/assortment
GetAssortmentRequest Parameters:
NameParameterData TypeRequiredDescription
EssenceNamequerystringNo
ProductGroupqueryProductGroup?No
AssortmentStatequeryAssortmentState?No
IncludeHiddenEssencesqueryboolNo
ForRecipeWizardqueryboolNo
PropertyquerystringNo
IsAscendingqueryboolNo
PageSizequeryintNo
PagequeryintNo
ProductGroup Enum:
NameValue
Spagyric1
Herbs3
Tinctures4
MineralSolution6
LMPotency7
Custom9
BudExtract10
AssortmentState Enum:
NameValue
InStock1
NotInStock2
GetAssortmentResponse Parameters:
NameParameterData TypeRequiredDescription
AssortmentListformList<AssortmentItemDto>No
PropertyformstringNo
IsAscendingformboolNo
TotalEntitiesformlongNo
AssortmentItemDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
ChargeNoformstringNo
ExpiryDateformDateTime?No
SignatureformstringNo
InStockformboolNo
EssenceformEssenceDtoNo
EssenceDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
EthanolformdoubleNo
ProductGroupformProductGroupNo
IsActiveformboolNo
NameformstringNo
SummaryformstringNo
ContraIndicationformstringNo

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

{"assortmentList":[{"id":0,"chargeNo":"String","expiryDate":"0001-01-01T00:00:00.0000000","signature":"String","inStock":false,"essence":{"id":0,"ethanol":0,"productGroup":1,"isActive":false,"name":"String","summary":"String","contraIndication":"String"}}],"property":"String","isAscending":false,"totalEntities":0}