GET /system/weather/locations/{locationID}/
Use this resource to obtain the weather service configuration for a given location ID.
This resource will return the information related to the weather location.
Used when you are operating a browser without access to the header parameter. This allows you to choose which encoding you want to use for the response:
All these resources can be used according what the resource allows.
To address the raw value of a primitive property, clients append a path segment containing the string $value to the property URL.
To use this query option you need to use the classic resource and add the element name you want to print followed by the query string name.
<span class="warning"><span class="glyphicon glyphicon-warning-sign" aria-hidden="true"> Be careful, the parameter query string is used in the URL and is not like other parameters.
The $select system query option allows clients to request a limited set of properties for each entity.
The value pass in the parameter can be:
If there is no value after the select query option, the parameter will be ignored. All the values that are not specified will not be printed in the response.
If this parameter is not in the request, the Application/Json will be chosen by default.
There are multiple possible values (according the resource):
The first two are the most often used.
This is the ID of the location.
Currently only one location is supported. The only ID available is 1.
Object Name: Location
| Property Name | Type | Description | Method |
|---|---|---|---|
| Longitude | String | The longitude of the selected city. | GET POST |
| Latitude | String | The latitude of the selected city. | GET POST |
| Ll | String | This is the Latitude and Longitude, in that order. The two values must be separated with a space or a comma. | GET POST |
| Enabled | String | True to enable the Weather functionality. | GET POST |
| Name | String | Name of the selected city. | GET |
| Key | String | Key representing the selected city. | GET POST |
URL Example: https://0.0.0.0/api/rest/v1/system/weather/locations/1
{
"enabled": true,
"latitude": "39.802",
"longitude": "-89.644",
"ll": "39.802,-89.644",
"key": "328763",
"Name": "Springfield, IL, US"
}
URL Example: https://0.0.0.0/api/rest/v1/system/weather/locations/1
<?xml version="1.0" encoding="utf-8"?>
<Location>
<Enabled>false</Enabled>
<Latitude>39.802</Latitude>
<Longitude>-89.644</Longitude>
<Ll>39.802,-89.644</Ll>
<Key>328763</Key>
<Name>Springfield, IL, US</Name>
</Location>