Versions Compared

Key

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

...

The locations discovery web service returns all the locations defined in DMAS Oceans 2.0 which meet the filter criteria.

...

Parameter
Type
Description
Example
Required   
tokenstringAll Web Services require a token. This can be . Once logged in at http://data.oceannetworks.ca/login, your token can be retrieved or generated at http://dmasdata.uvicoceannetworks.ca/Profile. Click on the "Web Services" tab and , then click "Generate Token".token=5ba514e8-1203-428c-8835-879c8173e387
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
locationNamestring

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

  • Not case sensitive
  • Contains
locationName=mill
deviceCategoryCodestring

Return all Locations that have devices belonging to a specific Device Category

  • Device Category Code must be valid and match exactly, including case
  • Specific Device Category Codes can be obtained using the deviceCateogries service
deviceCategoryCode=CTD
deviceCode string

Return all of the Locations where a specific Device 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
propertyCodestring

Return all Locations that have devices with a sensor for a specific Property

  • 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

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

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

  • Requires deploymentEnd

Date Time format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'

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

deploymentEnddatetime

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

  • Requires deploymentBegin

Date Time format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'

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

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

...