...
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="2cd757fa326375c5-29200b30-437444c2-ba028e96-c9a5dda4c56707a01ee8f9ce"><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="2a66d8882f5f5b74-cf69b2d9-4a3349d2-806b85d0-bd9192ea478ed310125dc167"><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="088ea35d1538a51d-301f53e4-4fb44ea5-8f47a204-8b01e8213fbdbfdcf5160f57"><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
...