Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Change "Durations" to "Duration". Add a space between ISO and 8601.

...

Parameter

Type

Description

Example

Required


tokenstringAll Web Services require a token. This can be generated at https://data.oceannetworks.ca/Profile. Click on the "Web Services" tab and click "Generate Token".token=YOUR_TOKEN_HERE
Optional


locationCodestring

Return a single Location matching a specific Location Code.

  • Location Code must be valid and match exactly, including case.
  • Specific Location Codes can be found by simply running the service without this parameter to get a list of all locations.
locationCode=BACAX
deviceCategoryCodestring

Return all Locations that have devices with a specific Device Category Code.

  • Device Category Code must be valid and match exactly, including case.
  • Specific Device Category Codes can be obtained using the deviceCategories service.
deviceCategoryCode=CTD
propertyCodestring

Return all Locations that have devices with a sensor with a specific Property Code.

  • Property Code must be valid and match exactly, including case.
  • Specific Property Codes can be obtained using the properties service.
propertyCode=differentialtemperature
dataProductCodestring

Return all of the Locations that support a specific Data Product Code.

  • Data Product Code must be valid and match exactly, including case.
  • Specific Data Product Codes can be obtained from the dataProducts service.
dataProductCode=CPID
dateFromdatetime

Return all of the Locations that have a Deployment Beginning on or after a specific date/time.

Accepted DateTime formats:

If not specified, the default value is the beginning of time.

  • DateTime is represented in Coordinated Universal Time (UTC).

  • ISO8601 ISO 8601 Extended format without a time will be assumed to mean midnight (T00:00:000.000Z).
  • Queries with both dateFrom and dateTo in the ISO8601 Durations ISO 8601 Duration format will not be accepted.

dateFrom=2010-07-27T00:00:00.000Z

dateFrom=2010-07-27

dateFrom=-P1DT1H

  • Previous 1 day and 1 hour, relative to the dateTo. Note the '-' before the P.
dateTodatetime

Return all of the Locations that have a Deployment Ending before a specific date/time.

Accepted DateTime formats:

If not specified, the default value is the end of time.

  • DateTime is represented in Coordinated Universal Time (UTC).

  • ISO8601 ISO 8601 Extended format without a time will be assumed to mean midnight (T00:00:000.000Z).
  • Queries with both dateFrom and dateTo in the ISO8601 Durations ISO 8601 Duration format will not be accepted.

dateTo=2016-08-01T00:00:00.000Z

dateTo=2016-08-01

dateTo=PT12H30M

  • Next 12 hours and 30 minutes, relative to the dateFrom.
locationNamestring

Return all of the Locations where the Location Name contains a keyword.

  • Not case sensitive.
locationName=mill
deviceCode string

Return all of the Locations where a specific device with that Device Code has been deployed.

  • Location Code must be valid and match exactly, including case.
  • Specific Device Codes can be obtained from the devices service.
 deviceCode=AandOpt0581
includeChildrenbool

Include all of the children of a Location in the results.

  • Requires a valid locationCode.
  • Valid values are either true or false.
includeChildren=true

...