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

<GetAvailableRecipeTemplatesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/heilog.ch.Api.ServiceModel.Recipe.Template">
  <RecipeTemplates xmlns:d2p1="http://schemas.datacontract.org/2004/07/heilog.ch.Api.Dto.Recipe">
    <d2p1:RecipeTemplateDto>
      <d2p1:CreatedAt>0001-01-01T00:00:00</d2p1:CreatedAt>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:IllnessId>0</d2p1:IllnessId>
      <d2p1:Indication>String</d2p1:Indication>
      <d2p1:Ingredients xmlns:d4p1="http://schemas.datacontract.org/2004/07/heilog.ch.Api.Dto.Ingredient">
        <d4p1:IngredientDto>
          <d4p1:Amount>0</d4p1:Amount>
          <d4p1:ChargeNo>String</d4p1:ChargeNo>
          <d4p1:ContraIndication>String</d4p1:ContraIndication>
          <d4p1:EssenceId>0</d4p1:EssenceId>
          <d4p1:EssenceName>String</d4p1:EssenceName>
          <d4p1:Ethanol>0</d4p1:Ethanol>
          <d4p1:ExpiryDate>0001-01-01T00:00:00</d4p1:ExpiryDate>
          <d4p1:IsAvailable>false</d4p1:IsAvailable>
          <d4p1:ProductGroup>Spagyric</d4p1:ProductGroup>
          <d4p1:Symptom>String</d4p1:Symptom>
        </d4p1:IngredientDto>
      </d2p1:Ingredients>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:TargetType>Human</d2p1:TargetType>
      <d2p1:UseRecipeTemplateNameForLabel>false</d2p1:UseRecipeTemplateNameForLabel>
    </d2p1:RecipeTemplateDto>
  </RecipeTemplates>
</GetAvailableRecipeTemplatesResponse>