BazeField Services

AllocationStatisticsListGetRequest

Allocations API

The following routes are available for this service:
GET, POST	/api/allocations/statistics/list	Gets allocation statistics for objects/categories.

**AllocationStatisticsListGetRequest** Parameters:
Name	Parameter	Data Type	Required
TurbineIds	body	List<string>	No
ObjectIds	body	List<string>	No
Categories	body	List<string>	No
AllocationType	body	string	No
From	body	string	No
To	body	string	No
ResultsInKWh	body	bool?	No
GroupResults	body	bool?	No
GroupByObjects	body	bool?	No
GroupByCategories	body	bool?	No
IntervalSec	body	int?	No
IncludeNegativeProduction	body	bool?	No
IncludeNegativeLostProduction	body	bool?	No
ShowExcluded	body	bool?	No
ShowAvailable	body	bool?	No
Available	body	bool?	No
GroupByLabel	body	bool?	No
GroupByLabelAndCategories	body	bool?	No
GroupByAlarm	body	bool?	No
GroupByAsset	body	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 /api/allocations/statistics/list HTTP/1.1 
Host: mdn.bazefield.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	turbineIds: 
	[
		String
	],
	objectIds: 
	[
		String
	],
	categories: 
	[
		String
	],
	allocationType: String,
	from: String,
	to: String,
	resultsInKWh: False,
	groupResults: False,
	groupByObjects: False,
	groupByCategories: False,
	intervalSec: 0,
	includeNegativeProduction: False,
	includeNegativeLostProduction: False,
	showExcluded: False,
	showAvailable: False,
	available: False,
	groupByLabel: False,
	groupByLabelAndCategories: False,
	groupByAlarm: False,
	groupByAsset: False
}

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

[
	{
		objectKey: String,
		objectId: String,
		turbineId: 0,
		categoryId: 0,
		alarmCode: String,
		timeStamp: 0001-01-01,
		pba: 0,
		tba: 0,
		totalPBA: 0,
		totalTBA: 0,
		totalLostProd: 0,
		totalLostProdCurrency: 0,
		unavailableLostProd: 0,
		unavailableLostProdCurrency: 0,
		excludedLostProd: 0,
		excludedLostProdCurrency: 0,
		totalActualProd: 0,
		totalActualProdCurrency: 0,
		excludedActualProd: 0,
		excludedActualProdCurrency: 0,
		totalTheoreticalProd: 0,
		totalTheoreticalProdCurrency: 0,
		excludedTheoreticalProd: 0,
		exludedTheoreticalProdCurrency: 0,
		totalDuration: 0,
		reportedDuration: 0,
		unavailableDuration: 0,
		totalUnavailableDuration: 0,
		totalLossDuration: 0,
		excludedDuration: 0,
		totalCount: 0,
		excludedCount: 0,
		unavailablecount: 0,
		totalUnavailableCount: 0,
		totalLossCount: 0,
		averagePrice: 0,
		assetCount: 0,
		label: String,
		parameter1: String,
		vendorEventType: String,
		description: String
	}
]