heilog.ch.Api

<back to all web services

LoadRecipeByIdRequest

The following routes are available for this service:
GET/recipe/{RecipeId}
LoadRecipeByIdRequest Parameters:
NameParameterData TypeRequiredDescription
RecipeIdpathlongNo
LoadRecipeByIdResponse Parameters:
NameParameterData TypeRequiredDescription
RecipeformCreateRecipeDtoNo
CustomerformCustomerPreviewDtoNo
IllnessformIllnessPreviewDtoNo
PartnershipformPartnershipDetailDtoNo
CreateRecipeDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
CustomerIdformlong?No
IngredientsformList<IngredientDto>No
ProtocolIngredientsformList<ProtocolIngredientDto>No
IllnessIdformlong?No
TargetTypeformTargetTypeNo
BottlingTypeformBottlingTypeNo
CommentformstringNo
SignatureformstringNo
RecipeStateformRecipeStateNo
PharmacistIdformlong?No
ManufacturedByGuidelineformboolNo
HygieneInstructionsFollowedformboolNo
CleaningInstructionsFollowedformboolNo
ManufactureInstructionsFollowedformboolNo
UnitsformintNo
SingleSizeformintNo
DripBottleChargeNoformstringNo
ProtocolSignatureformstringNo
LabelLanguageformLanguageCodeNo
LabelTypeformLabelTypeNo
TitleformstringNo
UsageformstringNo
IllnessformstringNo
CustomerPrefixformstringNo
CustomerNameformstringNo
IngredientPrefixformstringNo
IngredientTextformstringNo
DosagePrefixformstringNo
DosageTextformstringNo
EmulsionTextformstringNo
EthanolTextformstringNo
StorageTextformstringNo
ChargeNrPrefixformstringNo
AmountPrefixformstringNo
PricePrefixformstringNo
BarcodeformstringNo
PriceformfloatNo
ManufacturedPrefixformstringNo
BestUntilPrefixformstringNo
BestUntilformDateTime?No
ManufacturedformDateTimeNo
UnitOfMeasureformstringNo
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
ProtocolIngredientDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
EssenceIdformlongNo
EssenceNameformstringNo
ProductGroupformProductGroupNo
EthanolformfloatNo
ExpiryDateformDateTime?No
ChargeNoformstringNo
SymptomformstringNo
IsAmountformdecimalNo
ShouldAmountformdecimalNo
TargetType Enum:
NameValue
Human1
Animal2
BottlingType Enum:
NameValue
AdHoc1
Bulk2
RecipeState Enum:
NameValue
Draft0
RecipeSentToPartner1
Printed2
UnusedPartnerRecipe3
LanguageCode Enum:
NameValue
de1
fr2
it3
LabelType Enum:
NameValue
SpagyricsHuman1
Tea2
SpagyricsAnimal3
Emulsion4
Tincture5
Homeopathie6
BudExtract7
Empty8
CustomerPreviewDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
FirstNameformstringNo
LastNameformstringNo
StreetformstringNo
ZipformstringNo
PlaceformstringNo
IllnessPreviewDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
NameformstringNo
PartnershipDetailDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
PharmacyIdformlongNo
PharmacyformPartnershipPharmacyDtoNo
TherapistIdformlongNo
TherapistformPartnershipTherapistDtoNo
MessageformstringNo
PartnershipStatusformPartnershipStatusNo
PartnershipPharmacyDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
EmailformstringNo
PhoneNumberformstringNo
FirstNameformstringNo
LastNameformstringNo
CompanyformstringNo
AddressformstringNo
CityformstringNo
PostalCodeformstringNo
IsStandardPharmacistformboolNo
PartnershipTherapistDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
EmailformstringNo
PhoneNumberformstringNo
FirstNameformstringNo
LastNameformstringNo
CompanyformstringNo
AddressformstringNo
CityformstringNo
PostalCodeformstringNo
PartnershipStatus Enum:
NameValue
Requested1
Accepted2
Terminated4
Withdrawn8
Declined16
Inactive28

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/{RecipeId} HTTP/1.1 
Host: heidak-api.test.exanic.ch 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<LoadRecipeByIdResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/heilog.ch.Api.ServiceModel.Recipe">
  <Customer xmlns:d2p1="http://schemas.datacontract.org/2004/07/heilog.ch.Api.Dto.Customer">
    <d2p1:FirstName>String</d2p1:FirstName>
    <d2p1:Id>0</d2p1:Id>
    <d2p1:LastName>String</d2p1:LastName>
    <d2p1:Place>String</d2p1:Place>
    <d2p1:Street>String</d2p1:Street>
    <d2p1:Zip>String</d2p1:Zip>
  </Customer>
  <Illness xmlns:d2p1="http://schemas.datacontract.org/2004/07/heilog.ch.Api.Dto.Illness">
    <d2p1:Id>0</d2p1:Id>
    <d2p1:Name>String</d2p1:Name>
  </Illness>
  <Partnership xmlns:d2p1="http://schemas.datacontract.org/2004/07/heilog.ch.Api.Dto.Partnership">
    <d2p1:Id>0</d2p1:Id>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:PartnershipStatus>Requested</d2p1:PartnershipStatus>
    <d2p1:Pharmacy>
      <d2p1:Address>String</d2p1:Address>
      <d2p1:City>String</d2p1:City>
      <d2p1:Company>String</d2p1:Company>
      <d2p1:Email>String</d2p1:Email>
      <d2p1:FirstName>String</d2p1:FirstName>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:IsStandardPharmacist>false</d2p1:IsStandardPharmacist>
      <d2p1:LastName>String</d2p1:LastName>
      <d2p1:PhoneNumber>String</d2p1:PhoneNumber>
      <d2p1:PostalCode>String</d2p1:PostalCode>
    </d2p1:Pharmacy>
    <d2p1:PharmacyId>0</d2p1:PharmacyId>
    <d2p1:Therapist>
      <d2p1:Address>String</d2p1:Address>
      <d2p1:City>String</d2p1:City>
      <d2p1:Company>String</d2p1:Company>
      <d2p1:Email>String</d2p1:Email>
      <d2p1:FirstName>String</d2p1:FirstName>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:LastName>String</d2p1:LastName>
      <d2p1:PhoneNumber>String</d2p1:PhoneNumber>
      <d2p1:PostalCode>String</d2p1:PostalCode>
    </d2p1:Therapist>
    <d2p1:TherapistId>0</d2p1:TherapistId>
  </Partnership>
  <Recipe xmlns:d2p1="http://schemas.datacontract.org/2004/07/heilog.ch.Api.Dto.Recipe">
    <d2p1:AmountPrefix>String</d2p1:AmountPrefix>
    <d2p1:Barcode>String</d2p1:Barcode>
    <d2p1:BestUntil>0001-01-01T00:00:00</d2p1:BestUntil>
    <d2p1:BestUntilPrefix>String</d2p1:BestUntilPrefix>
    <d2p1:BottlingType>AdHoc</d2p1:BottlingType>
    <d2p1:ChargeNrPrefix>String</d2p1:ChargeNrPrefix>
    <d2p1:CleaningInstructionsFollowed>false</d2p1:CleaningInstructionsFollowed>
    <d2p1:Comment>String</d2p1:Comment>
    <d2p1:CustomerId>0</d2p1:CustomerId>
    <d2p1:CustomerName>String</d2p1:CustomerName>
    <d2p1:CustomerPrefix>String</d2p1:CustomerPrefix>
    <d2p1:DosagePrefix>String</d2p1:DosagePrefix>
    <d2p1:DosageText>String</d2p1:DosageText>
    <d2p1:DripBottleChargeNo>String</d2p1:DripBottleChargeNo>
    <d2p1:EmulsionText>String</d2p1:EmulsionText>
    <d2p1:EthanolText>String</d2p1:EthanolText>
    <d2p1:HygieneInstructionsFollowed>false</d2p1:HygieneInstructionsFollowed>
    <d2p1:Id>0</d2p1:Id>
    <d2p1:Illness>String</d2p1:Illness>
    <d2p1:IllnessId>0</d2p1:IllnessId>
    <d2p1:IngredientPrefix>String</d2p1:IngredientPrefix>
    <d2p1:IngredientText>String</d2p1:IngredientText>
    <d2p1:Ingredients xmlns:d3p1="http://schemas.datacontract.org/2004/07/heilog.ch.Api.Dto.Ingredient">
      <d3p1:IngredientDto>
        <d3p1:Amount>0</d3p1:Amount>
        <d3p1:ChargeNo>String</d3p1:ChargeNo>
        <d3p1:ContraIndication>String</d3p1:ContraIndication>
        <d3p1:EssenceId>0</d3p1:EssenceId>
        <d3p1:EssenceName>String</d3p1:EssenceName>
        <d3p1:Ethanol>0</d3p1:Ethanol>
        <d3p1:ExpiryDate>0001-01-01T00:00:00</d3p1:ExpiryDate>
        <d3p1:IsAvailable>false</d3p1:IsAvailable>
        <d3p1:ProductGroup>Spagyric</d3p1:ProductGroup>
        <d3p1:Symptom>String</d3p1:Symptom>
      </d3p1:IngredientDto>
    </d2p1:Ingredients>
    <d2p1:LabelLanguage>de</d2p1:LabelLanguage>
    <d2p1:LabelType>SpagyricsHuman</d2p1:LabelType>
    <d2p1:ManufactureInstructionsFollowed>false</d2p1:ManufactureInstructionsFollowed>
    <d2p1:Manufactured>0001-01-01T00:00:00</d2p1:Manufactured>
    <d2p1:ManufacturedByGuideline>false</d2p1:ManufacturedByGuideline>
    <d2p1:ManufacturedPrefix>String</d2p1:ManufacturedPrefix>
    <d2p1:PharmacistId>0</d2p1:PharmacistId>
    <d2p1:Price>0</d2p1:Price>
    <d2p1:PricePrefix>String</d2p1:PricePrefix>
    <d2p1:ProtocolIngredients xmlns:d3p1="http://schemas.datacontract.org/2004/07/heilog.ch.Api.Dto.Ingredient">
      <d3p1:ProtocolIngredientDto>
        <d3p1:ChargeNo>String</d3p1:ChargeNo>
        <d3p1:EssenceId>0</d3p1:EssenceId>
        <d3p1:EssenceName>String</d3p1:EssenceName>
        <d3p1:Ethanol>0</d3p1:Ethanol>
        <d3p1:ExpiryDate>0001-01-01T00:00:00</d3p1:ExpiryDate>
        <d3p1:Id>0</d3p1:Id>
        <d3p1:IsAmount>0</d3p1:IsAmount>
        <d3p1:ProductGroup>Spagyric</d3p1:ProductGroup>
        <d3p1:ShouldAmount>0</d3p1:ShouldAmount>
        <d3p1:Symptom>String</d3p1:Symptom>
      </d3p1:ProtocolIngredientDto>
    </d2p1:ProtocolIngredients>
    <d2p1:ProtocolSignature>String</d2p1:ProtocolSignature>
    <d2p1:RecipeState>Draft</d2p1:RecipeState>
    <d2p1:Signature>String</d2p1:Signature>
    <d2p1:SingleSize>0</d2p1:SingleSize>
    <d2p1:StorageText>String</d2p1:StorageText>
    <d2p1:TargetType>Human</d2p1:TargetType>
    <d2p1:Title>String</d2p1:Title>
    <d2p1:UnitOfMeasure>String</d2p1:UnitOfMeasure>
    <d2p1:Units>0</d2p1:Units>
    <d2p1:Usage>String</d2p1:Usage>
  </Recipe>
</LoadRecipeByIdResponse>