Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: remove link to "External Web Services", deprecate getByStation

Description

escription

See the scalardata service for method, token, and responseType usage and error messages.

API scalardata allows users to get scalar data.

...

MethodDescriptionExample
getByStation*Returns scalar data by given station code and device categorymethod=getByStation
getByLocationReturns scalar data by given location code and device categorymethod=getByLocation

* getByStation is still available but is deprecated as of October 1, 2017. It has been replaced by the getByLocation method.

Anchor
getByStation
getByStation
getByStation

...

Note: If the value is null, this may be displayed in the resulting JSON as a null.

 

Failure

See scalardata service

Example

https://data.oceannetworks.ca/api/scalardata?method=getByStation&token=ffffffff-ffff-ffff-ffff-ffffffffffff&station=SCHDW.O1&deviceCategory=OXYSENSOR

...

Note: Not all the properties above may be included in the resulting JSON, especially parameters that were not in the original call.

Failure

See scalardata service

Example

https://data.oceannetworks.ca/api/scalardata?method=getByLocation&token=ffffffffffffffff&locationCode=NC27&deviceCategoryCode=CORK&dateFrom=2015-02-25T00:00:00.000Z&dateTo=2015-02-25T00:00:01.000Z&propertyCode=totalpressure

...