...
Parameter | Value | Description | Example | ||
---|---|---|---|---|---|
Required | |||||
There are no required parameters. | |||||
Optional | |||||
None showHidden | boolean | Indicates if device category codes from devices that are currently not neptunesearchable (or searchable in the case of VENUS) should be returned. Defaults to false. |
|
| showHidden=true |
Response
Success
Code Block | ||
---|---|---|
| ||
[ { "deviceCategories": [], "els": [ { "description": "<div>Way up North</div>", // description property removed when description value is null "deviceCategories": [], "els": [ { "description": "<div>Instrumentation located at the end of a dock.</div>", "deviceCategories": [ "CTD", "ICEPROFILER", "METSTN" ], "els": [], "id": 88, "name": "Dock", "siteDeviceIds": [ 119202, 119199, 119200 ], "stationCode": "CBDCK", "type": 10 } ], "id": 84, "name": "Cambridge Bay", "siteDeviceIds": [], "stationCode": "CB", "type": 10 } ], "id": 82, "name": "Arctic Observatory by Location", "siteDeviceIds": [], "stationCode": "KRSTA", "type": 10 } ] |
Property | Type | Description | Example | ||
---|---|---|---|---|---|
description | string | A description of the station | Cambridge Bay, Victoria Island, NU | ||
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="01fcb9881980143d-6bb636ac-4e924c68-b4d5a4c9-f2656fc84003b60f97c157a1"><ac:plain-text-body><![CDATA[ | deviceCategories | array | An array of decive category code strings | ["CTD","ICEPROFILER","METSTN"] | ]]></ac:plain-text-body></ac:structured-macro> |
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="64438774bf5078d5-21eb331a-45ba4b62-8550af3c-ec6f9710dd770273364b4198"><ac:plain-text-body><![CDATA[ | els | array | Array of child nodes | [JSONObject] | ]]></ac:plain-text-body></ac:structured-macro> |
id | integer | The resource ID of the node. | 123456 | ||
name | string | The name of the station. | "Cambridge Bay" | ||
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="54636b6600a63efc-11295875-4b934621-bef398b7-5be876d9ead0e57475c39403"><ac:plain-text-body><![CDATA[ | siteDeviceIds | array | An array of integers | [119202,119199,119200] | ]]></ac:plain-text-body></ac:structured-macro> |
stationCode | string | The unique code for the station | "CB" | ||
type | integer | The resource type of the node. All nodes in this structure are of type 10. | 10 |
...
http://dmas.uvic.ca/api/stations?method=getTree&token=SAMPLETOKEN123456789Show all stations, including devices flagged 'not searchable':
http://dmas.uvic.ca/api/stations?method=getTreegetList&showHidden=true&token=SAMPLETOKEN123456789
...