Getting Started
This guide provides instructions on how to send a valid request, add authentication, and how to use this API. Examples are shown using the command line with cURL.
Base URI
Every API request will begin with the following Base URI.
US base-uri
https://dnaspaces.io
EU base-uri
https://dnaspaces.eu
Singapore base-uri
https://ciscospaces.sg
1. Authorization
In addition to the path URL, an Authorization header must be added to every API request with the following format. Please use the corresponding Base URI US(https://dnaspaces.io), EU(https://dnaspaces.eu) and Singapore(https://ciscospaces.sg).
curl --location --request GET '{base-uri}/api/location/v2/devices' \
--header 'Authorization: Bearer {BEARER_TOKEN}' \
Read more about authenticating, including generating an API token here.
2. Using API
Following sample request and response shows an example on drafting a request to fetch details of active devices. Please use the corresponding Base URI US(https://dnaspaces.io), EU(https://dnaspaces.eu) and Singapore(https://ciscospaces.sg).
Sample Request
curl --location --request GET '{base-uri}/api/location/v2/devices' \
--header 'Authorization: Bearer {BEARER_TOKEN}' \
Sample Response
{
"success": true,
"querystring": {},
"morePage": false,
"results": [
{
"tenantId": "200",
"macAddress": "00:12:b8:0a:c6:20",
"deviceType": "TAG",
"campusId": "5cb06b3ba1d943669963417c4330c6c7",
"buildingId": "98c86b09665a4ffab9647709d966f3a6",
"floorId": "3b3aad61352e4bc09cdea0119ee3d9f3",
"lhfloorId": "3b3aad61352e4bc09cdea0119ee3d9f3",
"hierarchy": "San Jose->SJC-17->1st Floor",
"locationHierarchy": "root-node->San Jose->SJC-17->1st Floor",
"hierarchyIds": [
"0c872fbb-0545-45fd-b7e2-6ce6ff6f08af",
"2d3da06b-f4f2-4b3e-9e56-492665ae78ac"
],
"source": "NOTIFICATION",
"isMacHashed": false,
"deviceId": "00:24:b1:02:e7:10",
"coordinates": [
33.401928,
101.87378
],
"geoCoordinates": [
49.26188380661546,
-123.24809010788138
],
"confidenceFactor": 120,
"computeType": "RSSI",
"firstLocatedAt": "2018-05-25T17:30:12.403Z",
"lastLocatedAt": "2018-05-27T21:14:44.005Z",
"changedOn": "1527456440322",
"associated": false,
"manufacturer": "Aeroscout Ltd.",
"maxDetectedRssi": {
"apMacAddress": "f0:7f:06:35:8d:00",
"band": "IEEE_802_11_B",
"slot": 2,
"rssi": -81,
"antennaIndex": 0,
"lastHeard": 1
},
"numDetectingAps": 3,
"apList": [
{
"apMacAddress": "3c:08:f6:fb:29:50",
"bands": [
"IEEE_802_11_A"
]
}
]
}
]
}
Following sample request and response shows an example on drafting a request to fetch details of a specific floor for US region.
Sample Request
curl --location --request GET 'https://dnaspaces.io/api/location/v2/map/floor/28946415-f998-4183-948c-c49fd2268b3a' \
--header 'Authorization: Bearer {BEARER_TOKEN}'
Sample Response
{
"locationHierarchy": [
{
"id": "a8b98eac-8aef-42dd-a24d-3ea6839efa3c",
"name": "dnshirsa_acc1",
"type": "root",
"mongoLocationId": 36583,
"networkId": ""
},
{
"id": "b975b84b-1cad-43a4-9da2-80946ebf1d61",
"name": "System Campus",
"type": "campus",
"mongoLocationId": 36777,
"networkId": "d8777989-0cdd-4fdf-b891-968faed1edf5"
},
{
"id": "7bcd2f92-abab-4fee-853d-d16c71cddf52",
"name": "ewlc173building 20",
"type": "network",
"mongoLocationId": 37986,
"networkId": "4e00f099-6fe2-4699-b19d-1c229e225910"
},
{
"id": "28946415-f998-4183-948c-c49fd2268b3a",
"name": "floor2",
"type": "floor",
"mongoLocationId": 37987,
"networkId": "51b37035-ada7-4dca-af4b-e400d1f40def"
}
],
"accessPoints": [
{
"name": "AP5C71.0DEC.F1F4",
"macAddress": "3c:41:0e:3a:bf:a0",
"isPlannedAp": false,
"make": "CISCO_TRADITIONAL",
"mapPosition": "113.44000244140625,104.95999908447266,10.0",
"importType": "PRIME",
"id": "36ed7d54-bed8-4d7a-b308-b35018942f00",
"numOfSlots": 3,
"displayName": "AP5C71.0DEC.F1F4",
"apType": 2,
"angle": 1.57,
"model": "AP9105I",
"x": "113.44000244140625",
"y": "104.95999908447266",
"z": 10,
"importedId": 43060080,
"level": "AP",
"apPid": "C9105AXI-B",
"interfaces": [
{
"ifSlotId": 1,
"band": "IEEE_802_11_A",
"antennaElevAngle": 0,
"antennaAngle": 1.5707964,
"channelNumber": 153,
"channelAssignment": 1,
"txPowerControl": 1,
"txPowerLevel": 7,
"antennaType": 1,
"antennaMode": 0,
"antennaDiversity": 3,
"antennaPattern": "Internal-C9105AXI-x-5GHz",
"antennaGain": 10,
"dualBandSlot": false,
"unit": "RADIAN",
"addedbyDnaspaces": 0
},
{
"ifSlotId": 7,
"band": "IEEE_802_11_B",
"antennaElevAngle": 0,
"antennaAngle": 1.5707964,
"channelNumber": 1,
"channelAssignment": 1,
"txPowerControl": 1,
"txPowerLevel": 0,
"antennaType": 1,
"antennaMode": 1,
"antennaDiversity": 1,
"antennaPattern": "Internal-C9105AXI-x-BT-2.4GHz",
"antennaGain": 0,
"dualBandSlot": false,
"unit": "RADIAN",
"addedbyDnaspaces": 1
},
{
"ifSlotId": 0,
"band": "IEEE_802_11_B",
"antennaElevAngle": 0,
"antennaAngle": 1.5707964,
"channelNumber": 11,
"channelAssignment": 1,
"txPowerControl": 1,
"txPowerLevel": 6,
"antennaType": 1,
"antennaMode": 0,
"antennaDiversity": 3,
"antennaPattern": "Internal-C9105AXI-x-2.4GHz",
"antennaGain": 6,
"dualBandSlot": false,
"unit": "RADIAN",
"addedbyDnaspaces": 0
}
]
},
{
"name": "AP0CD0.F894.31A4",
"macAddress": "0c:d0:f8:95:f3:80",
"isPlannedAp": false,
"make": "CISCO_TRADITIONAL",
"mapPosition": "160.47999572753906,105.27999877929688,10.0",
"importType": "PRIME",
"id": "33f8d873-3f86-4480-a852-5846c797f714",
"numOfSlots": 3,
"displayName": "AP0CD0.F894.31A4",
"apType": 2,
"angle": 1.57,
"model": "AP9117I",
"x": "160.47999572753906",
"y": "105.27999877929688",
"z": 10,
"importedId": 43060078,
"level": "AP",
"apPid": "C9117AXI-B",
"interfaces": [
{
"ifSlotId": 1,
"band": "IEEE_802_11_A",
"antennaElevAngle": 0,
"antennaAngle": 1.5707964,
"channelNumber": 52,
"channelAssignment": 1,
"txPowerControl": 1,
"txPowerLevel": 5,
"antennaType": 1,
"antennaMode": 0,
"antennaDiversity": 3,
"antennaPattern": "Internal-9117-5GHz",
"antennaGain": 12,
"dualBandSlot": false,
"unit": "RADIAN",
"addedbyDnaspaces": 0
},
{
"ifSlotId": 7,
"band": "IEEE_802_11_B",
"antennaElevAngle": 0,
"antennaAngle": 1.5707964,
"channelNumber": 1,
"channelAssignment": 1,
"txPowerControl": 1,
"txPowerLevel": 0,
"antennaType": 1,
"antennaMode": 1,
"antennaDiversity": 1,
"antennaPattern": "Internal-9117-BT-2.4GHz",
"antennaGain": 0,
"dualBandSlot": false,
"unit": "RADIAN",
"addedbyDnaspaces": 1
},
{
"ifSlotId": 0,
"band": "IEEE_802_11_B",
"antennaElevAngle": 0,
"antennaAngle": 1.5707964,
"channelNumber": 11,
"channelAssignment": 1,
"txPowerControl": 1,
"txPowerLevel": 6,
"antennaType": 1,
"antennaMode": 0,
"antennaDiversity": 3,
"antennaPattern": "Internal-9117-Dual-2.4GHz",
"antennaGain": 8,
"dualBandSlot": false,
"unit": "RADIAN",
"addedbyDnaspaces": 0
}
]
},
{
"name": "APCC9C.3EE7.7B50",
"macAddress": "ec:f4:0c:0e:9e:e0",
"isPlannedAp": false,
"make": "CISCO_TRADITIONAL",
"mapPosition": "132.0,116.586669921875,10.0",
"importType": "PRIME",
"id": "6801fa97-5ee1-45a6-ad63-de514e7fa03b",
"numOfSlots": 7,
"displayName": "APCC9C.3EE7.7B50",
"apType": 2,
"angle": 1.57,
"model": "AP9162I",
"x": 132,
"y": "116.586669921875",
"z": 10,
"importedId": 43060082,
"level": "AP",
"apPid": "CW9162I-B",
"interfaces": [
{
"ifSlotId": 7,
"band": "IEEE_802_11_B",
"antennaElevAngle": 0,
"antennaAngle": 1.5707964,
"channelNumber": 1,
"channelAssignment": 1,
"txPowerControl": 1,
"txPowerLevel": 0,
"antennaType": 1,
"antennaMode": 1,
"antennaDiversity": 1,
"antennaPattern": "Internal-CW9162I-x-BT-2.4GHz",
"antennaGain": 0,
"dualBandSlot": false,
"unit": "RADIAN",
"addedbyDnaspaces": 1
},
{
"ifSlotId": 6,
"band": "IEEE_802_11_AX6E",
"antennaElevAngle": 0,
"antennaAngle": 0.034906585,
"channelNumber": 0,
"channelAssignment": 1,
"txPowerControl": 1,
"txPowerLevel": 0,
"antennaType": 1,
"antennaMode": 2,
"antennaDiversity": 2,
"antennaPattern": "Internal-CW9162I-x-Aux-6GHz",
"antennaGain": 8,
"dualBandSlot": true,
"unit": "RADIAN",
"addedbyDnaspaces": 1
},
{
"ifSlotId": 6,
"band": "IEEE_802_11_B",
"antennaElevAngle": 0,
"antennaAngle": 0.034906585,
"channelNumber": 0,
"channelAssignment": 1,
"txPowerControl": 1,
"txPowerLevel": 0,
"antennaType": 1,
"antennaMode": 3,
"antennaDiversity": 2,
"antennaPattern": "Internal-CW9162I-x-Aux-2.4GHz",
"antennaGain": 8,
"dualBandSlot": true,
"unit": "RADIAN",
"addedbyDnaspaces": 1
},
{
"ifSlotId": 2,
"band": "IEEE_802_11_AX6E",
"antennaElevAngle": 0,
"antennaAngle": 1.5707964,
"channelNumber": 5,
"channelAssignment": 1,
"txPowerControl": 1,
"txPowerLevel": 1,
"antennaType": 1,
"antennaMode": 0,
"antennaDiversity": 3,
"antennaPattern": "Internal-CW9162I-x-6GHz",
"antennaGain": 12,
"dualBandSlot": false,
"unit": "RADIAN",
"addedbyDnaspaces": 0
},
{
"ifSlotId": 0,
"band": "IEEE_802_11_B",
"antennaElevAngle": 0,
"antennaAngle": 1.5707964,
"channelNumber": 1,
"channelAssignment": 1,
"txPowerControl": 1,
"txPowerLevel": 7,
"antennaType": 1,
"antennaMode": 0,
"antennaDiversity": 3,
"antennaPattern": "Internal-CW9162I-x-2.4GHz",
"antennaGain": 8,
"dualBandSlot": false,
"unit": "RADIAN",
"addedbyDnaspaces": 0
},
{
"ifSlotId": 6,
"band": "IEEE_802_11_A",
"antennaElevAngle": 0,
"antennaAngle": 0.034906585,
"channelNumber": 0,
"channelAssignment": 1,
"txPowerControl": 1,
"txPowerLevel": 0,
"antennaType": 1,
"antennaMode": 3,
"antennaDiversity": 2,
"antennaPattern": "Internal-CW9162I-x-Aux-5GHz",
"antennaGain": 8,
"dualBandSlot": true,
"unit": "RADIAN",
"addedbyDnaspaces": 1
},
{
"ifSlotId": 1,
"band": "IEEE_802_11_A",
"antennaElevAngle": 0,
"antennaAngle": 1.5707964,
"channelNumber": 108,
"channelAssignment": 1,
"txPowerControl": 1,
"txPowerLevel": 7,
"antennaType": 1,
"antennaMode": 0,
"antennaDiversity": 3,
"antennaPattern": "Internal-CW9162I-x-5GHz",
"antennaGain": 12,
"dualBandSlot": false,
"unit": "RADIAN",
"addedbyDnaspaces": 0
}
]
}
],
"calibModels": [
{
"modelName": "Cubes And Walled Offices",
"dot11aParam1": -3.6,
"dot11aParam2": -47,
"dot11bParam1": -3.6,
"dot11bParam2": -40,
"dot11aParam3": 7,
"dot11bParam3": 7,
"dot11aParam1WithWalls": -3.6,
"dot11aParam2WithWalls": -47,
"dot11aParam3WithWalls": 7,
"dot11bParam1WithWalls": -3.6,
"dot11bParam2WithWalls": -40,
"dot11bParam3WithWalls": 7,
"covDot11aParam1": -3.6,
"covDot11aParam2": -47,
"covDot11aParam3": 7,
"covDot11bParam1": -3.6,
"covDot11bParam2": -40,
"covDot11bParam3": 7,
"useWalls": false,
"sweepClientPower": false,
"heatMapCutoff": -112,
"binSize": 8,
"calibrationType": "NOT_SITE_SURVEY",
"importedId": 1,
"id": "6b115e1c-9247-4134-ab46-e41b56e6879d"
}
],
"regions": [
{
"type": "OUTSIDE",
"points": [
{
"order": 0,
"x": 0,
"y": 0,
"z": 0
},
{
"order": 1,
"x": 252,
"y": 0,
"z": 0
},
{
"order": 2,
"x": 252,
"y": 200,
"z": 0
},
{
"order": 3,
"x": 0,
"y": 200,
"z": 0
}
]
}
],
"maps": [
{
"name": "c1653edf8688037363008794c41d7a6f",
"source": "PRIME",
"zoomLevel": 3,
"maxDimension": 1420,
"maxResolution": 8,
"imagePath": "mapservices/floor/3a6e2b22591ed55131de9ee07ffdfd443d86554bfc60c2d23e6620d4e2c794df/c1653edf8688037363008794c41d7a6f",
"mimeType": "image/png",
"mongoId": "dnshirsa_acc1_System Campus_ewlc173building 20_floor2",
"imageWidth": 1420,
"imageHeight": 1124,
"length": 200,
"width": 252,
"height": 10,
"offsetX": 0,
"offsetY": 0,
"unit": "FEET"
}
],
"details": {
"importedId": "-6046944924882960181",
"length": 200,
"width": 252,
"height": 10,
"calibrationModelId": "505505",
"floorNumber": 1
},
"locId": "28946415-f998-4183-948c-c49fd2268b3a",
"zones": [],
"hierarchyMapSources": [
"PRIME"
]
}