heilog.ch.Api

GetEssencesRequest

The following routes are available for this service:
All Verbs	/essences

**GetEssencesRequest** Parameters:
Name	Parameter	Data Type	Required
ProductGroup	query	ProductGroup?	No
Name	query	string	No
IsActive	query	bool?	No
Property	query	string	No
IsAscending	query	bool	No
PageSize	query	int	No
Page	query	int	No

**ProductGroup** Enum:
Name	Value
Spagyric	1
Herbs	3
Tinctures	4
MineralSolution	6
LMPotency	7
Custom	9
BudExtract	10

**GetEssencesResponse** Parameters:
Name	Parameter	Data Type	Required
Essences	form	List<EssenceListItemDto>	No
TotalEntities	form	long	No
Page	form	int	No
Property	form	string	No
IsAscending	form	bool	No
PageSize	form	int	No

**EssenceListItemDto** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
Name	form	string	No
ProductGroup	form	ProductGroup	No
IsActive	form	bool	No

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.

POST /essences HTTP/1.1 
Host: heidak-api.build.exanic.ch 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	productGroup: 0,
	name: String,
	isActive: False,
	property: String,
	isAscending: False,
	pageSize: 0,
	page: 0
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	essences: 
	[
		{
			id: 0,
			name: String,
			productGroup: 1,
			isActive: False
		}
	],
	totalEntities: 0,
	page: 0,
	property: String,
	isAscending: False,
	pageSize: 0
}