heilog.ch.Api

<back to all web services

GetPartnerRecipesRequest

The following routes are available for this service:
GET/recipe/partner
GetPartnerRecipesRequest Parameters:
NameParameterData TypeRequiredDescription
TherapistIdquerylongNo
PageSizequeryintNo
PagequeryintNo
PropertyquerystringNo
IsAscendingqueryboolNo
CustomerquerystringNo
IndicationquerystringNo
ChargeNrquerystringNo
IncludeHiddenRecipesqueryboolNo
GetRecipesResponse Parameters:
NameParameterData TypeRequiredDescription
RecipesformList<RecipeOverviewDto>No
TotalEntitiesformlongNo
PageformintNo
PageSizeformintNo
PropertyformstringNo
IsAscendingformboolNo
RecipeOverviewDto Parameters:
NameParameterData TypeRequiredDescription
RecipeIdformlongNo
CreatedUtcformDateTimeNo
TitleformstringNo
CustomerNameformstringNo
IllnessformstringNo
LegacyChargeNrformstringNo
SignatureformstringNo
PharmacistIdformlong?No
OwnerIdformlongNo
IsVisibleformboolNo
RecipeStateformRecipeStateNo
CanPrintLabelformboolNo
HasProtocolformboolNo
RecipeState Enum:
NameValue
Draft0
RecipeSentToPartner1
Printed2
UnusedPartnerRecipe3

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

<GetRecipesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/heilog.ch.Api.ServiceModel.Recipe">
  <IsAscending>false</IsAscending>
  <Page>0</Page>
  <PageSize>0</PageSize>
  <Property>String</Property>
  <Recipes xmlns:d2p1="http://schemas.datacontract.org/2004/07/heilog.ch.Api.Dto.Recipe">
    <d2p1:RecipeOverviewDto>
      <d2p1:CanPrintLabel>false</d2p1:CanPrintLabel>
      <d2p1:CreatedUtc>0001-01-01T00:00:00</d2p1:CreatedUtc>
      <d2p1:CustomerName>String</d2p1:CustomerName>
      <d2p1:HasProtocol>false</d2p1:HasProtocol>
      <d2p1:Illness>String</d2p1:Illness>
      <d2p1:IsVisible>false</d2p1:IsVisible>
      <d2p1:LegacyChargeNr>String</d2p1:LegacyChargeNr>
      <d2p1:OwnerId>0</d2p1:OwnerId>
      <d2p1:PharmacistId>0</d2p1:PharmacistId>
      <d2p1:RecipeId>0</d2p1:RecipeId>
      <d2p1:RecipeState>Draft</d2p1:RecipeState>
      <d2p1:Signature>String</d2p1:Signature>
      <d2p1:Title>String</d2p1:Title>
    </d2p1:RecipeOverviewDto>
  </Recipes>
  <TotalEntities>0</TotalEntities>
</GetRecipesResponse>