Hostspot Access Points

The Hotspot Access Points API provides endpoints for retrievingmanaging and managingretrieving WiFi hotspotnetwork access point information.locations within your organization. This API isallows designedyou forto networkquery administratorsaccess point data with location coordinates, filter by activity status, and applicationsretrieve thatdetailed needinformation toabout monitor,each locate,hotspot location including address details and trackgeographical changes to wireless access points across their infrastructure.coordinates.

Base URL: https://gate.zequenze.com/api/v1

Authentication: All endpoints require a Bearer token:

Authorization: Bearer <your-api-token>

---

Overview

The Hotspot Access Points API is designed for managing wireless network infrastructure locations within your organization. This API enables younetwork administrators and developers to retrieveprogrammatically comprehensiveaccess information about WiFiWi-Fi hotspots, access pointspoints, inand yourtheir networkphysical infrastructure.locations.

This

Key API is particularly useful for:Features:

• Retrieve comprehensive access point location data

Filter by geographical coordinates availability Query by last modification timestamps Paginated results for large datasets Support for location-based services integration

Common Integration Scenarios:

Network monitoring applicationsdashboards that needdisplay access point locations on maps Mobile applications that help technicians locate specific hotspots for maintenance Analytics platforms tracking network coverage across different regions Inventory management systems maintaining records of deployed network equipment Geofencing applications that trigger actions based on proximity to track the status and location of access points Asset management systems that maintain inventories of network hardware Location-based services that require precise positioning data from access points with GPS coordinates Change tracking systems that monitor network infrastructure modifications over time

The API supportsfollows filteringREST byconventions locationwith coordinatesstandardized andresponse change timestamps,formats, making it easy to buildintegrate applicationswith that can mapexisting network coveragemanagement areastools orand detectcustom recent network changes. The paginated response format ensures efficient data retrieval even for large networks with hundreds or thousands of access points.applications.

Key concepts to understand:

Coordinates filtering: Access points may or may not have GPS coordinates set - use the have_coordinates parameter to filter based on location data availability Change tracking: The last_change__gte parameter allows you to retrieve only access points modified since a specific date/time Pagination: Results are paginated using limit/offset parameters for efficient data handling

---

Endpoints

GET /hostspot_access_points/

Description: Retrieves a paginated list of all hotspot access points within optionalyour filtering capabilities.organization. This endpoint allowsprovides youcomprehensive toinformation fetchabout each access point information based onincluding location availability,details, recentstatus, changes,and geographical coordinates. It's the primary endpoint for accessing your network infrastructure data and supports paginationvarious forfiltering handlingoptions largeto datasetshelp efficiently.you find specific access points or those meeting certain criteria.

Use Cases:

• Display all active access points on a network monitoring dashboard

Generate reports of network coverage mapsacross bydifferent filteringgeographical regions Identify access points that haveneed GPScoordinate coordinatesupdates for mapping applications MonitorAudit network infrastructure changes by retrieving access points modified sincewithin a specific timestamptime period Build network inventory dashboards with paginatedExport access point listingsdata Createfor automatedintegration reportswith ofthird-party wirelessnetwork infrastructuremanagement statustools

Full URL Example:

https://gate.zequenze.com/api/v1/hostspot_access_points/?have_coordinates=true&limit=5025&offset=0&last_change__gte=2024-01-01T00:00:00Z

Parameters:

Parameter	Type	In	Required	Description
last_change__gte	string	query	No	Filter results to only include access points bymodified laston modificationor dateafter (the specified date/time. Accepts ISO format:format dates: 2000-01-01,01, 2000-01-01 00:01:00,00, or 2000-01-01 00:01:00+00:00)00
limit	integer	query	No	Number of results to return per pagepage. (defaultUse variesfor pagination control. Default and maximum limits are set by the server configuration)
offset	integer	query	No	The initialstarting index fromfor whichresults. toUse returnwith results (usedlimit for pagination)pagination (e.g., offset=25&limit=25 for page 2)
have_coordinates	boolean	query	No	When true,set to true, only returns only access points withthat GPShave both latitude and longitude coordinates set; when false, returns only those without coordinatesconfigured

cURL Example:

curl -X GET "https://gate.zequenze.com/api/v1/hostspot_access_points/?have_coordinates=true&limit=25&offset=0"10" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

Example Response:

{
  "count": 156,
  "next": "https://gate.zequenze.com/api/v1/hostspot_access_points/?have_coordinates=true&limit=2510&offset=25"10",
  "previous": null,
  "results": [
    {
      "id": 1,1001,
      "name": "AP-Floor1-East"Main Building - Ground Floor AP",
      "mac_address"short_name": "00:1A:2B:3C:4D:5E"main-building-ground-ap",
      "ip_address"is_active": "192.168.1.101",
      "ssid": "CompanyWiFi",
      "status": "online",
      "location": {
        "latitude": 40.7128,
        "longitude": -74.0060,
        "floor": 1,
        "building": "Main Office",true,
      "description": "EastPrimary Wingaccess Conferencepoint Room"covering }lobby and reception area",
      "signal_strength": -42,
      "channel": 6,
      "frequency"organization_id": "2.4GHz"org_abc123def456",
      "connected_devices"thumbnail": 23,"https://gate.zequenze.com/media/thumbnails/ap_1001_thumb.jpg",
      "max_capacity"address": 50,"123 Business Park Drive",
      "reference": "Building A - Suite 100",
      "city": "San Francisco",
      "postal_code": "94105",
      "state": "California",
      "region": "West Coast",
      "country_code": "US",
      "latitude": "37.7749",
      "longitude": "-122.4194",
      "created": "2024-01-15T08:30:00Z",
      "last_change": "2024-01-15T14:30:00Z",
      "created_at": "2023-12-01T09:00:00Z",
      "firmware_version": "1.2.3",
      "model": "WifiPro-300"03-10T14:22:15Z"
    },
    {
      "id": 2,1002,
      "name": "AP-Floor2-West"Conference Room WiFi Hub",
      "mac_address"short_name": "00:1A:2B:3C:4D:5F"conference-room-hub",
      "ip_address"is_active": "192.168.1.102",
      "ssid": "CompanyWiFi",
      "status": "online",
      "location": {
        "latitude": 40.7129,
        "longitude": -74.0061,
        "floor": 2,
        "building": "Main Office",true,
      "description": "WestHigh-capacity Wingaccess Marketingpoint Department"for }conference and meeting rooms",
      "signal_strength": -38,
      "channel": 11,
      "frequency"organization_id": "5GHz"org_abc123def456",
      "connected_devices"thumbnail": 15,"https://gate.zequenze.com/media/thumbnails/ap_1002_thumb.jpg",
      "max_capacity"address": 50,"123 Business Park Drive",
      "reference": "Building A - 2nd Floor Conference Wing",
      "city": "San Francisco",
      "postal_code": "94105",
      "state": "California",
      "region": "West Coast",
      "country_code": "US",
      "latitude": "37.7751",
      "longitude": "-122.4192",
      "created": "2024-01-20T10:15:30Z",
      "last_change": "2024-01-14T16:02-28T09:45:00Z",
      "created_at": "2023-12-01T09:15:00Z",
      "firmware_version": "1.2.3",
      "model": "WifiPro-300"22Z"
    }
  ]
}

Response Codes:

Status	Description
200	Success - Returns paginated list of access points
401	Unauthorized - Invalid or missing Bearer token
400403	BadForbidden Request- Token valid but lacks permission for this resource

422 Unprocessable Entity - Invalid query parametersparameter format (e.g., malformed date format)date) 500 Internal Server Error - Server-side processingerror erroroccurred

---

Common Use Cases

Use Case 1: Network Coverage Mapping

Retrieve all access points with GPS coordinates to create visualdisplay network coverage maps.on an interactive map. Use have_coordinates=true to ensure you only get mappable locations, then plot each access pointspoint thatusing canthe belatitude plottedand onlongitude a map.fields.

https://gate.zequenze.com/api/v1/hostspot_access_points/?have_coordinates=true&limit=100

Use Case 2: ChangeInfrastructure DetectionAudit and MonitoringMaintenance

Monitor recent network changes by fetchingQuery access points modified sincewithin youra lastspecific check.timeframe using last_change__gte to identify recently updated configurations. This ishelps usefultrack formaintenance automatedactivities monitoringand systemsensure that need to detect configurationnetwork changes orare newproperly installations.documented.

https://gate.zequenze.com/api/v1/hostspot_access_points/?last_change__gte=2024-01-15T00:00:00Z

Use Case 3: PaginatedMobile NetworkTechnician InventoryApp

Build comprehensivea networkmobile inventory systemsapplication that canhelps handlefield largetechnicians numberslocate ofspecific access points efficientlyfor usingmaintenance pagination.or Starttroubleshooting. withUse athe reasonableaddress, limitreference, and iteratecoordinate throughdata results.to provide turn-by-turn navigation to equipment locations.

https://gate.zequenze.com/api/v1/hostspot_access_points/?limit=50&offset=0

Use Case 4: Location-SpecificNetwork AssetInventory Management

IdentifyExport complete access point data for integration with asset management systems. Use pagination with appropriate limit/offset values to process large datasets efficiently without overwhelming system resources.

Use Case 5: Regional Performance Analytics

Filter access points thatby lackgeographical GPS coordinates for maintenance or audit purposes byregions using have_coordinates=false.the city, state, and region fields to generate location-based network performance reports and identify areas needing infrastructure improvements.

https://gate.zequenze.com/api/v1/hostspot_access_points/?have_coordinates=false

---

Best Practices

• UsePagination appropriate paginationStrategy: SetAlways use reasonable limit values (25-10-100) to balanceavoid performancetimeout issues with large datasets. Implement proper pagination logic using the next and reduceprevious APIURLs calls.provided Veryin large limits may cause timeouts.responses.

• ImplementCoordinate change tracking: Use the last_change__gte parameter with stored timestamps to efficiently detect and sync only modified access points rather than fetching all data repeatedly.

Handle coordinates filtering carefullyFiltering: When building location-basedmapping features,applications, always use have_coordinates=true to avoid processingattempting to plot access points without positionlocation data.data, which would cause map rendering errors.

CacheDate resultsFiltering: appropriatelyUse ISO 8601 format dates for last_change__gte parameter. Include timezone information when precision is important: 2024-03-01T00:00:00+00:00.

Caching Considerations: Access point data typically doesn'tchanges changeinfrequently, frequently,making soit implementsuitable cachingfor withcaching. reasonableConsider TTLimplementing valuescache (5-15invalidation minutes)based toon reducethe APIlast_change load.timestamp.

Error handling for date formatsHandling: WhenAlways handle pagination edge cases (empty results, last page) and validate coordinate data before using last_change__gte, ensure dates areit in ISOmapping format.applications. TheSome APIaccess acceptspoints multiplemay formatshave butpartial ISOaddress 8601 (YYYY-MM-DDTHH:MM:SSZ) is recommended.information.

Monitor rate limitsSecurity: ImplementNever exponentialexpose backoffBearer and respect any rate limiting headers returned by the API to avoid service interruptions.

Process pagination completely: Always check the next fieldtokens in responsesclient-side andcode. continueUse fetchingserver-side untilproxies allor pagessecure aretoken retrievedrefresh mechanisms for completeweb dataapplications sets.accessing this API.