devices Discovery Service

Description

The API devices returns all devices defined in Oceans 2.0 which meet a filter criteria.

Devices are instruments with one or more sensors that observe a property. Devices are uniquely identified by a device code and can be deployed at multiple locations during their lifespan.

The primary purpose of this service is to find devices that have the data you want to access; the service provides the deviceCode that can be used to request a data product via the dataProductDelivery web service.

For a list of available device codes, along with names, ids and device links, see the Available Devices page.

See the External Web Services for method and token usage and error messages.

URL

http://data.oceannetworks.ca/api/devices

Method	Description	Example
get	Retrieve a list of all devices	`method=get`

get

The get method retrieves a list of devices with deviceId, deviceCode, and deviceName

Parameters

Parameter	Type	Description	Example
Required
token	string	All Web Services require a token. Once logged in at http://data.oceannetworks.ca/login, your token can be retrieved or generated at http://data.oceannetworks.ca/Profile . Click on the "Web Services" tab, then click "Generate Token".	token=5ba514e8-1203-428c-8835-879c8173e387
Optional
deviceCode	string	Return a single Device matching a specific Device Code Device Code must be valid and match exactly, including case Run the service without this parameter to get a list of all devices	deviceCode=FSINXIC1622
deviceName	string	Return all of the Devices where the Device Name contains a keyword Not case sensitive Contains	deviceName=meter
locationCode	string	Return all Devices that are deployed at a specific Location Location Code must be valid and match exactly, including case Specific Location Codes can be obtained using the locations service	locationCode=BACAX
deviceCategoryCode	string	Return all 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
propertyCode	string	Return all Devices that have 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=pressure
dataProductCode	string	Return all Devices that have the ability to return 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=jpgfile
deploymentBegin	datetime	Return all of the Devices that have a Deployment Beginning on or after a specific date/time When the depolymentBegin filter is included, the deploymentEnd filter must also be included Date Time format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z' DateTime is represented in Coordinated Universal Time (UTC)	deploymentBegin=2010-07-27T00:00:00.000Z
deploymentEnd	datetime	Return all of the Devices that have a Deployment Ending on or before a specific date/time When the deploymentEnd filter is included, the deploymentBegin filter must also be included Date Time format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z' DateTime is represented in Coordinated Universal Time (UTC)	deploymentEnd=2016-08-01T00:00:00.000Z

Response

Example for request: http://data.oceannetworks.ca/api/devices?method=get&token=[YOUR_TOKEN_HERE]&deviceCategoryCode=ADCP2MHZ

Success (HTTP 200)

Returns a list of devices with values for Device Code, Device Id, Device Name and Device Link URL, ordered by Device Code

[{"deviceCode":"BC_POD1_AD2M","deviceId":11302,"deviceLink":"http://qaweb2.neptune.uvic.ca/DeviceListing?DeviceId=11302","deviceName":"Nortek Aquadopp HR-Profiler 2965",

"dataRating" : [{"samplePeriod":1.0,"dateFrom","2008-11-01 00:00:00"},{"samplePeriod":10.0,"dateFrom","2010-05-27 19:27:04"}],