heilog.ch.Api

<back to all web services

UpdateProtocolRequest

The following routes are available for this service:
PUT/recipe/{RecipeId/protocol}
UpdateProtocolRequest Parameters:
NameParameterData TypeRequiredDescription
RecipeIdbodylongNo
ProtocolbodyCreateRecipeProtocolDtoNo
CreateRecipeProtocolDto Parameters:
NameParameterData TypeRequiredDescription
ProtocolIngredientsformList<ProtocolIngredientDto>No
BottlingTypeformBottlingTypeNo
SignatureformstringNo
ManufacturedByGuidelineformboolNo
HygieneInstructionsFollowedformboolNo
CleaningInstructionsFollowedformboolNo
ManufactureInstructionsFollowedformboolNo
UnitsformintNo
SingleSizeformintNo
DripBottleChargeNoformstringNo
ProtocolSignatureformstringNo
UnitOfMeasureformstringNo
ProtocolIngredientDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
EssenceIdformlongNo
EssenceNameformstringNo
ProductGroupformProductGroupNo
EthanolformfloatNo
ExpiryDateformDateTime?No
ChargeNoformstringNo
SymptomformstringNo
IsAmountformdecimalNo
ShouldAmountformdecimalNo
ProductGroup Enum:
NameValue
Spagyric1
Herbs3
Tinctures4
MineralSolution6
LMPotency7
Custom9
BudExtract10
BottlingType Enum:
NameValue
AdHoc1
Bulk2

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.

PUT /recipe/{RecipeId/protocol} HTTP/1.1 
Host: heidak-api.test.exanic.ch 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateProtocolRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/heilog.ch.Api.ServiceModel.Recipe">
  <Protocol xmlns:d2p1="http://schemas.datacontract.org/2004/07/heilog.ch.Api.Dto.Recipe">
    <d2p1:BottlingType>AdHoc</d2p1:BottlingType>
    <d2p1:CleaningInstructionsFollowed>false</d2p1:CleaningInstructionsFollowed>
    <d2p1:DripBottleChargeNo>String</d2p1:DripBottleChargeNo>
    <d2p1:HygieneInstructionsFollowed>false</d2p1:HygieneInstructionsFollowed>
    <d2p1:ManufactureInstructionsFollowed>false</d2p1:ManufactureInstructionsFollowed>
    <d2p1:ManufacturedByGuideline>false</d2p1:ManufacturedByGuideline>
    <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:Signature>String</d2p1:Signature>
    <d2p1:SingleSize>0</d2p1:SingleSize>
    <d2p1:UnitOfMeasure>String</d2p1:UnitOfMeasure>
    <d2p1:Units>0</d2p1:Units>
  </Protocol>
  <RecipeId>0</RecipeId>
</UpdateProtocolRequest>