heilog.ch.Api

<back to all web services

GetRecipesRequest

The following routes are available for this service:
GET/recipe
GetRecipesRequest Parameters:
NameParameterData TypeRequiredDescription
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 .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 HTTP/1.1 
Host: heidak-api.test.exanic.ch 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	recipes: 
	[
		{
			recipeId: 0,
			createdUtc: 0001-01-01,
			title: String,
			customerName: String,
			illness: String,
			legacyChargeNr: String,
			signature: String,
			pharmacistId: 0,
			ownerId: 0,
			isVisible: False,
			recipeState: 0,
			canPrintLabel: False,
			hasProtocol: False
		}
	],
	totalEntities: 0,
	page: 0,
	pageSize: 0,
	property: String,
	isAscending: False
}