SAGE Facility IRISWS virtualnetwork Web Service Documentation

Description

The irisws-virtualnetwork web service returns a list of stations that comprise the virtual network, subject to temporal constraints.

Data is returned in XML format.

Below is a full list of service parameters and their usage.

Query Usage

/codes
/query? (code=<Virtual Network Code>) [format=<xml|csv>] [temporal-constraints] [definition=<yes|no>]

where

temporal-constraints	::	[starttime=<date>] [endtime=<date>]
(..) required
[..] optional

Query parameters are joined by ampersands “&”, without blank space (see the sample queries).

Sample Queries

Detailed Descriptions of each Query Parameter

parameter examples description default type
code _GSN Required Virtual network code. Virtual network codes start with an underscore _ String
format xml Recommended Specifies result format1. XML, Comma Separated Values (CSV) xml String
definition true If true returns the virtual network definition, which can include wildcards. Otherwise, wildcards are expanded false boolean
starttime 2001-05-21 Limit results to the stations that were members of this network at any point after or on this date any date
endtime 2011-06-31 Limit results to the stations that were members of this network at any time on or before this date any date

Requesting a list of virtual network codes

To request a list of virtual network codes with descriptions, use ../codes instead of using ../query?...


WADL

Retrieve the WADL associated with this service:

application.wadl


Date and Time Formats

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

Problems with this service?

Please send an email report of which service you were using, your URL query, and any error feedback to:
data-help@earthscope.org
We will address your issue as soon as possible.

IRISWS virtualnetwork web service