Child pages
  • Solargis API User Guide

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

element namedataDeliveryRequest
defined inhttp://solargis.info/schema/ws-data.xsd
descriptionThe root element of the XML request is the <dataDeliveryRequest> with required attributes 'dateFrom' and 'dateTo' for setting desired data period in the response. Accepted is a date string in the form of  ''YYYY-mm-dd" e.g., "2017-09-30". It is assumed UTC (GMT+00) time zone for both dates unless otherwise specified by the <timeZone> element of the <processing>. 
contentrequired one <site> , required one <processing>
@dateFrom*start of the data period, ''YYYY-mm-dd"
@dateTo*end of the data period, ''YYYY-mm-dd"

Explanation of the table above: The element name is that what you can see in the XML request. If the element is of simple type, the content is a literal (text or number), otherwise the content can be list of another <element> or none. Attribute of the element is prefixed by '@' character. Required attribute is marked by '*' character.

Note

Size of time period in one XML request is limited to 31 days regardless of summarization attribute.


Processing

element nameprocessing
defined inhttp://solargis.info/schema/data-request.xsd
descriptionComplex element with instructions about how response should be generated.
contentoptional one <timeZone>, optional one <timestampType>
@summarization*required, time frequency in the response. One of YEARLY, MONTHLY, DAILY, HOURLY, MIN_30, MIN_15, MIN_10, MIN_5
@key*required, text value, output data parameters separated by white space. Example: key="GHI GTI TEMP WS PVOUT". See below table for all supported parameters.
@terrainShadingoptional, boolean, if 'true', the distant horizon taken from SRTM data is considered, default is 'false' (no horizon obstructions at all), Note: a user can also apply custom horizon data by providing <horizon> element within the <site> element

...