fullName

string

The full name associated with the data in the data store (DSS pathname, if the DataContainer is associated with a DSS file)

location

string

The location associated with the data (DSS pathname B-part if the DataContainer is associated with a DSS file).

subVersion

string

The sub-version associated with the data.

version

string

The version associated with the data (DSS pathname F-part if the DataContainer is associated with a DSS file).

watershed

string

The watershed associated with the data (DSS pathname A-part if the DataContainer is associated with a DSS file).

endTime

Integer¹

The end time of the time window. If the data were retrieved, the end time may be later than the last time in the times list.

interval

Integer

The interval, in minutes, between each set of consecutive times in the times list. For irregular-interval times, the interval is 0.

numberValues

Integer

The length of values and times lists.

parameter

string

The parameter associated with the data.

quality

list of integers²

The optional list of quality flags. If this list is present, there must be a quality for each value in the values array. If this list is not present, the quality field is set to None.

startTime

integer²

The start time of the time window. If the data were retrieved, the start time may be earlier than the first time in the times list.

subLocation

string

The sub-location associated with the data.

subParameter

string

The sub-parameter associated with the data.

times

list of integers¹

The list of times. There must be a time for each value in the values list, and times must increase from one index to the next.

timeZoneID

string

The time-zone for times in the times list. If unknown, the timeZoneID field is set to None

timeZoneRawOffset

integer

The offset, in milliseconds, from UTC to the time zone for the times in the times list.

type

string

The type of the data (e.g. "INST-VAL", "INST-CUM", ""PER-AVER", "PER-CUM").

units

string

The units of the data.

values

list of floating-point

The data values, each of which has a corresponding time in the times list and optionally a corresponding quality in the quality list. All lists must be the same length.

1

Set when the datum has been tested (screened).

2

Set when the datum passed all tests.

3

Set when the datum is missing (either originally missing or set to missing by a test).

4

Set when at least one test classified the datum as questionable.

5

Set when at least one test classified the datum as rejected.

6-7

Set by the RANGE test. Interpreted as a 2-bit unsigned integer with values having the following meanings:

0

value of datum < than 1^st limit or no range test applied

1

1^st limit <= value of datum < 2^nd limit

2

2^nd limit <= value of datum < 3^rd limit

3

3^rd limit <= value of datum

8

Set when the datum has been changed from the original value.

9-11

Datum replacement indicator. Interpreted as a 3-bit unsigned integer with values having the following meanings:

0

datum was not replaced (original value)

1

datum was replaced by an automated tool

2

datum was replaced by an interactive tool (e.g., fill operaton)

3

datum was replaced by manual edit in an interactive tool

4

original value was accepted or restored in an interactive tool

5-7

reserved for future use

12-15

Datum replacement value computation method. Interpreted as a 4-bit unsigned integer with values having the following meanings:

0

datum was not replaced (original value)

1

datum value computed by linear interpolation

2

datum value was entered manually

3

datum value was replaced with a missing value

4

datuma value was entered graphically

5-15

reserved for future use

16

set when datum failed an absolute magnitude test

17

set when datum failed a constant value test

Bit(s)

Description

18

set when datum failed a rate of change test

19

set when datum failed a relative magnitude test

20

set when datum failed a duration magnitude test

21

set when datum failed a negative incremental value test

22

reserved for future use

23

set when datum is excluded from testing (e.g. DATCHK GAGEFILE entry)

24

reserved for future use

25

set when datum failed a user-defined test

26

set when datum failed a distribution test

27-31

reserved for future use

32

set when datum is protected from being replaced

date

string

The date associated with the paired-data.

datum

floating-point

The zero-stage elevation of a stream gauge.

labels

list of strings

The list of labels used to identify each of the y-ordinates lists. If there is only 1 y-ordinates list (e.g. numberCurves == 1), the labels field is set to None.

labelsUsed

Boolean

A flag specifying whether labels are used. This field is set to True if there is more than 1 y-ordinates list and False otherwise.

numberCurves

integer

The number of y-ordinates lists.

numberOrdinates

integer

The length of the x-ordinates list and each of the y-ordinates lists.

offset

floating-point

The offset value of a stream rating.

shift

floating-point

The shift value for a stream rating.

transformType

integer

Type of transformation to use (1 = "LINLIN", 2 = "LOGLOG")

xOrdinates

list of floating-point

The x-ordinate values. Each y-ordinate values list must be of the same length as this field.

xparameter

string

The parameter of the x-ordinates.

xtype

string

The type of the x-ordinates ("UNT" for unitary or "LOG" for logarithmic).

xunits

string

The units of the x-ordinates.

yOrdinates

list of lists of floating-point

The y-ordinate values. Each list of y-ordinate values must be of the same length as the list of x-ordinate values. The nth value of each y-ordinates list is associated with the nth value of the x-ordinates list.

yparameter

string

The parameter of the y-ordinates.

ytype

string

The type of the y-ordinates ("UNT" for unitary or "LOG" for logarithmic).

yunits

string

The units of the y-ordinates.