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

HTTP + JSV

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

{
	assortmentList: 
	[
		{
			id: 0,
			chargeNo: String,
			expiryDate: 0001-01-01,
			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
}