ORFEUS

Home > Data > FDSN Webservice Usage

ODC Web Services

FDSN Webservice implementation: fdsnws_station

The FSDN-station web service provides access to network, station, channel and response metadata in FDSN Station XML format. Metadata may be selected based on network, station, location or channel names in addition to time windows, geographic regions or metadata update times. Results are available at multiple levels of granularity: network, station, channel and response.

Please refer to http://www.fdsn.org/webservice for a complete service description.

The FDSN webservice implemented at ODC provides access to metadata from all open EIDA stations.


Query Usage

Usage of query is as follows:

/query? [channel-options] [geographic-constraints] [time-constraints] [misc-parameters]

where

channel-options        :: [network=<network>] [station=<station>] 
			  [location=<location>] [channel=<channel>]

geographic-constraints :: [boundaries-rect] OR [boundaries-circular]

boundaries-rect        :: [minlatitude=<degrees>] [maxlatitude=<degrees>] 
			  [minlongitude=<degrees>] [maxlongitude=<degrees>]

boundaries-circular    :: [latitude=<latitude>&longitude=<longitude>&maxradius=<degrees>] 
			  [minradius=<degrees>]

time-constraints       :: [starttime=<date>] [endtime=<date>] [startbefore=<date>] 
			  [startafter=<date>] [endbefore=<date>] [endafter=<date>]

misc-parameters        :: [level=<station|network|channel|response>] [output=<xml|text>] 
			  [updatedafter=<date>] [availability=<false|true>] 
			  [matchtimeseries=<false|true>] [includerestricted=<true|false>]

Note: Each parameter-value pair should be separated by an ampersand "&", and with no space (see sample queries below).

Sample Queries


Detailed Descriptions of each Query Parameter


Parameter/
(Abbr.)
ExamplesDiscussionDefaultType
starttime
(start)
2001-12-09 Limit to metadata epochs starting on or after the specified start time. any day/time
endtime
(end)
2012-12-31 Limit to metadata epochs ending on or before the specified end time any day/time
startbefore 2012-12-31 Limit to metadata epochs starting before specified time. This criterion only applies to station times any day/time
startafter 2012-12-31 Limit to metadata epochs starting after specified time. This criterion only applies to station times any day/time
endbefore 2012-12-31 Limit to metadata epochs ending before specified time. This criterion only applies to station times any day/time
endafter 2012-12-31 Limit to metadata epochs ending after specified time. This criterion only applies to station times any day/time
 
Empty/No parameters submitting an empty query (e.g. .../query?) will return ALL stations at the default level.    
network
(net)
NL Select one or more network codes.1 Can be SEED codes or data center defined codes. any string
station
(sta)
HGN Select one or more SEED station codes.1 any string
location
(loc)
00 Select one or more SEED location identifier.1 Use -- for “Blank” location IDs (ID’s containing 2 spaces). any string
channel
(cha)
BHZ Select one or more SEED channel codes.1 any string
 
minlatitude
(minlat)
15.5 Southern boundary. -90° degrees
maxlatitude
(maxlat)
25.0 Northern boundary. 90° degrees
minlongitude
(minlon)
-170.0 Western boundary. -180° degrees
maxlongitude
(maxlon)
170.0 Western boundary. 180° degrees
 
latitude
(lat)
35.0 Specify the central latitude point.3   degrees
longitude
(lon)
170.0 Specify the central latitude point.3   degrees
maxradius 20.0 Specify maximum distance from the geographic point defined by latitude and longitude.3   degrees
minradius 19.0 Specify minimum distance from the geographic point defined by latitude and longitude.3   degrees
 
level channel Specify level of detail using network, station, channel,or response.4   degrees
includerestricted TRUE Specify if results should include information for restricted stations. TRUE Boolean
includeavailability TRUE Specify if results should include information about time series data availability. FALSE Boolean
updateafter 2013-01-01 Limit to metadata updated after specified date; updates are data center specific. any day/time

1Accepts wildcards and lists

2Network wildcard is not supported when level=response

3To define a radial boundary, latitude, longitude and maxradius are required, but minradius is optional.

4When level=response, special rules apply. The network must be explicitly specified (no wildcards), and output=text is not allowed.


Level

Level specifies the level of detail returned within the returned XML.

The quality, minimumlength and longestonly parameters should be specified as key=value pairs on separate lines and the simple time and channel constraints parameters repeated as many times as necessary following this pattern:


Glob Expressions

Wildcards

The question mark ? represents any single character (exactly one), while the asterisk * represents zero or more characters.

Lists

Multiple items may also be retrieved using a comma separated list. For example BHZ,BHN,BHE


Time Formatting

Year, Month, Day in Month — Time:

YYYY-MM-DDThh:mm:ss[.ssssss] ex. 1997-01-31T12:04:32.123

YYYY-MM-DD ex. 1997-01-31 a time of 00:00:00 is assumed

Where:

YYYY    :: four-digit year
MM      :: two-digit month (01=January, etc.)
DD      :: two-digit day of month (01 through 31)
T       :: date-time separator
hh      :: two digits of hour (00 through 23) (AM/PM NOT allowed)
mm      :: two digits of minute (00 through 59)
ss      :: two digits of second (00 through 59)
ssssss  :: one to six digits representing decimal fractions of a second, down to microseconds


Feature Notes

  • back-end software: SeisComP3
  • updatedafter request parameter not implemented: The last modification time in SeisComP is tracked on the object level. If a child of an object is updated the update time is not propagated to all parents. In order to check if a station was updated all children must be evaluated recursively. This operation would be much to expensive.
  • additional request parameters:
    • format: string [fdsnxml, stationxml, sc3ml], default: fdsnxml
    • formatted: boolean, default: false



If you have questions, updates or corrections regarding this information please contact .

© 2013