Data Methods
30 Year Central Tendencies Methods
Metadata Methods
Forecast Metadata and Forecast Value Methods
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Parameter |
Type |
Description |
|
*stationTriplet |
String |
The three-part station identifier of the reservoir station for which to get the metadata. |
Example usage:
stationTriplet=”14080400:OR:BOR”
This will return a reservoir capacity of 153,000 acre-feet for this station (PRINEVILLE) in Oregon.
getReservoirMetadataMultiple
Retrieves metadata for several reservoir stations in a single call. The reservoir metadata for each station indicate the capacity, usable capacity, and the elevation (in feet) of the reservoir when it is at capacity. (Note: The AWDB database currently only has the reservoir capacity populated.)
Returns: A list of ReservoirMetadataobjects that contain the reservoir metadata for each station requested in the order of the requested stations.
Parameters:
|
Parameter |
Type |
Description |
|
*stationTriplets |
List<String> |
A list of the three-part station identifiers of the reservoir stations for which to get the metadata. |
Example usage:
stationTriplets[0]= ”14080400:OR:BOR” // Reservoir station PRINEVILLE
stationTriplets[1]= “14361900:OR:BOR” // Reservoir station APPLEGATE
This will return a reservoir capacity of 153,000 acre-feet for this station (PRINEVILLE) in Oregon and 75,200 acre-feet for APPLEGATE.
getStations
Gets a list of stations that match one or more search criteria. Stations can be searched by station ids, names, states, networks, HUC, latitude, longitude, elevation, county, element, and more. The method returns the three-part station identifiers (“station triplets”) that are used to make calls to other methods to retrieve data or metadata for the stations.
Returns: A list of strings that are the stationTriplets for the stations which match the search criteria passed in.
Parameters: All are optional unless marked as required with an ‘*’
|
Parameter |
Type |
Description |
|
stationIds |
List<String> |
A list of station ids or station names (can contain wildcards ‘*’ or ‘?’). |
|
stateCds |
List<String> |
A list of two-character FIPS state codes of the states to search stations in. |
|
networkCds |
List<String> |
A list of network codes of the stations for which to search. |
|
hucs |
List<String> |
A list of Hydrologic Unit Codes (HUCs) of the stations for which to search. This includes an implied wildcard (*) at the end of each HUC. For example, if a user searches for a station with the HUC "17010101", it will get all stations whose HUC begins with "17010101". |
|
countyNames |
List<String> |
A list of county names that the stations are in. The county names can contain the ‘*’ and ‘?’ wildcards. |
|
minLatitude |
BigDecimal |
The minimum latitude (in decimal degrees) of the stations to find (inclusive) |
|
maxLatitude |
BigDecimal |
The maximum latitude (in decimal degrees) of the stations to find (inclusive) |
|
minLongitude |
BigDecimal |
The minimum longitude (in decimal degrees) of the stations to find (inclusive) |
|
maxLongitude |
BigDecimal |
The maximum longitude (in decimal degrees) of the stations to find (inclusive) |
|
minElevation |
BigDecimal |
The minimum elevation (in feet) of the stations to find (inclusive). |
|
maxElevation |
BigDecimal |
The maximum elevation (in feet) of the stations to find (inclusive). |
|
elementCd |
List<String> |
A list of element codes of the elements for which the stations have some data. The element codes can contain wildcards. |
|
ordinals |
List<Integer> |
A list of the ordinals of the elements the stations must have. The ordinal is a number that starts at 1 and is used to distinguish multiple sensors of the same element. Elements with a lower ordinal usually have better data (more likely to be quality controlled). |
|
heightDepths |
List<HeightDepth> |
A list of the height/depths that the elements of the stations must have. |
|
*logicalAnd |
boolean |
If true, the method will return stations that match ALL of the parameters passed in. If false, the method will return stations that match ANY of the parameters passed in. |
Example usage:
Case1: Find all SNOTEL stations in Oregon (SNOTEL only, not SCAN). SNOTEL station ids are numbers between 300 and 1999 and SCAN stations are 2000+ (and also station 15).
stationIds=”???”, “1???”
states=”OR”
networkCds=”SNTL”
logicalAnd=true
getStationElements
Gets a list of all elements that a station has (or had) data or normals for a specified begin and end date.
Returns: A list of StationElement objects that contain the elements that are available for the station and dates passed in.
Parameters:
|
Parameter |
Type |
Description |
|
*stationTriplet |
String |
The three-part station identifier of the station for which to get the station elements. |
|
beginDate |
String |
The date the element must have been put out of service after (in format yyyy-MM-dd HH:mm or MM/dd/yyyyHH:mm). Use null if the begin date doesn’t matter. |
|
endDate |
String |
The date the element must have been put into service before (in format yyyy-MM-dd HH:mm or MM/dd/yyyyHH:mm). Use null if the end date doesn’t matter. |
Example usage:
stationTriplet=”302:OR:SNTL”
beginDate=null
endDate=null
This will return all elements that have been defined for station 302 - ANEROID LAKE #2.
getStationMetadata
Retrieves metadata for a station given the three-part station triplet identifier. This method returns a StationMetadata object that contains several pieces of metadata about the given station (such as name, latitude, longitude, elevation, county, and HUC).
Returns: A StationMetadata object that contains the station metadata for the station requested.
Parameters:
|
Parameter |
Type |
Description |
|
*stationTriplet |
String |
The three-part station identifier of the station for which to get the metadata. |
Example usage:
stationTriplet=”302:OR:SNTL”
This will return a StationMetadata object that contains all of the metadata for station 302 - ANEROID LAKE #2.
getStationMetadataMultiple
Retrieves station metadata for multiple stations in a single call. This method returns a StationMetadata object that contains several pieces of metadata about each station passed in (such as name, latitude, longitude, elevation, county, and HUC).
Returns: A list of StationMetadata objects that contain the station metadata for each station requested. The metadata will be returned in the same order as the stations requested.
Parameters:
|
Parameter |
Type |
Description |
|
*stationTriplets |
List<String> |
A list of the three-part station identifiers of the stations for which to get the metadata. |
Example usage:
stationTriplets="302:OR:SNTL", "0645:NV:COOP"
This will return the station metadata for SNOTEL Station 302 - ANEROID LAKE #2 and National Weather Service COOP Station 0645 in Nevada.
Data Methods - Details
getData
Gets data for one or more stations, for a single element, for a range of dates. This will return data starting on the first value that actually has data for each station and will return a value for everything in between until the last non-null value between the requested dates.
Returns: An array of Data objects that contain the data values for each station requested. The data will be returned in the same order as the stations requested.
Parameters:
|
Parameter |
Type |
Description |
|
*stationTriplets |
List<String> |
A list of the three-part station identifiers of the stations for which to get data. |
|
*elementCd |
String |
The element code of the data to retrieve. |
|
*ordinal |
int |
The ordinal for element of the data to retrieve. This will almost always be 1. The ordinal distinguishes multiple sensors of the same element, of which ordinal 1 is the primary sensor, 2 is the secondary sensor (if there are multiple sensors), and so on. |
|
heightDepth |
The height/depth for the element of the data to retrieve, or null if the element doesn’t have a height/depth. For most elements, this should be null. This is usually only non-null for soil-related elements. |
|
|
*duration |
The duration of the data to retrieve. |
|
|
*getFlags |
boolean |
If true, data flags will be retrieved and returned, otherwise the flags won’t be returned. |
|
*beginDate |
String |
The earliest date to get data for (in format yyyy-MM-dd or MM/dd/yyyy) |
|
*endDate |
String |
The latest date to get data for (in format yyyy-MM-dd or MM/dd/yyyy) |
|
*alwaysReturnDailyFeb29 |
boolean |
If 'true' or 'null' is passed in for this parameter, requests for daily data will always return a slot for February 29 (regardless of whether the year is a leap year or not). For leap years, the actual February 29 value will be returned; for non-leap years, null will be returned. If 'false' is passed in, requests for daily data will only return a slot for February 29 or leap years. |
Example usage:
stationTriplets=“302:OR:SNTL” // SNOTEL Station ANEROID LAKE #2 in Oregon
elementCd=”PREC” // Accumulated Precipitation
ordinal=1
heightDepth=null
duration=Duration.DAILY
getFlags=true
beginDate="2010-01-01"
endDate="2010-01-31"
alwaysReturnDailyFeb29=false
Calling the getData method with these parameters will return daily accumulated precipitation for SNOTEL station 302 - ANEROID LAKE #2 for 01/01/2010 to 01/31/2010 and will include the data flags. There will be no placeholder "slot" for February 29.
getDataInsertedOrUpdatedSince
Gets data (any duration but HOURLY) for one or more stations, for a single element, for a range of dates, but only returns data that has been inserted or modified since some date that the user specifies.
Returns: An array of Data objects that contain the data values for each station requested. The data will be returned in the same order as the stations requested.
Parameters:
|
Parameter |
Type |
Description |
|
*stationTriplets |
List<String> |
A list of the three-part station identifiers of the stations for which to get data. |
|
*elementCd |
String |
The element code of the data to retrieve. |
|
*ordinal |
int |
The ordinal for element of the data to retrieve. This will almost always be 1. The ordinal distinguishes multiple sensors of the same element, of which ordinal 1 is the primary sensor, 2 is the secondary sensor (if there are multiple sensors), and so on. |
|
heightDepth |
The height/depth for the element of the data to retrieve, or null if the element doesn’t have a height/depth. For most elements, this should be null. This is usually only non-null for soil-related elements. |
|
|
*duration |
The duration of the data to retrieve. |
|
|
*getFlags |
boolean |
If true, data flags will be retrieved and returned, otherwise the flags won’t be returned. |
|
*beginDate |
String |
The earliest date to get data for (in format yyyy-MM-dd or MM/dd/yyyy) |
|
*endDate |
String |
The latest date to get data for (in format yyyy-MM-dd or MM/dd/yyyy) |
|
*insertOrUpdateBeginDate |
String |
The earliest insert or update date to get data for (in format yyyy-MM-dd or MM/dd/yyyy. The only data values that will be returned will be values that have been inserted or updated on or after this date. |
|
*alwaysReturnDailyFeb29 |
boolean |
If 'true' or 'null' is passed in for this parameter, requests for daily data will always return a slot for February 29 (regardless of whether the year is a leap year or not). For leap years, the actual February 29 value will be returned; for non-leap years, null will be returned. If 'false' is passed in, requests for daily data will only return a slot for February 29 or leap years. |
Example usage:
stationTriplets=“302:OR:SNTL” // SNOTEL Station ANEROID LAKE #2 in Oregon
elementCd=”PREC” // Accumulated Precipitation
ordinal=1
heightDepth=null
duration=Duration.DAILY
getFlags=true
beginDate="2010-01-01"
endDate="2010-01-31"
insertOrUpdateBeginDate="2010-02-01"
alwaysReturnDailyFeb29=false
Calling the getData method with these parameters will return daily accumulated precipitation for SNOTEL station 302 - ANEROID LAKE #2 for 01/01/2010 to 01/31/2010 and will include the data flags. There will be no placeholder "slot" for February 29.
getHourlyData
Gets data for one or more stations, for a single element, for a range of dates. This will return data starting on the first value that actually has data for each station and will return a value for everything in between until the last non-null value between the requested dates and times.
Returns: An array of HourlyData objects that contain the data values for each station requested. The data will be returned in the same order as the stations requested.
Parameters:
|
Parameter |
Type |
Description |
|
*stationTriplets |
List<String> |
A list of the three-part station identifiers of the stations for which to get data. |
|
*elementCd |
String |
The element code of the data to retrieve. |
|
*ordinal |
int |
The ordinal for element of the data to retrieve. This will almost always be 1. The ordinal distinguishes multiple sensors of the same element, of which ordinal 1 is the primary sensor, 2 is the secondary sensor (if there are multiple sensors), and so on. |
|
heightDepth |
The height/depth for the element of the data to retrieve, or null if the element doesn’t have a height/depth. For most elements, this should be null. This is usually only non-null for soil-related elements. |
|
|
*beginDate |
String |
The earliest date to get data for (in format yyyy-MM-dd or MM/dd/yyyy) |
|
*endDate |
String |
The latest date to get data for (in format yyyy-MM-dd or MM/dd/yyyy) |
|
beginHour |
int |
The earliest hour to get data for (in format HH:mm:ss). Note: 00:00 assumed if nothing specified for mm:ss. |
|
endHour |
int |
The latest hour to get data for (in format HH:mm:ss). Note: 00:00 assumed if nothing specified for mm:ss. |
Example usage 1: Get hourly data for a specific time range over a date range
stationTriplets=“302:OR:SNTL” // SNOTEL Station ANEROID LAKE #2 in Oregon
elementCd=”PREC” // Accumulated Precipitation
ordinal=1
heightDepth=null
beginDate=2010-01-01
endDate=2010-01-31
beginHour=2
endHour=16
Example usage 2: Get hourly data for a specific hour over a date range
stationTriplets=“302:OR:SNTL” // SNOTEL Station ANEROID LAKE #2 in Oregon
elementCd=”PREC” // Accumulated Precipitation
ordinal=1
heightDepth=null
beginDate=2010-01-01
endDate=2010-01-31
beginHour=00:00
endHour=00:00
Example usage 3: Get hourly data over a date range
stationTriplets=“302:OR:SNTL” // SNOTEL Station ANEROID LAKE #2 in Oregon
elementCd=”PREC” // Accumulated Precipitation
ordinal=1
heightDepth=null
beginDate=2010-01-01 22:00
endDate=2010-01-02 04:00
beginHour=2
endHour=16
Calling the getData method with these parameters will return hourly accumulated precipitation for SNOTEL station 302 - ANEROID LAKE #2 from 2 a.m. 01/01/2010 to 4 p.m. 01/31/2010, contiguous.
getInstantaneousData
Gets instantaneous SNOTEL or SCAN data for one or more stations for a single element for a range of dates. Most SNOTEL and SCAN stations report data at least every few hours (and some every hour), so use this to get SNOTEL or SCAN data that has a finer granularity than just daily.
A common usage of this method is to get the annual accumulated precipitation value. This value is stored in the database with a timestamp of yyyy-09-30 23:59 for each year. To do this, get the filter=InstantaneousDataFilter.FIRST_OF_DAY value with a begin date and end date of yyyy-09-30 23:59 for elementCd=’PREC’.
Returns: A list of InstantaneousData objects that contain the data values for each station requested. The data will be returned in the same order as the stations requested.
Parameters:
|
Parameter |
Type |
Description |
|
*stationTriplets |
List<String> |
A list of the three-part station identifiers of the stations for which to get data. |
|
*elementCd |
String |
The element code of the data to retrieve. |
|
*ordinal |
int |
The ordinal for the element of the data to retrieve. This will almost always be 1. The ordinal distinguishes multiple sensors of the same element, of which ordinal 1 is the primary sensor, 2 is the secondary sensor (if there are multiple sensors), and so on. |
|
heightDepth |
The height/depth for the element of the data to retrieve, or null if the element doesn’t have a height/depth. For most elements, this should be null. This is usually only non-null for soil-related elements. |
|
|
*beginDate |
String |
The earliest date to get data for (in format yyyy-MM-dd HH:mm or MM/dd/yyyy HH:mm) |
|
*endDate |
String |
The latest date to get data for (in format yyyy-MM-dd HH:mm or MM/dd/yyyy HH:mm) |
|
*filter |
This determines which subset of data to retrieve. This can be ALL to get all values, FIRST_OF_DAY to get only the first value of each day, or MIDNIGHT_ONLY to get only the midnight value of each day requested |
|
|
*unitSystem |
This indicates what units in which to return the data. Possible options are ENGLISH for English units, or LAST_COLLECTED to return the data in the units in which the sensor for this element most recently collected data. |
Example usage for hourly SNOTEL data:
Using these parameters will retrieve hourly Snow Water Equivalent data for January 1, 2010 in English units (inches) for SNOTEL station ANEROID LAKE #2 (302).
stationTriplets="302:OR:SNTL"
elementCd=”WTEQ”
ordinal=1
heightDepth=null
beginDate=”2010-01-01”
endDate=”2010-01-01 23:59”
filter=InstantaneousDataFilter.ALL
unitSystem=UnitSystem.ENGLISH
Example usage for annual precipitation value:
Using these parameters will retrieve the annual accumulated precipitation value for 2010 in English units (inches) for SNOTEL station ANEROID LAKE #2 (302).
stationTriplets="302:OR:SNTL"
elementCd=”PREC”
ordinal=1
heightDepth=null
beginDate=”2010-09-30 23:59”
endDate=”2010-09-30 23:59”
filter=InstantaneousDataFilter.FIRST_OF_DAY
unitSystem=UnitSystem.ENGLISH
getInstantaneousDataInsertedOrUpdatedSince
Gets instantaneous SNOTEL or SCAN data for one or more stations for a single element for a range of dates, but only returns the values that have been inserted or updated since some date that the user specifies. Most SNOTEL and SCAN stations report data at least every few hours (and some every hour), so use this to get SNOTEL or SCAN data that has a finer granularity than just daily and where the user only wants to get the values that have been inserted or updated since some date the user passes in.
Returns: A list of InstantaneousData objects that contain the data values for each station requested. The data will be returned in the same order as the stations requested.
Parameters:
|
Parameter |
Type |
Description |
|
*stationTriplets |
List<String> |
A list of the three-part station identifiers of the stations for which to get data. |
|
*elementCd |
String |
The element code of the data to retrieve. |
|
*ordinal |
int |
The ordinal for the element of the data to retrieve. This will almost always be 1. The ordinal distinguishes multiple sensors of the same element, of which ordinal 1 is the primary sensor, 2 is the secondary sensor (if there are multiple sensors), and so on. |
|
heightDepth |
The height/depth for the element of the data to retrieve, or null if the element doesn’t have a height/depth. For most elements, this should be null. This is usually only non-null for soil-related elements. |
|
|
*beginDate |
String |
The earliest date to get data for (in format yyyy-MM-dd HH:mm or MM/dd/yyyy HH:mm) |
|
*endDate |
String |
The latest date to get data for (in format yyyy-MM-dd HH:mm or MM/dd/yyyy HH:mm) |
|
*insertOrUpdateBeginDate |
String |
The earliest insert or update date to get data for (in format yyyy-MM-dd HH:mm or MM/dd/yyyy HH:mm. The only values that will be returned will be values that have been inserted or updated on or after this date. |
|
*filter |
This determines which subset of data to retrieve. This can be ALL to get all values, FIRST_OF_DAY to get only the first value of each day, or MIDNIGHT_ONLY to get only the midnight value of each day requested |
|
|
*unitSystem |
This indicates what units in which to return the data. Possible options are ENGLISH for English units, or LAST_COLLECTED to return the data in the units in which the sensor for this element most recently collected data. |
Example usage for hourly SNOTEL data:
Using these parameters will retrieve hourly Snow Water Equivalent data for January 1, 2010 in English units (inches) for SNOTEL station ANEROID LAKE #2 (302).
stationTriplets="302:OR:SNTL"
elementCd=”WTEQ”
ordinal=1
heightDepth=null
beginDate=”2010-01-01”
endDate=”2010-01-01 23:59”
insertOrUpdateBeginDate=”2010-01-02”
filter=InstantaneousDataFilter.ALL
unitSystem=UnitSystem.ENGLISH
Example usage for annual precipitation value:
Using these parameters will retrieve the annual accumulated precipitation value for 2010 in English units (inches) for SNOTEL station ANEROID LAKE #2 (302).
stationTriplets="302:OR:SNTL"
elementCd=”PREC”
ordinal=1
heightDepth=null
beginDate=”2010-09-30 23:59”
endDate=”2010-09-30 23:59”
insertOrUpdateBeginDate=”2010-10-01”
filter=InstantaneousDataFilter.FIRST_OF_DAY
unitSystem=UnitSystem.ENGLISH
getPeakData
Gets the annual peak data value for each water year requested, for one or more stations, for a single element. The peak data value is the highest value in each water year (if there are multiple values that equal the highest value, the last one is returned).
Returns: A list of PeakData objects that contain the data values for each station requested. The data will be returned in the same order as the stations requested.
Parameters:
|
Parameter |
Type |
Description |
|
*stationTriplets |
List<String> |
A list of the three-part station identifiers of the stations for which to get the peak values. |
|
*elementCd |
String |
The element code of the data to retrieve. |
|
*ordinal |
|
The ordinal for the element of the data to retrieve. This will almost always be 1. The ordinal distinguishes multiple sensors of the same element, of which ordinal 1 is the primary sensor, 2 is the secondary sensor (if there are multiple sensors), and so on. |
|
heightDepth |
The height/depth for the element of the data to retrieve, or null if the element doesn’t have a height/depth. For most elements, this should be null. This is usually only non-null for soil-related elements. |
|
|
*duration |
The duration of the data to retrieve (currently, this method only supports the DAILY duration). |
|
|
*getFlags |
boolean |
If true, data flags will be retrieved and returned, otherwise the flags won’t be returned. |
|
*beginYear |
int |
The first water year for which to get the peak data value. |
|
*endYear |
int |
The last water year for which to get the peak data value. |
Example usage:
The following parameters will retrieve the highest snow-water equivalent (WTEQ) value for each water year from 2000 to 2003 for SNOTEL station ANEROID LAKE #2 (302). There will be four values returned in total - one for each water year.
stationTriplets=”302:OR:SNTL”
elementCd=”WTEQ”
ordinal=1
heightDepth=null
duration=DAILY
getFlags=true
beginYear=2000
endYear=2003
30 Year Central Tendency Methods - Details
The three methods take a CentralTendencyType, an enumeration with three constants: AVERAGE, MEDIAN and NORMAL. Use the AVERAGE or MEDIAN central tendency type to retrieve the type of values you seek. To retrieve the default central tendency (average or median) values for a given station and element, use NORMAL. The methods are smart enough to know whether the default central tendency type is average or median, and will return the appropriate values. For example, if a SNOTEL or Snow Course station’s element is Snow Water Equivalent, you will receive its default central tendency type as median values; and if a SNOTEL station’s element is Precipitation, you will receive its default central tendency type as average values.
getCentralTendencyData
Gets the 30-year central tendency (average or median) value(s) for the current normals period, for one or more stations, for a single element, for a given duration, and for some range of dates. The method takes a Duration in order to retrieve DAILY, MONTHLY, SEMIMONTHLY, or ANNUAL central tendencies. (Note: For daily data, there is always a tendency value for February 29. If asking for data for January 1 to December 31, 366 values will be returned.)
Returns: A list of Central Tendency Data objects that contain the 30-year central tendency (average or median) values for each station requested. The requested central tendency values will be returned in the same order as the stations requested.
Parameters:
|
Parameter |
Type |
Description |
|
*stationTriplets |
List<String> |
A list of the three-part station identifiers of the stations for which to get central tendencies. |
|
*elementCd |
String |
The element code of the central tendencies to retrieve. |
|
*heightDepth |
The height/depth for the element of the central tendencies to retrieve or null if the element doesn’t have a height/depth. For most elements, this should be null. This is usually only non-null for soil-related elements. |
|
|
*duration |
The duration of the central tendencies to retrieve. This can be DAILY, MONTHLY, SEMIMONTHLY, or ANNUAL. |
|
|
*getFlags |
boolean |
If true, flags associated with the central tendency will be retrieved and returned, otherwise the flags won’t be returned. |
|
*beginMonth |
int |
The first month of central tendencies to retrieve (1-12). |
|
*beginDay |
int |
The first day of the first month for which to retrieve central tendencies (1-31). |
|
*endMonth |
int |
The last month of central tendencies to retrieve (1-12). |
|
*endDay |
int |
The last day of the last month for which to retrieve central tendencies (1-31). |
|
*centralTendencyType |
The type of central tendency values to retrieve. This can be AVERAGE, MEDIAN or NORMAL; where NORMAL will be the default type (Average or Median) for the given station and element. |
Example usage:
The following parameters can be used to get daily 30-year medians for SNOTEL station EMIGRANT SUMMIT (471) in Idaho for Snow Water Equivalent for days Feb 27-Mar 2. Setting the CentralTendencyType to ”NORMAL” will return median values here, as the default central tendency for this station and element is median.
stationTriplets=”471:ID:SNTL”
elementCd=”WTEQ”
heightDepth=null
duration=Duration.DAILY
getFlags=true
beginMonth=2
beginDay=27
endMonth=3
endMonth=2
centralTendencyType=”NORMAL”
getCentralTendencyPeakData
Gets the peak 30-year central tendency (average or median) value(s) for the current normals period, for one or more stations, for a single element, for a given duration, and for some range of dates. The method takes a Duration in order to retrieve DAILY, MONTHLY, SEMIMONTHLY, or ANNUAL central tendencies. The peak central tendency value is the highest value (if there are multiple values that equal the highest value, the last one is returned).
Returns: A list of CentralTendencyPeakData objects that contain the 30-year central tendency (average or median) peak values for each station requested. The requested central tendency (average or median) peak data values will be returned in the same order of the stations requested.
Parameters:
|
Parameter |
Type |
Description |
|
*stationTriplets |
List<String> |
A list of the three-part station identifiers of the stations for which to get peak central tendencies. |
|
*elementCd |
String |
The element code of the peak central tendencies to retrieve. |
|
heightDepth |
The height/depth for the element of the peak central tendencies to retrieve, or null if the element doesn’t have a height/depth. For most elements, this should be null. This is usually only non-null for soil-related elements. |
|
|
*duration |
The duration of the peak central tendencies to retrieve. This can be DAILY, MONTHLY, SEMIMONTHLY, or ANNUAL. |
|
|
*getFlags |
boolean |
If true, flags associated with the peak central tendency will be retrieved and returned, otherwise the flags won’t be returned. |
|
*centralTendencyType |
The type of central tendency values to retrieve. This can be AVERAGE, MEDIAN or NORMAL, where NORMAL will be the default type (Average or Median) for the given station and element. |
Example usage:
The following parameters can be used to request the peak daily 30-year median for snow-water equivalent (WTEQ) for SNOTEL station ANEROID LAKE #2 (302).
stationTriplets=”302:OR:SNTL”
elementCd=”WTEQ”
heightDepth=null
duration=Duration.DAILY
getFlags=false
centralTendencyType=”MEDIAN”
getForecastPeriodCentralTendency
Gets the 30-year forecast period central tendency (average or median) value(s) for the current normals period, for one or more stations, for a given element, and for one or more forecast periods.
Returns: A list of ForecastPeriodCentralTendency objects that contain the 30-year forecast period central tendencies for each station and period requested. The requested central tendency (average or median) values will be returned in the same order as the stations requested.
Parameters:
|
Parameter |
Type |
Description |
|
*stationTriplets |
List<String> |
A list of the three-part station identifiers of the stations for which to get the forecast period averages. |
|
*elementCd |
String |
The element code of the forecast period averages to retrieve. |
|
*periods |
List<String> |
A list of the forecast periods for which to get period averages. This will be a list of Strings that are the names of the periods (such as JAN-MAR, or APR-JUL). |
|
*centralTendencyType |
The type of central tendency values to retrieve. This can be AVERAGE, MEDIAN or NORMAL, where NORMAL will be the default type (Average or Median) for the given station and element. |
Example usage:
The following set of parameters can be used to request forecast period averages for USGS station BLUE LAKE INFLOW (14162200) in Oregon for the forecast periods April-May, May-July, and June-July.
stationTriplets=”14162200:OR:USGS”
elementCd=”SRVO”
periods[0]="APR-MAY"
periods[1]="MAY-JUL"
periods[2]="JUN-JUL"
centralTendencyType=”AVERAGE”
Metadata Methods - Details
getElement
Retrieves metadata about a single element given an element code. The method returns an element object which contains the element code, the name of the element, and the stored unit code (the units that the data was stored in and will be returned in unless otherwise specified).
Returns: An element object that contains the metadata about the element code passed in.
Parameters:
|
Parameter |
Type |
Description |
|
*elementCd |
String |
The element code about which to get additional metadata |
Example Usage:
elementCd=’WTEQ’
getElements
Retrieves a list of all elements in the AWDB database. Each item in the returned list will be an Element object and will contain the same information described in the getElement method. The elements will be ordered alphabetically by element code.
Returns: A list of Element objects (one for each element defined in the AWDB database).
Parameters: None
getHeightDepths
Gets a list of all possible height/depths that are defined in AWDB (returned as a list of HeightDepth objects). Each HeightDepth object consists of a value (positive for a height, and negative for a depth) along with the unit code of the value (usually “in” for inches).
Returns: A list of HeightDepth objects that contain the information about all the height/depths defined in the AWDB database.
Parameters: None
getUnitName
Retrieves the (plural) name of a unit given a unit code. Calling this method with “in” for example returns “inches”.
Returns: The (plural) name of the unit for the unit code passed in.
Parameters:
|
Parameter |
Type |
Description |
|
*unitCode |
String |
The unit code of the unit for which to get the name. |
Example usage:
unitCode=”in” returns “inches”
getUnits
Retrieves a list of all of the units defined in the AWDB database. Each item in the returned list will be a unit object that contains the unit code and the name (plural name) of the unit.
Returns: A list of unit objects - one for each unit defined in the database.
Parameters: None
Forecast Methods - Details
getForecast
Gets a water supply forecast value for a given forecast point, element, forecast period, and publication date.
Returns: A Forecast object that contains the forecast values (for all probabilities) for the requested station, element, forecast period, and publication date.
Parameters:
|
Parameter |
Type |
Description |
|
*stationTriplets |
String |
The three-part station identifier of the station for which to get the forecast. |
|
*elementCd |
String |
The element code of the forecast to retrieve. |
|
*forecastPeriod |
String |
The forecast period for which to get the forecast. This will be a String that is the name of the period (such as JAN-MAR, or APR-JUL) for which to get the forecast. |
|
*publicationDate |
String |
The publication date of the forecast to retrieve. This must be a String in the format yyyy-MM-dd or MM/dd/yyyy. |
Example usage:
Using the following parameters will retrieve the forecast values for APR-JUL that were published in April 2011 for the forecast point “Applegate River Nr Copper” (14362000) in Oregon.
stationTriplet=”14362000:OR:USGS”
elementCd=”SRVO”
forecastPeriod=”APR-JUL”
publicationDate=”2011-04-01”
getForecastPeriods
Gets a list of all forecast periods defined in the AWDB database.
Returns: A list of ForecastPeriod objects that represents all forecast periods defined in the AWDB database.
Parameters: None
getForecastPoint
Gets the forecast point metadata for a given station. The forecast point metadata includes the name of the forecast point (which may be different from the name of the actual station), the exceedenceprobabilities that will be calculated for forecasts for this point, and the name of the forecaster responsible for producing forecasts for this point.
Returns: A ForecastPoint object that contains the forecast point metadata for a given station.
Parameters:
|
Parameter |
Type |
Description |
|
*stationTriplet |
String |
The three-part station identifier of the station for which to get the forecast point metadata. |
Example usage:
Using the following parameter will retrieve the forecast point metadata for USGS station “Applegate River Nr Copper” (14362000) in Oregon.
stationTriplet=”14362000:OR:USGS”
getForecastPoints
Finds one or more forecast points using search criteria such as station ids, state codes, network codes, forecast point names, HUCs, or name of responsible forecaster. Any of the parameters that take a list can be null if you don’t want to search by that criteria. If any of the parameters that take a list have more than one item, the search will return forecast points that match any of those items.
Returns: A list of ForecastPoint objects for all the forecast points that match the search criteria used.
Parameters:
|
Parameter |
Type |
Description |
|
stationIds |
List<String> |
A list of the station ids of the forecast points for which to search. The station ids can contain the wildcard characters ‘*’ or ‘?’ |
|
stateCds |
List<String> |
A list of the two-character FIPS state postal codes of the states of the forecast points to find. |
|
networkCds |
List<String> |
A list of the of the forecast points for which to search. |
|
forecastPointNames |
List<String> |
A list of the names of the forecast points for which to search. The names can contain the ‘*’ or ‘?’ wildcard characters. |
|
hucs |
List<String> |
A list of the Hydrologic Unit Codes (HUC) of the forecast points for which to search. The HUCs can contain the wildcard characters ‘*’ or ‘?’. Always include the ‘*’ wildcard at the end of the HUC (otherwise you’ll have to match the exact number of digits of the HUC for the forecast point as defined in the AWDB database - which is currently 8-digits, but will change to 12-digits in the future). |
|
forecasters |
List<String> |
A list of user names of forecasters that are responsible for producing the forecasts of the forecast points for which to search. User names are usually the first-name initial followed by the last name of the forecaster (all lowercase). |
|
*logicalAnd |
boolean |
If true, the forecast points that are returned must match all of the search criteria passed in. If false, the forecast points that are returned must match at least one of the search criteria passed in. |
Example usage:
The following parameters can be used to find all forecast points in Oregon or Washington that are USGS stations and where the forecast point name begins with “CL”.
stateCds=”OR”, ”WA”
networkCds=”USGS”
forecastPointNames=”CL*”
logicalAnd=true
getForecasts
Gets all the forecasts for a given station, element, and forecast period (for all publication dates).
Returns: A list of Forecast objects for all the forecasts requested.
Parameters:
|
Parameter |
Type |
Description |
|
*stationTriplet |
String |
The three-part station identifier of the station for which to get the forecasts. |
|
*elementCd |
String |
The element code of the forecasts to retrieve. |
|
*forecastPeriod |
String |
The forecast period to get the forecasts for. This will be a string that is the name of the period (such as JAN-MAR or APR-JUL) for which to get the forecast. |
Example usage:
The following parameters will retrieve all forecasts for APR-JUL for the forecast point “Applegate River Nr Copper” (14362000) in Oregon, for all publication dates.
stationTriplet=”14362000:OR:USGS”
elementCd=”SRVO”
forecastPeriod=”APR-JUL”
getForecastsByPubDate
Gets a list of forecasts for a given station, element, forecast period, and whose publication dates are between a given begin and end date.
Returns: A list of Forecast objects for all the forecasts requested.
Parameters:
|
Parameter |
Type |
Description |
|
*stationTriplet |
String |
The three-part station identifier of the station for which to get the forecasts. |
|
*elementCd |
String |
The element code of the forecasts to retrieve. |
|
*forecastPeriod |
String |
The forecast period to get the forecasts for. This will be a string that is the name of the period (such as JAN-MAR or APR-JUL) for which to get the forecast. |
|
*beginPublicationDate |
String |
The earliest publication date of the forecasts to retrieve. This must be a string in the format yyyy-MM-dd or MM/dd/yyyy. |
|
*endPublicationDate |
String |
The latest publication date of the forecasts to retrieve. This must be a string in the format yyyy-MM-dd or MM/dd/yyyy. |
Example usage:
Using the following parameters will retrieve the forecasts for APR-JUL that were published between April 2011 and April 2012 for the forecast point “Applegate River Nr Copper” (14362000) in Oregon.
stationTriplet=”14362000:OR:USGS”
elementCd=”SRVO”
forecastPeriod=”APR-JUL”
beginPublicationDate=”2011-04-01”
endPublicationDate=”2012-04-01”
getForecastValue
Gets a single forecast value (with no additional metadata) for a given station, element, forecast period, exceedence probability, and publication date.
Returns: A BigDecimal that represents a single forecast value (in thousands of acre-feet) for the requested forecast point, period, probability and publication date.
Parameters:
|
Parameter |
Type |
Description |
|
*stationTriplet |
String |
The three-part station identifier of the station for which to get the forecast. |
|
*elementCd |
String |
The element code of the forecast to retrieve. |
|
*forecastPeriod |
String |
The forecast period for which to get the forecast. This will be a String that is the name of the period (such as JAN-MAR or APR-JUL) for which to get the forecast. |
|
*probability |
int |
The exceedence probability of the forecast to retrieve (a number between 0 and 100). This is usually one of 5, 10, 30, 50, 70, 90, or 95. |
|
*publicationYear |
int |
The year of the publication date of the requested forecast. |
|
*publicationMonth |
int |
The month of the publication date of the requested forecast (1-12). |
|
*publicationDay |
int |
The day of month of the publication date of the requested forecast (1-31). |
Example usage:
Using the following parameters below retrieve the forecast value (in thousands of acre-feet) for APR-JUL for the forecast point “Applegate River Nr Copper” (14362000) in Oregon that was published April 1, 2011.
stationTriplet=”14362000:OR:USGS”
elementCd=”SRVO”
forecastPeriod=”APR-JUL”
publicationYear=2011
publicationMonth=4
publicationDay=1
AWDB Web Service Class Listing
CentralTendencyData
|
Attribute |
Type |
Description |
|
beginDay |
int |
The day of month of the first central tendency value in the values list (1-31). |
|
beginMonth |
int |
The month of the first central tendency value in the values list (1-12). |
|
dataSetFlag |
String |
The flag assigned to the set of 30-year central tendencies returned. |
|
duration |
The duration of the 30-year central tendencies in the values list. |
|
|
endDay |
int |
The day of month of the last central tendency value in the values list (1-31). |
|
endMonth |
int |
The month of the last central tendency value in the values list (1-12). |
|
flags |
List<String> |
The flags associated with each of the 30-year central tendency values. There will be one entry for each value in the list. |
|
values |
List<BigDecimal> |
The 30-year central tendency values. |
|
centralTendencyType |
An enumeration with three constants: AVERAGE, MEDIAN and NORMAL. The AVERAGE and MEDIAN are the calculated value types. NORMAL is the default central tendency (average or median) for a specific station and element. |
CentralTendencyPeakData
|
Attribute |
Type |
Description |
|
duration |
The duration of the peak 30-year central tendency value. |
|
|
flag |
String |
The flag associated with the peak 30-year central tendency value. |
|
peakDay |
int |
The day of month of the peak 30-year central tendency value (1-31). |
|
peakMonth |
int |
The month of the peak 30-year central tendency values (1-12). |
|
value |
BigDecimal |
The peak 30-year central tendency value. |
|
centralTendencyType |
An enumeration with three constants: AVERAGE, MEDIAN and NORMAL. The AVERAGE and MEDIAN are the calculated value types. NORMAL is the default central tendency (average or median) for a specific station and element. |
CentralTendencyType (Enum)
|
Value |
Description |
|
AVERAGE |
Used to request average values. |
|
MEDIAN |
Used to request median values. |
|
NORMAL |
Used to request the default central tendency (average or median) values for a given station and element, whichever is their default central tendency type. |
Data
|
Attribute |
Type |
Description |
|
beginDate |
String |
The date of the first data value returned (in format yyyy-MM-dd). |
|
duration |
The duration of the data values. |
|
|
endDate |
String |
The date of the last data value returned (in format yyyy-MM-dd). |
|
flags |
List<String> |
The flags for each of the data values (if requested). |
|
values |
List<BigDecimal> |
The actual data values. |
DataSource (Enum)
|
Value |
Description |
|
OBSERVED |
Indicates that data was measured/collected directly by the station. |
|
DERIVED |
Indicates that data was derived from another data source (usually another duration of the same element) |
|
INTERPRETED |
Indicates that the data was interpreted from another data source. |
Duration (Enum)
|
Value |
Description |
|
ANNUAL |
Used to request water year precipitation data and normals. |
|
DAILY |
Used to request daily data and normals. |
|
INSTANTANEOUS |
Deprecated. The getStationElements method may return this for a SNOTEL/SCAN station that has instantaneous data. |
|
MONTHLY |
Used to request monthly data and normals. |
|
SEMIMONTHLY |
Used to request semi-monthly data and normals. |
|
SEASONAL |
Used to request water supply forecast values or seasonal streamflow normals. |
Element
|
Attribute |
Type |
Description |
|
elementCd |
String |
The element code of the element. |
|
name |
String |
The name of the element. |
|
storedUnitCd |
String |
The units that the data for this element are stored in. This will be the units of the data returned by the web service unless otherwise specified. |
Forecast
|
Attribute |
Type |
Description |
|
calculationDate |
String |
The date and time that the forecast values were calculated. In the formatyyyy-MM-dd HH:mm:ss. |
|
elementCd |
String |
The element code of the forecast values. |
|
exceedenceProbabilities |
List<Integer> |
The exceedence probabilities that were calculated (these will usually be [5, 30, 50, 70, 95] or [10, 30, 50, 70, 90]. |
|
exceedenceValues |
List<BigDecimal> |
The calculated forecast values for each of the exceedence probabilities for this forecast. |
|
forecastPeriod |
String |
The forecast period for this forecast. |
|
periodAverage |
BigDecimal |
The 30-year seasonal period average for the forecast period that this forecast. |
|
publicationDate |
String |
The publication date of this forecast. |
|
stationTriplet |
String |
The three-part station identifier that identifies the station for this forecast. |
|
unitCd |
String |
The unit code that indicates the units of the calculated forecast values and the period average. |
ForecastPeriod
|
Attribute |
Type |
Description |
|
description |
String |
A description of the forecast period (if any). |
|
forecastPeriod |
String |
The forecast period as a string. This will be something like APR-JUL (for April to July). |
ForecastPeriodCentralTendency
|
Attribute |
Type |
Description |
|
flag |
String |
The flag associated with the forecast period average value. |
|
forecastPeriod |
String |
The forecast period as a string. This will be something like APR-JUL (for April to July). |
|
stationTriplet |
String |
The three-part station identifier that identifies the station for which this forecast period average is. |
|
value |
BigDecimal |
The forecast period average value. |
|
centralTendencyType |
An enumeration with three constants: AVERAGE, MEDIAN and NORMAL. The AVERAGE and MEDIAN are the calculated value types. NORMAL is the default central tendency (average or median) for a specific station and element. |
Forecast Point
|
Attribute |
Type |
Description |
|
exceedenceProbabilities |
List<Integer> |
A list of the forecast exceedence probabilities that are to be calculated when forecasts for this forecast point are calculated. Each of these will be a number between 5 and 95. Usually a group of five probabilities that are [5, 30, 50, 70, 95] or [10, 30, 50, 70, 90]. |
|
name |
String |
The name of the forecast point. |
|
responsibleForecaster |
String |
An abbreviated name of the NWCC forecaster responsible for producing the forecasts for this forecast point. |
|
stationTriplet |
String |
The three-part station identifier that identifies the station to which this forecast point corresponds. |
HeightDepth
|
Attribute |
Type |
Description |
|
unitCd |
String |
The unit code of the height/depth value. This is usually “in” for inches or “mm” for millimeters. |
|
value |
String |
The height or depth value. Depths will be negative; heights will be positive. |
Example: If you want a soil moisture element at a depth of two inches, the unitCd would be “in” and the value would be -2.
Note: When using HeightDepth objects, both unitCd and value must be set. Use null in place of a HeightDepth object if an element doesn’t have a height or depth (the HeigthDepth is typically only used for soil-related elements).
HourlyData
|
Attribute |
Type |
Description |
|
beginDate |
String |
The date of the first data value returned (in format yyyy-MM-dd). |
|
endDate |
String |
The date of the last data value returned (in format yyyy-MM-dd). |
|
stationTriplet |
String |
The three-part station identifier that identifies the station for which the hourly data values are for. |
|
values |
List<HourlyDataValue> |
A list of HourlyDataValue objects. |
HourlyDataValue
|
Attribute |
Type |
Description |
|
value |
BigDecimal |
The actual data value. |
|
flag |
String |
The flag associated with the data value. |
|
dateTime |
String |
The date and time of the data value (in format yyyy-MM-dd HH:mm). |
InstantaneousData
|
Attribute |
Type |
Description |
|
beginDate |
String |
The date of the first instantaneous data value returned (in format yyyy-MM-dd). |
|
endDate |
String |
The date of the last instantaneous data value returned (in format yyyy-MM-dd). |
|
stationId |
int |
The SNOTEL/SCAN station whose data this object represents. |
|
unitCd |
String |
The unit code of the units of the data values contained in this object. |
|
values |
List<InstantaneousDataValue> |
A list of the instantaneous data values that were requested. |
InstantaneousDataFilter (Enum)
|
Value |
Description |
|
ALL |
Used to request all instantaneous data values (no filtering). |
|
FIRST_OF_DAY |
Used to request only the first value of each day. |
|
MIDNIGHT_ONLY |
Used to request only the midnight value of each day. |
InstantaneousDataValue
|
Type |
Description |
|
|
flag |
String |
The flag associated with the data value. This will be ‘V’ for valid, ‘S’ for suspect, or ‘E’ for edited. |
|
time |
String |
The date and time of the data value (in format yyyy-MM-dd HH:mm). |
|
value |
BigDecimal |
The instantaneous data value. |
PeakData
|
Attribute |
Type |
Description |
|
beginYear |
int |
The water year of the first peak data value in the list of values and flags. |
|
duration |
The duration of the peak data values. |
|
|
endYear |
int |
The water year of the last peak data value in the list of values and flags. |
|
flags |
List<String> |
The data flags associated with the peak data values. |
|
peakDays |
List<Integer> |
The days of months of each of the peak data values. |
|
peakMonths |
List<Integer> |
The month of each of the peak data values. |
|
values |
List<BigDecimal> |
The peak data values for each water year requested. |
ReservoirMetadata
|
Attribute |
Type |
Description |
|
elevationAtCapacity |
BigDecimal |
The elevation (in feet) of the reservoir when the reservoir is filled to capacity. |
|
reservoirCapacity |
BigDecimal |
The capacity of the reservoir (in acre-feet). |
|
stationTriplet |
String |
The three-part station identifier that identifies the reservoir station. |
|
usableCapacity |
BigDecimal |
The usable capacity of the reservoir (in acre-feet). |
StationElement
|
Attribute |
Type |
Description |
|
beginDate |
String |
The date that the station started collecting data for this element (in yyyy-MM-dd HH:mm:ss format). |
|
dataPrecision |
Integer |
The precision for which the data for this element is accurate (it is also the precision that the data/normals will be returned in). |
|
dataSource |
The data source of the element. |
|
|
duration |
The duration of the element. |
|
|
elementCd |
String |
The element code of the element. |
|
endDate |
String |
The date that the station stopped collecting data for this element (in yyyy-MM-dd HH:mm:ss format). If the station is still collecting data for this element, this will be set to 2100-01-01 00:00:00. |
|
heightDepth |
Indicates the height or depth of the sensor collecting data for the element. This is usually only used for soil sensors and will be null for everything else. |
|
|
ordinal |
int |
The ordinal of the station element. The ordinal is a number that indicates whether the element is from the primary sensor, the secondary sensor, and so on (if there are multiple sensors collecting data for the same element). This will typically be 1. |
|
originalUnitCd |
String |
The unit code of the units that the data for this element were collected in. |
|
stationTriplet |
String |
The three-part station identifier that identifies the station to which the station element belongs. |
|
storedUnitCd |
String |
The unit code of the units that the data for this element were stored in (this is, units that the web service will return data in unless otherwise specified) |
StationMetadata
|
Attribute |
Type |
Description |
|
actonId |
String |
The “acton” id of a station. This is only used for SNOTEL stations and has also been known as the “CDBS” id. (For example, for station ‘302’, the acton id is ‘17D02S’). |
|
beginDate |
String |
The date (yyyy-MM-dd HH:mm:ss) that the station was installed. |
|
countyName |
|
The name of the county in which the station is located. |
|
elevation |
BigDecimal |
The elevation (in feet) of the station. |
|
endDate |
String |
The date (yyyy-MM-dd HH:mm:ss) that the station was discontinued. If the station is still active, the end date will be set to 2100-01-01 00:00:00. |
|
fipsCountyCd |
String |
The FIPS county code of the county (and state) in which the station is located. |
|
fipsCountryCd |
String |
The FIPS country code of the country in which the station is located. |
|
fipsStateNumber |
String |
The FIPS state number of the state in which the station is located. |
|
huc |
String |
The 12-digit HUC (based on the Watershed Boundary Dataset) in which the station is located. |
|
hud |
String |
The 8-digit HUC (based on the Hydrologic Unit Dataset) in which the station is located. |
|
latitude |
BigDecimal |
The station latitude. |
|
longitude |
BigDecimal |
The station longitude. |
|
name |
String |
The station name. |
|
shefId |
String |
The id of the station that is used when sending data to the National Weather Service via the SHEF system. |
|
stationDataTimeZone |
BigDecimal |
The time zone in which the station collects data. |
|
stationTimeZone |
BigDecimal |
The time zone of the actual location of the station (Note: This is currently set to the same value as thestationDataTimeZone). |
|
stationTriplet |
String |
The three-part identifier of the station, in the format stationId:stateCode:networkCode. |
Unit
|
Attribute |
Type |
Description |
|
name |
String |
The plural name of the unit. |
|
unitCd |
String |
The unit code of the unit. |
UnitSystem (Enum)
|
Value |
Description |
|
ENGLISH |
Used to request instantaneous data in English units (e.g., precipitation in inches, temperature in Fahrenheit, etc) |
|
LAST_COLLECTED |
Used to request data in the units that the data was most recently collected in (e.g., if a station was collecting observed temperature in Fahrenheit, but later switched to Celsius, then if the data is requested in LAST_COLLECTED units, all of the data will be returned in Celsius units). |
Network Codes
Three pieces of information are needed to identify a station uniquely:
- Station id.
- State code. The state code is the two-character FIPS alphabetic code. For example, the state code for Oregon is OR.
- Network code. The network code usually indicates the source of the data, but is primarily used to avoid clashes in station ids, by grouping ids that come from certain sources together.
AWDB Network Codes
The network codes used by the AWDB database are in the following table.
|
Network Code |
Description |
|
BOR |
Any Bureau of Reclamation reservoir stations plus other non-BOR reservoir stations |
|
CLMIND |
Used to store climate indices (such as Southern Oscillation Index or Trans-Nino Index) |
|
COOP |
National Weather Service COOP stations |
|
MPRC |
Manual precipitation sites |
|
MSNT |
Manual SNOTEL non-telemetered, non-real-time sites |
|
SNOW |
NRCS Snow Course Sites |
|
SNTL |
NWCC SNOTEL and SCAN stations |
|
USGS |
Any USGS station, but also other non-USGS streamflow stations |
Element Codes
When you request data from the AWDB Web Service, you need to specify the element code for the data that you are interested in. The following table lists the element codes available and the units in which the data are stored.
Commonly-Used Element Codes
|
Name |
Element Code |
Unit |
|
|
AIR TEMPERATURE AVERAGE |
TAVG |
Fahrenheit |
|
|
AIR TEMPERATURE MAXIMUM |
TMAX |
Fahrenheit |
|
|
AIR TEMPERATURE MINIMUM |
TMIN |
Fahrenheit |
|
|
AIR TEMPERATURE OBSERVED |
TOBS |
Fahrenheit |
|
|
DIVERSION FLOW VOLUME OBSERVED |
DIV |
acre-feet |
|
|
DIVERSION DISCHARGE OBSERVED MEAN |
DIVD |
cfs |
|
|
DISCHARGE MANUAL/EXTERNAL ADJUSTED MEAN |
SRDOX |
cfs |
|
|
PRECIPITATION ACCUMULATION |
PREC |
inches |
|
|
PRECIPITATION INCREMENT |
PRCP |
inches |
|
|
PRECIPITATION INCREMENT – SNOW-ADJUSTED |
PRCPSA |
inches |
|
|
RESERVOIR STORAGE VOLUME |
RESC |
acre-feet |
|
|
RIVER DISCHARGE OBSERVED MEAN |
SRDOO |
cfs |
|
|
SNOW DEPTH |
SNWD |
inches |
|
|
SNOW WATER EQUIVALENT |
WTEQ |
inches |
|
|
STREAM VOLUME, ADJUSTED |
SRVO |
acre-feet |
|
|
STREAM VOLUME, ADJUSTED EXTERNALLY |
SRVOX |
acre-feet |
|
|
STREAM VOLUME, OBSERVED |
SRVO |
acre-feet |
|
|
TELECONNECTION INDEX (also known as OSCILLATION INDEX) |
OI |
N/A |
|
Other Element Codes
|
Name |
Element Code |
Unit |
|
BAROMETRIC PRESSURE |
PRES |
inches of Mercury |
|
BATTERY-ETI PRECIP GAGE |
ETIB |
volt |
|
CONDUCTIVITY |
COND |
umho |
|
DEW POINT TEMPERATURE |
DPTP |
Fahrenheit |
|
DIAGNOSTICS |
DIAG |
unitless |
|
DISSOLVED OXYGEN |
DISO |
mgram/l |
|
DISSOLVED OXYGEN - PERCENT SATURATION |
DISP |
pct |
|
ENERGY GAIN OR LOSS FROM GROUND |
HFTV |
watt/m2 |
|
EVAPORATION |
EVAP |
inches |
|
FUEL MOISTURE |
FUEL |
pct |
|
FUEL TEMPERATURE INTERNAL |
FMTMP |
Fahrenheit |
|
GROUND SURFACE INTERFACE TEMPERATURE AVERAGE |
TGSV |
Fahrenheit |
|
GROUND SURFACE INTERFACE TEMPERATURE MAXIMUM |
TGSX |
Fahrenheit |
|
GROUND SURFACE INTERFACE TEMPERATURE MINIMUM |
TGSN |
Fahrenheit |
|
GROUND SURFACE INTERFACE TEMPERATURE OBSERVED |
TGSI |
Fahrenheit |
|
JULIAN DATE |
JDAY |
julian_day |
|
NET SOLAR RADIATION AVERAGE |
NTRDV |
watt/m2 |
|
NET SOLAR RADIATION MAXIMUM |
NTRDX |
watt/m2 |
|
NET SOLAR RADIATION MINIMUM |
NTRDN |
watt/m2 |
|
NET SOLAR RADIATION OBSERVED |
NTRDC |
watt/m2 |
|
PH |
H2OPH |
unitless |
|
PHOTOSYNTHETICALLY ACTIVE RADIATION (PAR) AVERAGE |
PARV |
micromole/m2/s |
|
PULSE LINE MONITOR-ETI GUAGE |
ETIL |
volt |
|
REAL DIELECTRIC CONSTANT |
RDC |
unitless |
|
RELATIVE HUMIDITY |
RHUM |
pct |
|
RELATIVE HUMIDITY AVERAGE |
RHUMV |
pct |
|
RELATIVE HUMIDITY ENCLOSURE |
RHENC |
pct |
|
RELATIVE HUMIDITY MAXIMUM |
RHUMX |
pct |
|
RELATIVE HUMIDITY MINIMUM |
RHUMN |
pct |
|
RESERVOIR STAGE |
REST |
feet |
|
SALINITY |
SAL |
gram/l |
|
SNOW DEPTH AVERAGE |
SNWDV |
inches |
|
SNOW DEPTH MAXIMUM |
SNWDX |
inches |
|
SNOW DEPTH MINIMUM |
SNWDN |
inches |
|
SNOW FALL |
SNOW |
inches |
|
SNOW WATER EQUIVALENT AVERAGE |
WTEQV |
inches |
|
SNOW WATER EQUIVALENT MAXIMUM |
WTEQX |
inches |
|
SNOW WATER EQUIVALENT min |
WTEQN |
inches |
|
SOIL MOISTURE BARS AVERAGE |
SMV |
inches of Mercury |
|
SOIL MOISTURE BARS MAXIMUM |
SMX |
inches of Mercury |
|
SOIL MOISTURE BARS MINIMUM |
SMN |
inches of Mercury |
|
SOIL MOISTURE BARS OBSERVED |
SMO |
inches of Mercury |
|
SOIL MOISTURE PERCENT |
SMS |
pct |
|
SOIL TEMPERATURE AVERAGE |
STV |
Fahrenheit |
|
SOIL TEMPERATURE MAXIMUM |
STX |
Fahrenheit |
|
SOIL TEMPERATURE MINIMUM |
STN |
Fahrenheit |
|
SOIL TEMPERATURE OBSERVED |
STO |
Fahrenheit |
|
SOLAR RADIATION |
SRAD |
watt/m2 |
|
SOLAR RADIATION AVERAGE |
SRADV |
watt/m2 |
|
SOLAR RADIATION MAXIMUM |
SRADX |
watt/m2 |
|
SOLAR RADIATION MINIMUM |
SRADN |
watt/m2 |
|
SOLAR RADIATION TOTAL |
SRADT |
watt/m2 |
|
SOLAR RADIATION/LANGLEY |
LRAD |
langley |
|
SOLAR RADIATION/LANGLEY MAXIMUM |
LRADX |
langley |
|
SOLAR RADIATION/LANGLEY TOTAL |
LRADT |
langley |
|
STREAM STAGE (GAUGE HEIGHT) AVERAGE |
SRMV |
feet |
|
STREAM STAGE (GAUGE HEIGHT) MAXIMUM |
SRMX |
feet |
|
STREAM STAGE (GAUGE HEIGHT) MINIMUM |
SRMN |
feet |
|
STREAM STAGE (GAUGE HEIGHT) OBSERVED |
SRMO |
feet |
|
STRM FLOW AVERAGE |
STRV |
cfs |
|
TURBIDITY |
TURB |
ntu |
|
USABLE LAKE STORAGE VOLUME |
RESA |
acre-feet |
|
VAPOR PRESSURE - PARTIAL |
PVPV |
kPa |
|
VAPOR PRESSURE - SATURATED |
SVPV |
kPa |
|
WATER LEVEL AVERAGE |
WLEVV |
inches |
|
WATER LEVEL MAXIMUM |
WLEVX |
inches |
|
WATER LEVEL MINIMUM |
WLEVN |
inches |
|
WATER LEVEL OBSERVED |
WLEV |
inches |
|
WATER TEMPERATURE |
WTEMP |
Fahrenheit |
|
WATER TEMPERATURE AVERAGE |
WTAVG |
Fahrenheit |
|
WATER TEMPERATURE MAXIMUM |
WTMAX |
Fahrenheit |
|
WATER TEMPERATURE MINIMUM |
WTMIN |
Fahrenheit |
|
WELL DEPTH |
WELL |
feet |
|
WIND DIRECTION AVERAGE |
WDIRV |
degree |
|
WIND DIRECTION OBSERVED |
WDIR |
degree |
|
WIND MOVEMENT AVERAGE |
WDMVV |
mile |
|
WIND MOVEMENT MAXIMUM |
WDMVX |
mile |
|
WIND MOVEMENT MINIMUM |
WDMVN |
mile |
|
WIND MOVEMENT OBSERVED |
WDMV |
mile |
|
WIND MOVEMENT TOTAL |
WDMVT |
mile |
|
WIND SPEED AVERAGE |
WSPDV |
mph |
|
WIND SPEED MAXIMUM |
WSPDX |
mph |
|
WIND SPEED MINIMUM |
WSPDN |
mph |
|
WIND SPEED OBSERVED |
WSPD |
mph |
Unsupported Methods
These methods are used by NWCC applications, and are not supported for public use.
getAllForecastsForStation
getForecastConfigurations
getForecastEquations
getForecastEquationsMultiple
getStationDataAssuredFlags