getNodes.cgi   - Surveyor Machine Information 

[ Manual ] [ Discussion ] [ Interface ] [ Results ] [ TOC ] [Example]

Manual

Usage

Parameters

 
COI Optional Constrain node records to specified COI; if omitted or set to '*', return all node records
OUTPUT Optional Output type for the response; legitimate value are: TXT (default), HTML

Discussion

getNodes.cgi retrieves descriptive information about each surveyor machine that is useful for either displaying or interpreting measurement statistics.

Interface

The interface for getNodes.cgi is the standard HTTP GET request. There are two main parts to the GET request:
CGI URL <SSS root>/getNodes.cgi
Arguments [&COI={#|*}]
[OUTPUT={TXT|HTML}]

Results

Upon making a HTTP GET request the application receives the following  line of ASCII output:
 
IPPM  # The string "IPPM" is the start-of-data marker 
nodeID_1|nodeTLC_1|nodeName_1|nodeDesc_1|nodeLat_1|nodeLong_1|nodeTZ_1 # Column-separated values
nodeID_2|nodeTLC_2|nodeName_2|nodeDesc_2|nodeLat_2|nodeLong_2|nodeTZ_2
... # Repeat for n machines
nodeID_n|nodeTLC_n|nodeName_n|nodeDesc_n|nodeLat_n|nodeLong_n|nodeTZ_n # "nth" machine
-1 # The string "-1" is the end-of-data marker 
Each line is terminated by a newline character ('\n').
 

nodeID is a positive integer, used in  getStatistics.
nodeTLC is a unique three-letter code (e.g. ADV) representing the machine, useful for compact presentation.
nodeName is a unique word that represents the machine, for example "Advanced".
nodeDesc is a long description of the measurement machine, for example "Advanced Network & Services".
nodeLat and nodeLong are the latitude and longitude of the measurement machine's location.
Latitude is in degrees, and is of the form +78.113. + means North, - means South.
Longitude is in degrees, and is of the form -48.112. + means East, - means West.
nodeTZ is the timezone, in BSD Unix format (e.g. EST5EDT).

Examples

http://sss.advanced.org/perl/getNodes.cgi
http://sss.advanced.org/perl/getNodes.cgi?COI=2&OUTPUT=HTML


Direct questions or comment to Ben Teitelbaum.