Skip to content

Latest commit

 

History

History
184 lines (132 loc) · 8.45 KB

ClimatologyDailyHighTemperatureApi.md

File metadata and controls

184 lines (132 loc) · 8.45 KB
Raw

Swagger\Client\ClimatologyDailyHighTemperatureApi

All URIs are relative to https://insight.api.wdtinc.com

Method HTTP request Description
climoDailyHighTemperatureByAsset GET /climatology/daily-high-temperature/{asset-uuid} Climatology Daily High Temperature by asset
climoDailyHighTemperatureByLocation GET /climatology/daily-high-temperature/{latitude}/{longitude} Climatology Daily High Temperature by location
climoDailyHighTemperatureContoursByAsset GET /climatology/daily-high-temperature/{asset-uuid}/contours Climatology Daily High Temperature contours by asset

climoDailyHighTemperatureByAsset

\Swagger\Client\Model\DailyProductByAssetData climoDailyHighTemperatureByAsset($asset_uuid, $start, $end, $years, $unit)

Climatology Daily High Temperature by asset

Provides a daily climatological time series for high temperature within a user-defined timespan at the centroid of an asset, along with the area-weighted arithmetic mean and range of temperature over that asset. Time series values are for the centroid of the asset. The default response contains results on a Celsius temperature scale for 30 year climatological results based on the current day.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\ClimatologyDailyHighTemperatureApi();
$asset_uuid = 1.2; // double | Unique asset id.
$start = new \DateTime("2013-10-20"); // \DateTime | Start date. A valid ISO 8601 month and day (MM-DD)
$end = new \DateTime("2013-10-20"); // \DateTime | End date (inclusive). A valid ISO 8601 month and day (MM-DD)
$years = 1.2; // double | number of years for aggregation
$unit = "unit_example"; // string | temperature unit

try {
    $result = $api_instance->climoDailyHighTemperatureByAsset($asset_uuid, $start, $end, $years, $unit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ClimatologyDailyHighTemperatureApi->climoDailyHighTemperatureByAsset: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
asset_uuid double Unique asset id.
start \DateTime Start date. A valid ISO 8601 month and day (MM-DD) [optional]
end \DateTime End date (inclusive). A valid ISO 8601 month and day (MM-DD) [optional]
years double number of years for aggregation [optional]
unit string temperature unit [optional]

Return type

\Swagger\Client\Model\DailyProductByAssetData

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/vnd.wdt+json; version=1

[Back to top] [Back to API list] [Back to Model list] [Back to README]

climoDailyHighTemperatureByLocation

\Swagger\Client\Model\DailyProductByLocationData climoDailyHighTemperatureByLocation($latitude, $longitude, $start, $end, $years, $unit)

Climatology Daily High Temperature by location

Provides a daily climatological high temperature time series within a user-defined timespan at a specific location. The location is represented by a latitude/longitude pair. The default response contains results on a Celsius temperature scale for 30 year climatological results based on the current day.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\ClimatologyDailyHighTemperatureApi();
$latitude = 1.2; // double | 
$longitude = 1.2; // double | 
$start = new \DateTime("2013-10-20"); // \DateTime | Start date. a valid ISO 8601 month and day (MM-DD)
$end = new \DateTime("2013-10-20"); // \DateTime | End date (inclusive). a valid ISO 8601 month and day (MM-DD)
$years = 1.2; // double | number of years for aggregation
$unit = "unit_example"; // string | temperature unit

try {
    $result = $api_instance->climoDailyHighTemperatureByLocation($latitude, $longitude, $start, $end, $years, $unit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ClimatologyDailyHighTemperatureApi->climoDailyHighTemperatureByLocation: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
latitude double
longitude double
start \DateTime Start date. a valid ISO 8601 month and day (MM-DD) [optional]
end \DateTime End date (inclusive). a valid ISO 8601 month and day (MM-DD) [optional]
years double number of years for aggregation [optional]
unit string temperature unit [optional]

Return type

\Swagger\Client\Model\DailyProductByLocationData

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/vnd.wdt+json; version=1

[Back to top] [Back to API list] [Back to Model list] [Back to README]

climoDailyHighTemperatureContoursByAsset

\Swagger\Client\Model\DailyHighTemperatureContoursByAssetData climoDailyHighTemperatureContoursByAsset($asset_uuid, $start, $end, $years, $unit)

Climatology Daily High Temperature contours by asset

Provides a contoured representation (GeoJSON) of climatological high temperatures over a date range, clipped to an asset boundary. The default response contains results on a Celsius temperature scale for climatological results based on the current day.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: basicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Swagger\Client\Api\ClimatologyDailyHighTemperatureApi();
$asset_uuid = 1.2; // double | Unique asset id.
$start = new \DateTime("2013-10-20"); // \DateTime | Start date. A valid ISO 8601 month and day (MM-DD)
$end = new \DateTime("2013-10-20"); // \DateTime | End date (inclusive). A valid ISO 8601 month and day (MM-DD)
$years = 1.2; // double | number of years for aggregation
$unit = "unit_example"; // string | temperature unit

try {
    $result = $api_instance->climoDailyHighTemperatureContoursByAsset($asset_uuid, $start, $end, $years, $unit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ClimatologyDailyHighTemperatureApi->climoDailyHighTemperatureContoursByAsset: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
asset_uuid double Unique asset id.
start \DateTime Start date. A valid ISO 8601 month and day (MM-DD) [optional]
end \DateTime End date (inclusive). A valid ISO 8601 month and day (MM-DD) [optional]
years double number of years for aggregation [optional]
unit string temperature unit [optional]

Return type

\Swagger\Client\Model\DailyHighTemperatureContoursByAssetData

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/vnd.wdt+json; version=1

[Back to top] [Back to API list] [Back to Model list] [Back to README]