2.12. Access Point listing
It is possible to get a list of all access points that a user has permission by issuing a GET request to the following URI:
https://hostname/api/v1/access_points(.format)
Where (.format) should be replaced by the desired response format. Available formats are CSV and JSON.
It is also possible to filter access points by mac address, status, name and ip address. Said filtering can be done by submitting additional GET parameters, these parameters are:
mac_address MAC address of the access point to filter by.
status Integer representation of the access point status. 0 stands for down and 1 stands for up.
name Name of the access point.
ip_address IP address of the access point to filter by.
The response will have the following data in the corresponding format:
Servide Provider ID, Organization ID, Market ID, Deployment ID, Building ID, Floor ID, AP MAC address
On the following example we will request a listing of all the access points that are online in JSON and CSV format:
Request:
HTTP Verb: GET
URI: https://hostname/api/v1/access_points?auth_token=xxxxxx
Response:
{
"query": true,
"access_points": [
{
"name": "AP1",
"service_provider_uuid": null,
"service_provider": null,
"deployment_uuid": null,
"deployment": null,
"organization_uuid": "9201452791072897388",
"organization": "Eneo",
"market_uuid": "6396049722605916538",
"market": "Spain",
"building_uuid": "6913104531464819392",
"building": "Aljarafe Center",
"campus_uuid": "3118246207405350091",
"campus": "SVQ",
"floor_uuid": "9032532605146231448",
"mac_address": "12:15:14:16:15:aa",
"status": 0,
"last_check_in": null,
"enrichment": {}
},
{
"name": "AP2",
"service_provider_uuid": null,
"service_provider": null,
"deployment_uuid": null,
"deployment": null,
"organization_uuid": "9201452791072897388",
"organization": "Eneo",
"market_uuid": "6396049722605916538",
"market": "Spain",
"building_uuid": "6913104531464819392",
"building": "Aljarafe Center",
"campus_uuid": "3118246207405350091",
"campus": "SVQ",
"floor_uuid": "9032532605146231448",
"mac_address": "aa:aa:aa:cc:cc:cc",
"status": 0,
"last_check_in": null,
"enrichment": {}
},
{
"name": "AP3",
"service_provider_uuid": null,
"service_provider": null,
"deployment_uuid": null,
"deployment": null,
"organization_uuid": "9201452791072897388",
"organization": "Eneo",
"market_uuid": "6396049722605916538",
"market": "Spain",
"building_uuid": "6913104531464819392",
"building": "Aljarafe Center",
"campus_uuid": "3118246207405350091",
"campus": "SVQ",
"floor_uuid": "9032532605146231448",
"mac_address": "aa:bb:cc:dd:ee",
"status": 0,
"last_check_in": null,
"enrichment": {}
}
]
}
Request:
HTTP Verb: GET
URI: https://hostname/api/v1/access_points.csv?auth_token=xxxxxx
Response:
service_provider_uuid,service_provider,deployment_uuid,deployment,organization_uuid,organization,market_uuid,market,building_uuid,building,campus_uuid,campus,floor_uuid,mac_address,status,last_check_in
null,null,null,null,9201452791072897388,Eneo,6396049722605916538,Spain,6913104531464819392,Aljarafe Center,3118246207405350091,SVQ,9032532605146231448,12:15:14:16:15:aa,0,null
null,null,null,null,9201452791072897388,Eneo,6396049722605916538,Spain,6913104531464819392,Aljarafe Center,3118246207405350091,SVQ,9032532605146231448,aa:aa:aa:cc:cc:cc,0,null
null,null,null,null,9201452791072897388,Eneo,6396049722605916538,Spain,6913104531464819392,Aljarafe Center,3118246207405350091,SVQ,9032532605146231448,aa:bb:cc:dd:ee,0,null
null,null,null,null,9201452791072897388,Eneo,6396049722605916538,Spain,6913104531464819392,Aljarafe Center,3118246207405350091,SVQ,9032532605146231448,aa:bb:cc:dd:fe,0,null
null,null,null,null,null,null,null,null,null,null,null,null,8001483943659605430,ab:be:ef:12:21:33,0,null
null,null,null,null,null,null,null,null,null,null,null,null,8001483943459605430,ab:12:ef:12:21:33,0,null
null,null,null,null,null,null,null,aa:aa:aa:aa:aa:aa,0,null
null,null,null,null,null,null,null,aa:aa:aa:aa:aa:bb,0,null
null,null,null,null,null,null,null,aa:aa:aa:aa:aa:cc,0,null
null,null,null,null,null,null,3189960848665445691,Bay Area,null,null,null,null,8301483941239605130,ab:be:ef:be:ef:33,0,null
null,null,null,null,9201452791072897388,Eneo,6396049722605916538,Spain,6913104531464819392,Aljarafe Center,3118246207405350091,SVQ,9032532605146231448,aa:bb:cc:dd:ee:33,0,null
null,null,null,null,null,null,null,null,4811388934080740875,Hyatt,4269493721092289739,SantaClara Convention,788434622707693044,aa:bb:cc:dd:ab,0,null
null,null,null,null,9201452791072897388,Eneo,6396049722605916538,Spain,6913104531464819392,Aljarafe Center,3118246207405350091,SVQ,9032532605146231448,aa:bb:cc:dd:ee,0,null
null,null,null,null,9201452791072897388,Eneo,6396049722605916538,Spain,6913104531464819392,Aljarafe Center,3118246207405350091,SVQ,9032532605146231448,aa:bb:cc:dd:ee,0,null
null,null,null,null,9201452791072897388,Eneo,6396049722605916538,Spain,6913104531464819392,Aljarafe Center,3118246207405350091,SVQ,9032532605146231448,aa:bb:cc:dd:fe,0,null
null,null,null,null,null,null,3189960848665445691,Bay Area,null,null,null,null,8001483930459605430,ab:be:ef:22:11:33,0,null
null,null,null,null,null,null,3189960848665445691,Bay Area,null,null,null,null,8001483930459605430,ab:be:ef:f2:aa:33,0,null
null,null,null,null,null,null,2080930526821473860,market_3189234848665445691,1327513633662331506,NewBuilding,null,null,8301483941239605130,ab:22:ef:33:ef:13,0,null
null,null,null,null,9201452791072897388,Eneo,6396049722605916538,Spain,6913104531464819392,Aljarafe Center,3118246207405350091,SVQ,9032532605146231448,aa:aa:ce:dd:ff,0,null
null,null,null,null,9201452791072897388,Eneo,6396049722605916538,Spain,6913104531464819392,Aljarafe Center,3118246207405350091,SVQ,9032532605146231448,aa:bb:cc:dd:ff,0,null
null,null,null,null,9201452791072897388,Eneo,6396049722605916538,Spain,6913104531464819392,Aljarafe Center,3118246207405350091,SVQ,9032532605146231448,aa:bb:cc:dd:aa,0,null
null,null,null,null,9201452791072897388,Eneo,6396049722605916538,Spain,6913104531464819392,Aljarafe Center,3118246207405350091,SVQ,9032532605146231448,aa:bb:cc:dd:bb,0,null
