Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Controlled Vocabulary APiExample JSON upload file

Code Block
languagejson
{
  "location": {
    "name": "NMWDI-$autoinc",
    "description": "No Description Available",
    "properties": {
      "altitude": 5495.8701171875,
      "altitude_accuracy": 0.5199999809265137,
      "altitude_datum": "NAVD88",
      "altitude_method": "LiDAR DEM"
    },
    "geometry": {
      "type": "Point",
      "coordinates": [
        -108.06889231646282,
        36.79656589018368
      ]
    }
  },
  "sensor": {
    "name": "Steel-tape measurement",
    "description": "No Description Available"
  },
  "datastream": {
    "name": "Depth Below Surface",
    "description": "manual measurements",
    "unitofMeasurement": "foot",
    "observationType": "double"
  },
  "observed_property": {
    "name": "Depth below ground surface",
    "description": "manual measurement depth to groundwater"
  },
  "thing": {
    "name": "AR-0001",
    "description": "Water Well",
    "properties": {
      "data_reliability": "Data field checked by reporting agency",
      "project": null,
      "organization": "NMBGMR",
      "organization_id": "AR-0001",
      "organization_key": "PointID"
    }
  },
  "observations": [
    "2015-08-18T00:00:00.000Z, 6.62",
    "2016-01-18T00:00:00.000Z, 6.36",
    "2016-03-15T00:00:00.000Z, 5.97",
    "2016-06-01T00:00:00.000Z, 4.82",
    "2016-10-18T00:00:00.000Z, 6.51",
    "2016-11-21T00:00:00.000Z, 5.96",
    "2017-01-24T00:00:00.000Z, 5.69",
    "2017-03-15T00:00:00.000Z, 5.56",
    "2017-06-01T00:00:00.000Z, 4.58",
    "2018-03-28T00:00:00.000Z, 6.31",
    "2018-10-11T00:00:00.000Z, 6.6",
    "2019-04-09T00:00:00.000Z, 5.19"
  ],
  "destination": "https://st.newmexicowaterdata.org/FROST-Server/v1.1"
}

This information is not up to date. Upload to ST via this mechanism is only used internally.

Below are the two valid upload formats and example files. The supported file formats are YAML and CSV. The required columns are listed in Table 1. CSV Columns

Controlled Vocabulary API

http://cv-dot-waterdatainitiative-271000.appspot.com.newmexicowaterdata.org/cv

Table 1. CSV Columns

Column Name

Type

Description

location

string

name of the location

lat

float

latitude in decimal degrees

lon

float

longitude in decimal degrees

location_description

string

optional

thing

string

thing_description

string

optional

sensor

string

sensor_description

string

optional

datastream

string

datastream_description

string

optional

datastream_units

CV_string

observed_property

string

observed_property_description

string

optional

phenomenonTime

ISO 8601

result

float/string/boolean/int

waterdata.csv example

Code Block
languagetext
location, lat, lon, location_description, thing, thing_description,sensor, sensor_description, phenomenonTime, result, datastream, datastream_description, datastream_units, observed_property, observed_property_description
foo, 34.23, -105.75, well, water level, water level description, transducer, diver sensor, 2010-01-01T01:00:00.000Z, 10, dbs, depth below surface,foot, bgs, calculated water depth below ground surface
foo, 34.23, -105.75, well, water level, water level description, transducer, diver sensor, 2010-01-01T11:00:00.000Z, 11, dbs, depth below surface,foot, bgs, calculated water depth below ground surface
foo, 34.23, -105.75, well, water level, water level description, transducer, diver sensor, 2010-01-01T12:00:00.000Z, 12, dbs, depth below surface,foot, bgs, calculated water depth below ground surface
foo, 34.23, -105.75, well, water level, water level description, transducer, diver sensor, 2010-01-01T01:00:00.000Z, 10, dbs, depth below surface,foot, bgs, calculated water depth below ground surface
bar, 34.35, -105.12, well, water level, water level description, transducer, diver sensor, 2010-01-01T11:00:00.000Z, 11, dbs, depth below surface,foot, bgs, calculated water depth below ground surface
bar, 34.35, -105.12, well, water level, water level description, transducer, diver sensor, 2010-01-01T12:00:00.000Z, 12, dbs, depth below surface,foot, bgs, calculated water depth below ground surface

waterdata.yml specification

Code Block
languageyaml
location:
  geometry: Geojson_geometry
  name: float
  description: str
sensor:
  name: str
  description: str
  metadata: str
thing:
  name: str
  description: str
  properties: YAML object
observed_property: 
  name: str
  description: str
  definition: str
datastream:
  name: str
  unitOfMeasurement: CV_str
  description: str
  observationType: CV_str
observations:
  - isotimestamp, float|bool|str

Example

...

waterdata.yml file

Code Block
languageyaml
location:
  name: NM-0000
  geometry:
    type: Point
    corrdinates: 
     - -106.76
     - 34.52
  description: WELL
sensor:
  name: DO-131d-31324
  description: Diver pressure transducer
  metadata: http://diver.com/link_to_transducer.pdf
thing:
  name: GroundWaterLevel
  description: NMBGR Groundwater Monitoring Network
observed_property:
  name: Depth below ground surface
  description: continuous pressure transducer measurement of groundwater head
datastream:
  name: Depth Below Surface
  description: calculated depth below ground surface. calibrated to manual measurements
  unitOfMeasurement: foot
  observationType: double
observations:
  - 2020-01-10T00:00:00.000Z,  10.0
  - 2020-01-10T01:00:00.000Z,  11.0
  - 2020-01-10T02:00:00.000Z,  10.4

...