Wind Site Assessment Dashboard API User Guide

Size: px

Start display at page:

Download "Wind Site Assessment Dashboard API User Guide"

Amanda Lawrence
6 years ago
Views:

1 Wind Site Assessment Dashboard API User Guide Description: The Wind Site Assessment Dashboard API (Application Program Interface) is a REST (or XML-RPC) and human readable web service which provides your web-based or desktop application access to AWS Truepower s wind resource database. Queries are sent to the API system in the form of XML envelopes via HTTPS POST (content- Type=text/xml). The API allows end-user s internal application to send parameters (latitude, longitude, and height) directly to our wind resource database. Values based on these parameters are returned. Requirements: The following conditions must be met in order to utilize the API services: A Wind Site Assessment or Wind Site Assessment Basic subscription. Purchased API Values Your internal application has been configured to make and interpret results from API Calls. Values: API Values can be purchased through the MY Store page of your Wind Site Assessment dashboard. If your API value drops below 1000, a notification is sent alerting you to purchase additional values. Client Info: Your secure API client id, client key and remaining API values can be found on the My Account page of your Wind Site Assessment dashboard. Browser URL s: The API browser URL s for requesting and receiving wind speed, data or turbine information. Speed: Data: Turbine List: Request Parameters: Valid latitude and longitude parameters located within a region your account is subscribed to. Height parameter is between 10 and 100 meters. All heights are expressed in meters. 1

2 Wind Speed: URL: Wind speed values are returned in meters per second (m/s). In the event the system does not have a speed based on your value request parameters, the API will return the location block without a speed value. Sample: Wind Speed Request <servicerequest> <clientid>xxx</clientid> <clientkey>yyy</clientkey> <long> </long> <long> </long> <lat> </lat> <long> </long> </servicerequest> 2

3 Sample: Wind Speed Return Values <serviceresponse> <long> </long> <speed>1.73</speed> <long> </long> <speed>5.29</speed> <lat> </lat> <long> </long> <speed>9.68</speed> <error>0</error> <responsetime> s</responsetime> </serviceresponse> Data: URL: The datalist element and locationlist element must be present in every call. The datalist element and locationlist elements are the two key components of a full input request. Through the Data API you can request the following values. Weibull A : <weiba> Weibull K: <weibk> Elevation: <elev> Air Density: <airdens> Air Temperature: <airtemp> Energy: <energy> Shear Exponent: <shearexp> Wind Rose: <rose> Wind Speed: <speed> Predominant Direction: <predomdir> 3

4 The Wind Speed, Wind Rose and Predominant Direction can be separated out into monthly averages. Wind Speed Wind Rose Predominant Direction speedm1 rosem1 predomdirm1 speedm2 rosem2 predomdirm2 speedm3 rosem3 predomdirm3 speedm4 rosem4 predomdirm4 speedm5 rosem5 predomdirm5 speedm6 rosem6 predomdirm6 speedm7 rosem7 predomdirm7 speedm8 rosem8 predomdirm8 speedm9 rosem9 predomdirm9 speedm10 rosem10 predomdirm10 speedm11 rosem11 predomdirm11 speedm12 rosem12 predomdirm12 M = Month 1-12 is the number of the corresponding month. Example: speedm1 would be the average wind speed for January. 4

5 Sample: Data Value Request Envelopes: <servicerequest> <clientid>xxx</clientid> <clientkey>yyy</clientkey> <datalist> <speed>true</speed> <airtemp>true</airtemp> <elev>true</elev> <weibk>true</weibk> <rose>true</rose> <predomdir>true</predomdir> <predomdirm1>true</predomdirm1> <rosem6>true</rosem6> </datalist> <long> </long> <long> </long> </servicerequest> 5

6 Sample Data Return Values: <serviceresponse> <long> </long> <speed>1.73</speed> <airtemp> </airtemp> <elev>156.4</elev> <weibk>1.869</weibk> <rose><n>0.095</n><nne>0.09</nne><ne>0.077</ne><ene>0.068</ene><e>0.067</e><ese>0.063</ese><se> 0.057</SE><SSE>0.053</SSE><S>0.052</S><SSW>0.048</SSW><SW>0.041</SW><WSW>0.041</WSW><W>0.043 </W><WNW>0.052</WNW><NW>0.068</NW><NNW>0.085</NNW></rose> <predomdir>11.25</predomdir> <predomdirm1>11.25</predomdirm1> <rosem6><n>0.071</n><nne>0.059</nne><ne>0.052</ne><ene>0.053</ene><e>0.064</e><ese>0.058</ese> <SE>0.063</SE><SSE>0.07</SSE><S>0.071</S><SSW>0.062</SSW><SW>0.048</SW><WSW>0.054</WSW><W>0. 06</W><WNW>0.073</WNW><NW>0.074</NW><NNW>0.067</NNW></roseM6> <long> </long> <speed>5.29</speed> <airtemp> </airtemp> <elev>60.0</elev> <weibk>2.156</weibk> <rose><n>0.043</n><nne>0.047</nne><ne>0.057</ne><ene>0.061</ene><e>0.057</e><ese>0.055</ese><se >0.067</SE><SSE>0.103</SSE><S>0.127</S><SSW>0.102</SSW><SW>0.065</SW><WSW>0.042</WSW><W>0.03 4</W><WNW>0.04</WNW><NW>0.05</NW><NNW>0.047</NNW></rose> <predomdir>191.25</predomdir> <predomdirm1>191.25</predomdirm1> <rosem6><n>0.033</n><nne>0.037</nne><ne>0.044</ne><ene>0.068</ene><e>0.071</e><ese>0.078</ese> <SE>0.091</SE><SSE>0.12</SSE><S>0.131</S><SSW>0.124</SSW><SW>0.076</SW><WSW>0.034</WSW><W>0. 021</W><WNW>0.022</WNW><NW>0.023</NW><NNW>0.027</NNW></roseM6> <error>0</error> <responsetime> s</responsetime> </serviceresponse> 6

7 Energy: The energy component can also be requested through the data API. Request Parameters for Energy: The turbine ID: A special API request can be called that returns all of AWS Truepower s turbine manufacturing data, including the AWS Truepower turbine ID number. URL: Sample Turbine Manufacture Request Envelope: <servicerequest> <clientid>xxx</clientid> <clientkey>yyy</clientkey> </servicerequest> This request will bring back a list of all of AWS Truepower s turbine manufacturing data. This data set is large and will most likely need to be parsed. Once the turbine Id is determined you can add it to your data request as follows. URL: Sample Energy Value Request Envelopes: <servicerequest> <clientid>xxx</clientid> <clientkey>yyy</clientkey> <datalist> <energy>true</energy> </datalist> <long> </long> <turbine_id>23</turbine_id> <long> </long> <turbine_id>36</turbine_id> 7

8 </servicerequest> Sample Energy Return Values: <serviceresponse> <long> </long> <turbine_id>23</turbine_id> <energy>269.72</energy> <long> </long> <turbine_id>36</turbine_id> <energy> </energy> <error>0</error> <responsetime> s</responsetime> </serviceresponse> Sample Return Errors: Your API account has been disabled o In the event of account termination/disabling. Please check that your API Client Key and Client ID are correct. o For incorrect credentials. Please include a locationlist entry o In the event of a malformed request envelope. The maximum number of points to query is o In the event that too many points are queried at once. You have exhausted your quota of API calls o In the event that you have exhausted your calls. All heights must be between 10 and 100 o In the event that you have specified an invalid height. Not Subscribed o The Lat/Long provided is not in a region you are subscribed to. You have not enabled your API account o Purchasing API values is required. 8

9 More Information: This document is a brief overview of AWS Truepower s Wind Site Assessment Dashboard API, its functionality, and sample value request envelopes. If you have any questions please feel free to contact our customer service department at: dashboards@awstruepower.com or *AWS Truepower cannot provide specific development support for setting up your internal API configurations for your application. 9

User Guide. Table of Contents How it Works Data & Maps Wind Resource Grid Time Series Reports For More Questions

User Guide. Table of Contents How it Works Data & Maps Wind Resource Grid Time Series Reports For More Questions User Guide All information in this document is subject to change without notice. This document is provided for informational purposes only and AWS Truepower, a UL company, makes no guarantees, representations