GET v2/weather-stations.{ext}?activeOnly={activeOnly}&ranchGuid={ranchGuid}
Return all weather stations in the database
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
activeOnly |
when true, only return active weather stations |
boolean |
Default value is False |
ranchGuid |
when not null, data includes distance to ranch. |
globally unique identifier |
None. |
Body Parameters
None.
Response Information
Resource Description
Collection of WeatherStationViewModelName | Description | Type | Additional information |
---|---|---|---|
Id |
Record ID |
integer |
None. |
Name |
Name |
string |
Required |
External_Id |
CIMIS code |
string |
Required |
API_Id |
API ID |
string |
None. |
NearestCity |
Nearest city |
string |
Required |
County |
County |
string |
Required |
Coordinates |
Coordinates |
string |
Required |
Lat |
Latitude |
decimal number |
None. |
Lng |
Longitude |
decimal number |
None. |
Distance |
distance from ranch |
decimal number |
None. |
UcIpmName |
UC IPM Name |
string |
Required |
WeatherAPI_Id |
Weather API ID |
integer |
None. |
Active |
Active status |
boolean |
None. |
AllowToDeactivate | boolean |
None. |
|
AllowToDelete | boolean |
None. |
|
RegionId |
Region ID |
integer |
None. |
RegionName |
Name of region |
string |
None. |
MissingRecords |
Number of station data missing for the current year |
integer |
None. |
Response Formats
application/json, text/json, text/html
[ { "Id": 1, "Name": "sample string 2", "External_Id": "sample string 3", "API_Id": "sample string 4", "NearestCity": "sample string 5", "County": "sample string 6", "Coordinates": "sample string 7", "Lat": 1.1, "Lng": 1.1, "Distance": 1.0, "UcIpmName": "sample string 8", "WeatherAPI_Id": 9, "Active": true, "AllowToDeactivate": true, "AllowToDelete": true, "RegionId": 13, "RegionName": "sample string 14", "MissingRecords": 1 }, { "Id": 1, "Name": "sample string 2", "External_Id": "sample string 3", "API_Id": "sample string 4", "NearestCity": "sample string 5", "County": "sample string 6", "Coordinates": "sample string 7", "Lat": 1.1, "Lng": 1.1, "Distance": 1.0, "UcIpmName": "sample string 8", "WeatherAPI_Id": 9, "Active": true, "AllowToDeactivate": true, "AllowToDelete": true, "RegionId": 13, "RegionName": "sample string 14", "MissingRecords": 1 } ]
application/xml, text/xml
<ArrayOfWeatherStationViewModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <WeatherStationViewModel> <Id>1</Id> <Name>sample string 2</Name> <External_Id>sample string 3</External_Id> <API_Id>sample string 4</API_Id> <NearestCity>sample string 5</NearestCity> <County>sample string 6</County> <Coordinates>sample string 7</Coordinates> <Lat>1.1</Lat> <Lng>1.1</Lng> <Distance>1</Distance> <UcIpmName>sample string 8</UcIpmName> <WeatherAPI_Id>9</WeatherAPI_Id> <Active>true</Active> <AllowToDeactivate>true</AllowToDeactivate> <AllowToDelete>true</AllowToDelete> <RegionId>13</RegionId> <RegionName>sample string 14</RegionName> <MissingRecords>1</MissingRecords> </WeatherStationViewModel> <WeatherStationViewModel> <Id>1</Id> <Name>sample string 2</Name> <External_Id>sample string 3</External_Id> <API_Id>sample string 4</API_Id> <NearestCity>sample string 5</NearestCity> <County>sample string 6</County> <Coordinates>sample string 7</Coordinates> <Lat>1.1</Lat> <Lng>1.1</Lng> <Distance>1</Distance> <UcIpmName>sample string 8</UcIpmName> <WeatherAPI_Id>9</WeatherAPI_Id> <Active>true</Active> <AllowToDeactivate>true</AllowToDeactivate> <AllowToDelete>true</AllowToDelete> <RegionId>13</RegionId> <RegionName>sample string 14</RegionName> <MissingRecords>1</MissingRecords> </WeatherStationViewModel> </ArrayOfWeatherStationViewModel>