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 .csv suffix or ?format=csv

HTTP + CSV

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/csv
Content-Type: text/csv
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/csv
Content-Length: length

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