BazeField Services

<back to all web services

AssetAvailabilityGetRequest

Allocations API
Requires Authentication
The following routes are available for this service:
GET,POST/api/turbines/allocations/statistics/assetavailability
AssetAvailabilityGetRequest Parameters:
NameParameterData TypeRequiredDescription
TurbineIdsbodyList<string>No
SourceIdsbodyList<string>No
TypebodystringNo
FrombodystringNo
TobodystringNo
AllocationCategoriesFilterbodyList<string>No
InObjectTimebodybool?No
AssetAvailabilityGetResponse Parameters:
NameParameterData TypeRequiredDescription
ContractualAvailabilityformList<TurbineAvailabilityStats>No
TechnicalAvailabilityformList<TurbineAvailabilityStats>No
TurbineAvailabilityStats Parameters:
NameParameterData TypeRequiredDescription
TurbineIdformintNo
TurbineNameformstringNo
AvailabilityformdoubleNo

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/turbines/allocations/statistics/assetavailability HTTP/1.1 
Host: mdn.bazefield.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	turbineIds: 
	[
		String
	],
	sourceIds: 
	[
		String
	],
	type: String,
	from: String,
	to: String,
	allocationCategoriesFilter: 
	[
		String
	],
	inObjectTime: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	contractualAvailability: 
	[
		{
			turbineId: 0,
			turbineName: String,
			availability: 0
		}
	],
	technicalAvailability: 
	[
		{
			turbineId: 0,
			turbineName: String,
			availability: 0
		}
	]
}