api-object-access

Signal Strength

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.

JSON Table

Parameter Data Type Description Mandatory Default/Sample Value
receiver application/json The receiver device radio details. For complete details about the radio JSON, click AP Radio and Client Radio.
transmitter application/json The transmitter device radio details. For complete details about the radio JSON, click AP Radio and Client Radio.
signalStrength double An RF signal strength value received and transmitted by two devices. 0.0
variance double Variance in RF signal strength value. 0.0

Copy Sample JSON
Sample JSON 
[{
	"type": "ap",
	"boxId": 2,
	"name": "Mojo_90:64:10 ",
	"radios": [{
		"type": "apradio",
		"macaddress": "00:11:74:90:64:10",
		"protocol": "BG",
		"channel": 1,
		"firstDetectedTime": 1387185947000,
		"upSince": 1389793015000,
		"signalStrength": -59,
		"quarantineStatus": "QUARANTINE_STATUS_OFF",
		"captureFlag": 0,
		"captureId": 0,
		"ssid": "mesh-access",
		"prevReason": 0,
		"prevPendingReason": 0,
		"opprotocol": "BG",
		"meshFlag": 0,
		"dot11NCapability": 5065,
		"dot11ACCapability": 0,
		"dualBand": false,
		"numAssocClients": 0,
		"underDosAttack": false,
		"quarantiningSensorMac": null,
		"security": 8,
		"secAuth": 1,
		"secGCS": 8,
		"secPWCS": 8,
		"networkTag": " --",
		"networkedStatus": "NOT_NETWORKED",
		"wiredMAC": null,
		"misconfigured": false,
		"capability": 1,
		"securitySettingFailure": 0,
		"mcsSet11ac": 0,
		"supportedRates": -2144683266,
		"beaconInterval": 100,
		"channelOffset": 0,
		"mcsSet11n": "ffff0000000000000000000080000000",
		"extendedAttr": 1,
		"channelWidth": 0,
		"centerFrequencyOne": 0,
		"centerFrequencyZero": 0,
		"potentialClassification": "EXTERNAL",
		"maxDataRateFor11n": -999,
		"primary": false,
		"guest": false,
		"autopreventionEnabled": true,
		"manualPreventionEnabled": false,
		"active": true
	}],
	"locationId": {
    	"type" : "locallocationid",
        "id" : 1
    },
	"deviceNote": null,
	"ipAddress": null,
   "activeStatus": null,
   "deviceCapability": null,
	"manuallyTagged": false,
	"group": "EXTERNAL",
	"placed": false,
   "wiredPortBlocked": false,
   "ownSensorBoxId": 3517,
   "apTemplateId": 0,
   "apTemplateName": null,
	"vendorName": "Mojo",
	"signalSource": false,
	"manuallyClassified": false,
   "searchIndex": -100,
   "sortColumnIndex": -100,
	"updateFlags": -100,
	"primaryRadio": {
		"type": "apradio",
		"macaddress": "00:11:74:90:64:10",
		"protocol": "BG",
		"channel": 1,
		"firstDetectedTime": 1387185947000,
		"upSince": 1389793015000,
		"signalStrength": -59,
		"quarantineStatus": "QUARANTINE_STATUS_OFF",
		"captureFlag": 0,
		"captureId": 0,
		"ssid": "mesh-access",
		"prevReason": 0,
		"prevPendingReason": 0,
		"opprotocol": "BG",
		"meshFlag": 0,
		"dot11NCapability": 5065,
		"dot11ACCapability": 0,
		"dualBand": false,
		"numAssocClients": 0,
		"underDosAttack": false,
		"quarantiningSensorMac": null,
		"security": 8,
		"secAuth": 1,
		"secGCS": 8,
		"secPWCS": 8,
		"networkTag": " --",
		"networkedStatus": "NOT_NETWORKED",
		"wiredMAC": null,
		"misconfigured": false,
		"capability": 1,
		"securitySettingFailure": 0,
		"mcsSet11ac": 0,
		"supportedRates": -2144683266,
		"beaconInterval": 100,
		"channelOffset": 0,
		"mcsSet11n": "ffff0000000000000000000080000000",
		"extendedAttr": 1,
		"channelWidth": 0,
		"centerFrequencyOne": 0,
		"centerFrequencyZero": 0,
		"potentialClassification": "EXTERNAL",
		"maxDataRateFor11n": -999,
		"primary": false,
		"guest": false,
		"autopreventionEnabled": true,
		"manualPreventionEnabled": false,
		"active": true
	},
	"banned": false,
	"guest": false,
	"misconfigured": false,
   "ssids": ["Corp","Guest","ATN_Mesh"],
	"mergedAP": false,
	"active": true,
	"bestSignalStrength": -59
},
{
	"type": "ap",
	"boxId": 12,
	"name": "Ruckus_A6:7A:E8",
	"radios": [{
		"type": "apradio",
		"macaddress": "00:24:82:A6:7A:E8",
		"protocol": "BG",
		"channel": 10,
		"firstDetectedTime": 1387185947000,
		"upSince": 1389780250000,
		"signalStrength": -5000,
		"quarantineStatus": "QUARANTINE_STATUS_OFF",
		"captureFlag": 0,
		"captureId": 0,
		"ssid": "Mesh-100903000290-13",
		"prevReason": 0,
		"prevPendingReason": 0,
		"opprotocol": "BG",
		"meshFlag": 0,
		"dot11NCapability": 0,
		"dot11ACCapability": 0,
		"dualBand": false,
		"numAssocClients": 0,
		"underDosAttack": false,
		"quarantiningSensorMac": null,
		"security": 8,
		"secAuth": 1,
		"secGCS": 8,
		"secPWCS": 8,
		"networkTag": " --",
		"networkedStatus": "NOT_NETWORKED",
		"wiredMAC": null,
		"misconfigured": true,
		"capability": 0,
		"securitySettingFailure": 2048,
		"mcsSet11ac": 0,
		"supportedRates": -2144683266,
		"beaconInterval": 1000,
		"channelOffset": 0,
		"mcsSet11n": null,
		"extendedAttr": 1,
		"channelWidth": 0,
		"centerFrequencyOne": 0,
		"centerFrequencyZero": 0,
		"potentialClassification": "EXTERNAL",
		"maxDataRateFor11n": -999,
		"primary": false,
		"guest": false,
		"autopreventionEnabled": true,
		"manualPreventionEnabled": false,
		"active": false
	}],
	"locationId": {
    	"type" : "locallocationid",
        "id" : 1
   },
	"deviceNote": null,
	"ipAddress": null,
	"activeStatus": null,
   "deviceCapability": null,
   "manuallyTagged": false,
	"group": "AUTHORIZED",
	"placed": false,
	"wiredPortBlocked": false,
   "ownSensorBoxId": 3517,
	"apTemplateId": 0,
	"apTemplateName": null,
	"vendorName": "Ruckus",
	"signalSource": false,
	"manuallyClassified": true,
   "searchIndex": -100,
   "sortColumnIndex": -100,
	"updateFlags": -100,
	"primaryRadio": {
		"type": "apradio",
		"macaddress": "00:24:82:A6:7A:E8",
		"protocol": "BG",
		"channel": 10,
		"firstDetectedTime": 1387185947000,
		"upSince": 1389780250000,
		"signalStrength": -5000,
		"quarantineStatus": "QUARANTINE_STATUS_OFF",
		"captureFlag": 0,
		"captureId": 0,
		"ssid": "Mesh-100903000290-13",
		"prevReason": 0,
		"prevPendingReason": 0,
		"opprotocol": "BG",
		"meshFlag": 0,
		"dot11NCapability": 0,
		"dot11ACCapability": 0,
		"dualBand": false,
		"numAssocClients": 0,
		"underDosAttack": false,
		"quarantiningSensorMac": null,
		"security": 8,
		"secAuth": 1,
		"secGCS": 8,
		"secPWCS": 8,
		"networkTag": " --",
		"networkedStatus": "NOT_NETWORKED",
		"wiredMAC": null,
		"misconfigured": true,
		"capability": 0,
		"securitySettingFailure": 2048,
		"mcsSet11ac": 0,
		"supportedRates": -2144683266,
		"beaconInterval": 1000,
		"channelOffset": 0,
		"mcsSet11n": null,
		"extendedAttr": 1,
		"channelWidth": 0,
		"centerFrequencyOne": 0,
		"centerFrequencyZero": 0,
		"potentialClassification": "EXTERNAL",
		"maxDataRateFor11n": -999,
		"primary": false,
		"guest": false,
		"autopreventionEnabled": true,
		"manualPreventionEnabled": false,
		"active": false
	},
	"banned": false,
	"guest": false,
	"misconfigured": true,
	"ssids": ["Corp","Guest","ATN_Mesh"],
   "mergedAP": false,
	"active": false,
	"bestSignalStrength": -5000
}]
API Calls
Get

V5/signalstrength/{devicetype}/{mac}

Get

V5/signalstrength/monitors

Put

V5/signalstrength

Put

V5/signalstrength/monitors

Delete

V5/signalstrength

Delete

V5/signalstrength/monitors

Get Signal Strength

Description This API is used to get the signal strength of an AP or client radio that is acting as a transmitter.
Users with the following roles can call this API: superuser, administrator, operator, and viewer.
Syntax
GET <Base_URL>/signalstrength/{devicetype}/mac

Here,

  • devicetype- specifies the type of device. The applicable values are DEVICE_AP, DEVICE_CLIENT, and DEVICE_AIRTIGHT.
  • mac- is the MAC address of the device radio. For example, 28:47:AA:5B:54:08.
  • protocol- the value for the protocol parameter specifies protocol of the device radio.
Sample code
GET https://192.168.55.179/new/webservice/v2/signalstrength/DEVICE_AP/28:47:AA:5B:54:08/?protocol=A
Request Body This API call does not require any request body parameters.
Response Body If the API call is successful, the HTTP response status is 200.
The response body contains a list of signal strength data, wherein, each entry in the list has information about signal strength and variance with which the reporter device is seeing the transmitter device.
The response is in the application/json format.

Get Signal Strength Monitors

Description This API is used to get the list of device radios acting as signal strength monitors
Users with the following roles can call this API: superuser, administrator, operator, and viewer.
Syntax
GET <Base_URL>/signalstrength/monitors
Sample code
GET https://192.168.55.179/new/webservice/v2/new/webservice/signalstrength/monitors
Request Body This API call does not require any request body parameters.
Response Body If the API call is successful, the HTTP response status is 200.
The response body contains a list of device radios. The response is in the application/json format.

Add Signal Strength

Description This API is used to add the signal strength list for the reporting device, such as APs and Clients. The reporting entity-id must be registered before calling this API.
Users with the following roles can call this API: superuser, administrator, and operator.
Syntax
GET <Base_URL>/signalstrength

Here,

  • reporter- is the ID of the reporter device.
Sample code
PUT https://192.168.55.179/new/webservice/v2/new/webservice/signalstrength?reporter=
Request Body This API call requires the signal strength list for the reporting device,
which is passed as parameters in the request body. The parameters are in the application/json format.
The following table describes the JSON table:

Parameter Data Type Description Mandatory Default/Sample Value
receiver application/json The receiver device radio details. For complete details about the radio JSON, click AP Radio and Client Radio.
transmitter application/json The transmitter device radio details. For complete details about the radio JSON, click AP Radio and Client Radio.
signalStrength double The RF signal strength received and transmitted by two devices. 0.0
variance double Variance in RF signal strength value. 0.0
Response Body If the API call is successful, the HTTP response status is 204.
The response body does not contain any information.

Add Signal Strength Monitors

Description This API is used to add an AP or client radio as a signal strength monitor.
Users with the following roles can call this API: superuser, administrator, and operator.
Syntax
PUT <Base_URL>/signalstrength/monitors
Sample code
PUT https://192.168.55.179/new/webservice/v5/new/webservice/signalstrength/monitors
Request Body This API call requires the details of the device radio to be configured as a signal strength monitor,
which is passed as parameters in the request body. The parameters are passed in the application/json format.
Response Body If the API call is successful, the HTTP response status is 204. The response body does not contain any information.

Delete Signal Strength

Description This API is used to delete the signal strength details of a reporting device. The reporting entity-id must be registered before calling this API.
Users with the following roles can call this API: superuser, administrator, and operator.
Syntax
DELETE <Base_URL>/signalstrength

Here,

  • reporter- is the ID of the reporter device.
Sample code
DELETE https://192.168.55.179/new/webservice/v5/new/webservice/signalstrength?reporter=AlphaReporter
Request Body This API call requires the signal strength list for the reporting device,
which is passed as parameters in the request body. The parameters are passed in the application/json format.
Response Body If the API call is successful, the HTTP response status is 204.
The response body does not contain any information.

Delete Signal Strength Monitors

Description This API is used to delete an AP or client radio configured as a signal strength monitor.
Users with the following roles can call this API: superuser, administrator, and operator.
Syntax
DELETE <Base_URL>/signalstrength/monitors
Sample code
DELETE https://192.168.55.179/new/webservice/v5/new/webservice/signalstrength/monitors
Request Body This API call requires the details of the device radio configured as a signal strength monitor,
which is passed as parameters in the request body. The parameters are passed in the application/json format.
Response Body If the API call is successful, the HTTP response status is 204. The response body does not contain any information.