heilog.ch.Api

<back to all web services

GetAvailableRecipeTemplatesRequest

The following routes are available for this service:
GET/recipe/template/query
GetAvailableRecipeTemplatesRequest Parameters:
NameParameterData TypeRequiredDescription
IllnessIdquerylong?No
GetAvailableRecipeTemplatesResponse Parameters:
NameParameterData TypeRequiredDescription
RecipeTemplatesformList<RecipeTemplateDto>No
RecipeTemplateDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
NameformstringNo
UseRecipeTemplateNameForLabelformboolNo
CreatedAtformDateTimeNo
TargetTypeformTargetTypeNo
IngredientsformList<IngredientDto>No
IndicationformstringNo
IllnessIdformlong?No
TargetType Enum:
NameValue
Human1
Animal2
IngredientDto Parameters:
NameParameterData TypeRequiredDescription
EssenceIdformlongNo
EssenceNameformstringNo
ProductGroupformProductGroupNo
EthanolformfloatNo
ContraIndicationformstringNo
IsAvailableformboolNo
ExpiryDateformDateTime?No
ChargeNoformstringNo
SymptomformstringNo
AmountformdecimalNo
ProductGroup Enum:
NameValue
Spagyric1
Herbs3
Tinctures4
MineralSolution6
LMPotency7
Custom9
BudExtract10

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

{
	recipeTemplates: 
	[
		{
			id: 0,
			name: String,
			useRecipeTemplateNameForLabel: False,
			createdAt: 0001-01-01,
			targetType: 1,
			ingredients: 
			[
				{
					essenceId: 0,
					essenceName: String,
					productGroup: 1,
					ethanol: 0,
					contraIndication: String,
					isAvailable: False,
					expiryDate: 0001-01-01,
					chargeNo: String,
					symptom: String,
					amount: 0
				}
			],
			indication: String,
			illnessId: 0
		}
	]
}