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

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<AssetAvailabilityGetRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bazefield.Allocations.WebService">
  <AllocationCategoriesFilter xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </AllocationCategoriesFilter>
  <From>String</From>
  <InObjectTime>false</InObjectTime>
  <SourceIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </SourceIds>
  <To>String</To>
  <TurbineIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </TurbineIds>
  <Type>String</Type>
</AssetAvailabilityGetRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AssetAvailabilityGetResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bazefield.Allocations.WebService">
  <ContractualAvailability xmlns:d2p1="http://schemas.datacontract.org/2004/07/Bazefield.Allocations.DataModel.Entities">
    <d2p1:TurbineAvailabilityStats>
      <d2p1:Availability>0</d2p1:Availability>
      <d2p1:TurbineId>0</d2p1:TurbineId>
      <d2p1:TurbineName>String</d2p1:TurbineName>
    </d2p1:TurbineAvailabilityStats>
  </ContractualAvailability>
  <TechnicalAvailability xmlns:d2p1="http://schemas.datacontract.org/2004/07/Bazefield.Allocations.DataModel.Entities">
    <d2p1:TurbineAvailabilityStats>
      <d2p1:Availability>0</d2p1:Availability>
      <d2p1:TurbineId>0</d2p1:TurbineId>
      <d2p1:TurbineName>String</d2p1:TurbineName>
    </d2p1:TurbineAvailabilityStats>
  </TechnicalAvailability>
</AssetAvailabilityGetResponse>