...
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
| deviceCode=FSINXIC1622 |
deviceName | string | Return all of the Devices where the Device Name contains a keyword
| deviceName=meter |
locationCode | string | Return all Devices that are deployed at a specific Location
| locationCode=BACAX |
deviceCategoryCode | string | Return all Devices belonging to a specific Device Category
| deviceCategoryCode=CTD |
propertyCode | string | Return all Devices that have a sensor for a specific Property
| propertyCode=pressure |
dataProductCode | string | Return all Devices that have the ability to return a specific Data Product
| dataProductCode=jpgfile |
deploymentBegin | datetime | Return all of the Devices that have a Deployment Beginning on or after a specific date/time
Date Time format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
| 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
Date Time format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'
| deploymentEnd=2016-08-01T00:00:00.000Z |
...
API Proxy
The http://data.oceannetworks.ca/apiproxy/devices url used deviceCategories URL link in the above examples can be used in a browser for sharing or testing purposes; however, it can not be used accessed from code, as it redirects . Calls to the apiproxy server are redirected to a login screen to capture your user id. In . Accessing the apiproxy URL from code will return html in the payload, which may cause errors or unexpected behaviour. In order to use the devices deviceCategories endpoint from code, you must use the http://data.oceannetworks.ca/api/devicesdeviceCateogies url along with a valid token. Attempting to use the apiproxy url from code will result html returned in the payload which may cause errors or unexpected behavior.
Code Examples
Content Report Table | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|