api-object-access

Payment Gateway

The payment gateway is used to bill users when you select Paid or Free + Paid WiFi. Mojo currently supports only the Stripe payment gateway. Payment gateway account settings are configured on Mojo Aware.

JSON Table

Attribute Data Type Description Default/Sample value
type string Category or type of the device whose details are being modified. The applicable value is ap ap
boxId long Syatem-generated ID of the AP. 2
name String Name of the device. Mojo_90:64:10
radios application/json A JSON object with attributes related to the access point radio

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

/V1.14/portals/{portal_id}/guestbook/config

Put

/V1.14/portals/{portal_id}/guestbook/config

Post

<Base_URL>/V2/analytics/associationdata/{startdate}/{enddate}

Delete

<Base_URL>/V2/analytics/associationdata/{startdate}/{enddate}

Get Payment Gateway Configuration for Portal

Description This API is used to fetch the APs that match the specified filter criteria from the allowed locations for the logged-in user. If no filters are specified, all the APs from the allowed locations are fetched. However, this API is not supported in a server cluster environment.

Note: Do not use this API to fetch more than 100 devices. For fetching larger number of devices, consider using the Get Paged List of APs API.
User Privileges Users with the following roles can call this API: superuser, administrator, and operator.

Request Body Parameters
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 the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.

Error codes
If the API call is successful, the HTTP response status is 200.
Syntax
GET /devices/aps
Sample code
GET https://training.mojonetworks.com/new/webservice/v2/devices/aps
GET
https://training.mojonetworks.com/new/webservice/v2/devices/aps?macaddress=00:11:74:33:23:12&macaddress=00:11:74:45:12:21
GET
https://training.mojonetworks.com/new/webservice/v2/devices/aps?capability=49&locationid=10&locationid=12&sortcolumn=devicename&sortascending=false
URL Parameters This API call takes optional URL parameters to filter the list of APs to be fetched and the column on which the output must be sorted. AP Filter Parameters lists the parmeter names, datatypes, applicable values, and whether the results can be sorted based on the parameter.
Query Parameters This API call takes optional URL parameters to filter the list of APs to be fetched and the column on which the output must be sorted. AP Filter Parameters lists the parmeter names, datatypes, applicable values, and whether the results can be sorted based on the parameter.
Response Body If the API call is successful, the HTTP response status is 200. The response body contains the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.

Put APIs

Description This API is used to fetch the APs that match the specified filter criteria from the allowed locations for the logged-in user. If no filters are specified, all the APs from the allowed locations are fetched. However, this API is not supported in a server cluster environment.

Note: Do not use this API to fetch more than 100 devices. For fetching larger number of devices, consider using the Get Paged List of APs API.
User Privileges Users with the following roles can call this API: superuser, administrator, and operator.

Request Body Parameters
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 the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.

Error codes
If the API call is successful, the HTTP response status is 200.
Syntax
GET /devices/aps
Sample code
GET https://training.mojonetworks.com/new/webservice/v2/devices/aps
GET
https://training.mojonetworks.com/new/webservice/v2/devices/aps?macaddress=00:11:74:33:23:12&macaddress=00:11:74:45:12:21
GET
https://training.mojonetworks.com/new/webservice/v2/devices/aps?capability=49&locationid=10&locationid=12&sortcolumn=devicename&sortascending=false
URL Parameters This API call takes optional URL parameters to filter the list of APs to be fetched and the column on which the output must be sorted. AP Filter Parameters lists the parmeter names, datatypes, applicable values, and whether the results can be sorted based on the parameter.
Query Parameters This API call takes optional URL parameters to filter the list of APs to be fetched and the column on which the output must be sorted. AP Filter Parameters lists the parmeter names, datatypes, applicable values, and whether the results can be sorted based on the parameter.
Response Body If the API call is successful, the HTTP response status is 200. The response body contains the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.

Put APIs

Description This API is used to fetch the APs that match the specified filter criteria from the allowed locations for the logged-in user. If no filters are specified, all the APs from the allowed locations are fetched. However, this API is not supported in a server cluster environment.

Note: Do not use this API to fetch more than 100 devices. For fetching larger number of devices, consider using the Get Paged List of APs API.
User Privileges Users with the following roles can call this API: superuser, administrator, and operator.

Request Body Parameters
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 the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.

Error codes
If the API call is successful, the HTTP response status is 200.
Syntax
GET /devices/aps
Sample code
GET https://training.mojonetworks.com/new/webservice/v2/devices/aps
GET
https://training.mojonetworks.com/new/webservice/v2/devices/aps?macaddress=00:11:74:33:23:12&macaddress=00:11:74:45:12:21
GET
https://training.mojonetworks.com/new/webservice/v2/devices/aps?capability=49&locationid=10&locationid=12&sortcolumn=devicename&sortascending=false
URL Parameters This API call takes optional URL parameters to filter the list of APs to be fetched and the column on which the output must be sorted. AP Filter Parameters lists the parmeter names, datatypes, applicable values, and whether the results can be sorted based on the parameter.
Query Parameters This API call takes optional URL parameters to filter the list of APs to be fetched and the column on which the output must be sorted. AP Filter Parameters lists the parmeter names, datatypes, applicable values, and whether the results can be sorted based on the parameter.
Response Body If the API call is successful, the HTTP response status is 200. The response body contains the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.

Post APIs

Description This API is used to fetch the APs that match the specified filter criteria from the allowed locations for the logged-in user. If no filters are specified, all the APs from the allowed locations are fetched. However, this API is not supported in a server cluster environment.

Note: Do not use this API to fetch more than 100 devices. For fetching larger number of devices, consider using the Get Paged List of APs API.
User Privileges Users with the following roles can call this API: superuser, administrator, and operator.

Request Body Parameters
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 the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.

Error codes
If the API call is successful, the HTTP response status is 200.
Syntax
GET /devices/aps
Sample code
GET https://training.mojonetworks.com/new/webservice/v2/devices/aps
GET
https://training.mojonetworks.com/new/webservice/v2/devices/aps?macaddress=00:11:74:33:23:12&macaddress=00:11:74:45:12:21
GET
https://training.mojonetworks.com/new/webservice/v2/devices/aps?capability=49&locationid=10&locationid=12&sortcolumn=devicename&sortascending=false
URL Parameters This API call takes optional URL parameters to filter the list of APs to be fetched and the column on which the output must be sorted. AP Filter Parameters lists the parmeter names, datatypes, applicable values, and whether the results can be sorted based on the parameter.
Query Parameters This API call takes optional URL parameters to filter the list of APs to be fetched and the column on which the output must be sorted. AP Filter Parameters lists the parmeter names, datatypes, applicable values, and whether the results can be sorted based on the parameter.
Response Body If the API call is successful, the HTTP response status is 200. The response body contains the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.

Delete APIs

Description This API is used to fetch the APs that match the specified filter criteria from the allowed locations for the logged-in user. If no filters are specified, all the APs from the allowed locations are fetched. However, this API is not supported in a server cluster environment.

Note: Do not use this API to fetch more than 100 devices. For fetching larger number of devices, consider using the Get Paged List of APs API.
User Privileges Users with the following roles can call this API: superuser, administrator, and operator.

Request Body Parameters
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 the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.

Error codes
If the API call is successful, the HTTP response status is 200.
Syntax
GET /devices/aps
Sample code
GET https://training.mojonetworks.com/new/webservice/v2/devices/aps
GET
https://training.mojonetworks.com/new/webservice/v2/devices/aps?macaddress=00:11:74:33:23:12&macaddress=00:11:74:45:12:21
GET
https://training.mojonetworks.com/new/webservice/v2/devices/aps?capability=49&locationid=10&locationid=12&sortcolumn=devicename&sortascending=false
URL Parameters This API call takes optional URL parameters to filter the list of APs to be fetched and the column on which the output must be sorted. AP Filter Parameters lists the parmeter names, datatypes, applicable values, and whether the results can be sorted based on the parameter.
Query Parameters This API call takes optional URL parameters to filter the list of APs to be fetched and the column on which the output must be sorted. AP Filter Parameters lists the parmeter names, datatypes, applicable values, and whether the results can be sorted based on the parameter.
Response Body If the API call is successful, the HTTP response status is 200. The response body contains the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.

Test APIs

Description This API is used to fetch the APs that match the specified filter criteria from the allowed locations for the logged-in user. If no filters are specified, all the APs from the allowed locations are fetched. However, this API is not supported in a server cluster environment.

Note: Do not use this API to fetch more than 100 devices. For fetching larger number of devices, consider using the Get Paged List of APs API.
User Privileges Users with the following roles can call this API: superuser, administrator, and operator.

Request Body Parameters
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 the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.

Error codes
If the API call is successful, the HTTP response status is 200.
Syntax
GET /devices/aps
Sample code
GET https://training.mojonetworks.com/new/webservice/v2/devices/aps
GET
https://training.mojonetworks.com/new/webservice/v2/devices/aps?macaddress=00:11:74:33:23:12&macaddress=00:11:74:45:12:21
GET
https://training.mojonetworks.com/new/webservice/v2/devices/aps?capability=49&locationid=10&locationid=12&sortcolumn=devicename&sortascending=false
URL Parameters This API call takes optional URL parameters to filter the list of APs to be fetched and the column on which the output must be sorted. AP Filter Parameters lists the parmeter names, datatypes, applicable values, and whether the results can be sorted based on the parameter.
Query Parameters This API call takes optional URL parameters to filter the list of APs to be fetched and the column on which the output must be sorted. AP Filter Parameters lists the parmeter names, datatypes, applicable values, and whether the results can be sorted based on the parameter.
Response Body If the API call is successful, the HTTP response status is 200. The response body contains the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.